include/svx/xit.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
  20 #ifndef INCLUDED_SVX_XIT_HXX
  21 #define INCLUDED_SVX_XIT_HXX
  22
  23 #include <svl/stritem.hxx>
  24 #include <svx/xtable.hxx>
  25 #include <svx/svxdllapi.h>
  26
  27 /************************************************************************/
  28
  29 class SfxItemPool;
  30 class NameOrIndex;
  31
  32 typedef bool (*SvxCompareValueFunc)( const NameOrIndex* p1, const NameOrIndex* p2 );
  33
  34
  35 // class NameOrIndex
  36
  37 class SVX_DLLPUBLIC NameOrIndex : public SfxStringItem
  38 {
  39     sal_Int32    nPalIndex;
  40
  41 protected:
  42     void    Detach()    { nPalIndex = -1; }
  43
  44 public:
  45             NameOrIndex() { nPalIndex = -1; }
  46             NameOrIndex(sal_uInt16 nWhich, sal_Int32 nIndex);
  47             NameOrIndex(sal_uInt16 nWhich, const OUString& rName);
  48             NameOrIndex(const NameOrIndex& rNameOrIndex);
  49
  50     virtual bool         operator==(const SfxPoolItem& rItem) const override;
  51     virtual SfxPoolItem* Clone(SfxItemPool* pPool = nullptr) const override;
  52
  53             OUString const & GetName() const              { return GetValue();   }
  54             void         SetName(const OUString& rName) { SetValue(rName);     }
  55             bool         IsIndex() const          { return (nPalIndex >= 0); }
  56
  57     /** this static checks if the given NameOrIndex item has a unique name for its value.
  58         The returned String is a unique name for an item with this value in both given pools.
  59         Argument pPool2 can be null.
  60         If returned string equals NameOrIndex->GetName(), the name was already unique.
  61     */
  62     static OUString CheckNamedItem( const NameOrIndex* pCheckItem, const sal_uInt16 nWhich, const SfxItemPool* pPool1, SvxCompareValueFunc pCompareValueFunc, const char* pPrefixResId, const XPropertyListRef &pDefaults );
  63
  64     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  65 };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */