include/svl/cenumitm.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_SVL_CENUMITM_HXX
  21 #define INCLUDED_SVL_CENUMITM_HXX
  22
  23 #include <svl/svldllapi.h>
  24 #include <svl/poolitem.hxx>
  25
  26 class SVL_DLLPUBLIC SfxEnumItemInterface: public SfxPoolItem
  27 {
  28 protected:
  29     explicit SfxEnumItemInterface(sal_uInt16 which): SfxPoolItem(which) {}
  30
  31     SfxEnumItemInterface(const SfxEnumItemInterface & rItem):
  32         SfxPoolItem(rItem) {}
  33
  34 public:
  35
  36     virtual bool operator ==(const SfxPoolItem & rItem) const override;
  37
  38     virtual bool GetPresentation(SfxItemPresentation,
  39                                                 SfxMapUnit, SfxMapUnit,
  40                                                 OUString & rText,
  41                                                 const IntlWrapper * = nullptr)
  42         const override;
  43
  44     virtual bool QueryValue(css::uno::Any & rVal, sal_uInt8 = 0) const override;
  45
  46     virtual bool PutValue(const css::uno::Any & rVal, sal_uInt8 ) override;
  47
  48     virtual sal_uInt16 GetValueCount() const = 0;
  49
  50     virtual OUString GetValueTextByPos(sal_uInt16 nPos) const;
  51
  52     virtual sal_uInt16 GetValueByPos(sal_uInt16 nPos) const;
  53
  54     /// Return the position of some value within this enumeration.
  55     ///
  56     /// @descr  This method is implemented using GetValueCount() and
  57     /// GetValueByPos().  Derived classes may replace this with a more
  58     /// efficient implementation.
  59     ///
  60     /// @param nValue  Some value.
  61     ///
  62     /// @return  The position of nValue within this enumeration, or USHRT_MAX
  63     /// if not included.
  64     virtual sal_uInt16 GetPosByValue(sal_uInt16 nValue) const;
  65
  66     virtual bool IsEnabled(sal_uInt16 nValue) const;
  67
  68     virtual sal_uInt16 GetEnumValue() const = 0;
  69
  70     virtual void SetEnumValue(sal_uInt16 nValue) = 0;
  71
  72     virtual bool HasBoolValue() const;
  73
  74     virtual bool GetBoolValue() const;
  75
  76     virtual void SetBoolValue(bool bValue);
  77 };
  78
  79 #endif // INCLUDED_SVL_CENUMITM_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */