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 #include <svl/itemset.hxx>
  24
  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
  39 public:
  40     SfxWhichIter(const SfxItemSet& rSet)
  41         : m_rItemSet(rSet)
  42         , m_pCurrentWhichPair(rSet.m_aWhichRanges.begin())
  43         , m_nOffsetFromStartOfCurrentWhichPair(0)
  44     {
  45     }
  46
  47     sal_uInt16 GetCurWhich() const;
  48     sal_uInt16 NextWhich();
  49     sal_uInt16 FirstWhich();
  50
  51     SfxItemState GetItemState(bool bSrchInParent = true, const SfxPoolItem** ppItem = nullptr) const
  52     {
  53         const sal_uInt16 nWhich(GetCurWhich());
  54         if (0 == nWhich)
  55             return SfxItemState::UNKNOWN;
  56         return m_rItemSet.GetItemState_ForWhichID(SfxItemState::UNKNOWN, nWhich, bSrchInParent,
  57                                                   ppItem);
  58     }
  59
  60     void ClearItem()
  61     {
  62         const sal_uInt16 nWhich(GetCurWhich());
  63         if (0 == nWhich)
  64             return;
  65         const_cast<SfxItemSet&>(m_rItemSet).ClearSingleItem_ForWhichID(nWhich);
  66     }
  67 };
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */