include/svl/whiter.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 #pragma once
  20
  21 #include <svl/svldllapi.h>
  22 #include <svl/whichranges.hxx>
  23
  24 class SfxItemSet;
  25 class SfxPoolItem;
  26 enum class SfxItemState;
  27
  28 /**
  29  * Iterates over the which ids and the pool items arrays together (which are stored in parallel arrays).
  30  * Primarily so that we can call GetItemSet on the SfxItemSet and pass in a hint, which avoids
  31  * searching the array the SfxItemSet, which speeds up GetItemState greatly.
  32  */
  33 class SVL_DLLPUBLIC SfxWhichIter
  34 {
  35     const SfxItemSet& m_rItemSet;
  36     const WhichPair* m_pCurrentWhichPair;
  37     sal_uInt16 m_nOffsetFromStartOfCurrentWhichPair;
  38     /// Offset into m_ppItems array in SfxItemSet
  39     sal_uInt16 m_nItemsOffset;
  40
  41 public:
  42     SfxWhichIter(const SfxItemSet& rSet);
  43
  44     sal_uInt16 GetCurWhich() const;
  45     sal_uInt16 NextWhich();
  46     sal_uInt16 FirstWhich();
  47     SfxItemState GetItemState(bool bSrchInParent = true,
  48                               const SfxPoolItem** ppItem = nullptr) const;
  49     void ClearItem();
  50 };
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */