include/svl/itemiter.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SVL_ITEMITER_HXX
  20 #define INCLUDED_SVL_ITEMITER_HXX
  21
  22 #include <svl/svldllapi.h>
  23 #include <svl/itemset.hxx>
  24
  25 class SfxPoolItem;
  26
  27 class SVL_DLLPUBLIC SfxItemIter
  28 {
  29     const SfxItemSet& m_rSet;
  30     sal_uInt16 m_nStart;
  31     sal_uInt16 m_nEnd;
  32     sal_uInt16 m_nCurrent;
  33
  34 public:
  35     SfxItemIter(const SfxItemSet& rSet);
  36
  37     /// get item, or null if no items
  38     const SfxPoolItem* GetCurItem() const
  39     {
  40         return m_rSet.m_nCount ? *(m_rSet.m_ppItems + m_nCurrent) : nullptr;
  41     }
  42     const SfxPoolItem* NextItem() { return (m_nCurrent < m_nEnd) ? ImplNextItem() : nullptr; }
  43
  44     bool IsAtEnd() const { return m_nCurrent == m_nEnd; }
  45
  46     sal_uInt16 GetCurPos() const { return m_nCurrent; }
  47     sal_uInt16 GetFirstPos() const { return m_nStart; }
  48     sal_uInt16 GetLastPos() const { return m_nEnd; }
  49
  50     SfxItemState GetItemState(bool bSrchInParent = true,
  51                               const SfxPoolItem** ppItem = nullptr) const;
  52     void ClearItem();
  53
  54 private:
  55     const SfxPoolItem* ImplNextItem();
  56 };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */