include/svtools/svlbitm.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
  21 #ifndef INCLUDED_SVTOOLS_SVLBITM_HXX
  22 #define INCLUDED_SVTOOLS_SVLBITM_HXX
  23
  24 #include <memory>
  25 #include <svtools/svtdllapi.h>
  26 #include <tools/link.hxx>
  27 #include <vcl/image.hxx>
  28 #include <svtools/treelistbox.hxx>
  29 #include <o3tl/typed_flags_set.hxx>
  30
  31 class SvTreeListEntry;
  32
  33
  34 enum class SvBmp
  35 {
  36     UNCHECKED        = 0,
  37     CHECKED          = 1,
  38     TRISTATE         = 2,
  39     HIUNCHECKED      = 3,
  40     HICHECKED        = 4,
  41     HITRISTATE       = 5,
  42     STATICIMAGE      = 6
  43 };
  44
  45 enum class SvItemStateFlags
  46 {
  47     NONE               = 0x00,
  48     UNCHECKED          = 0x01,
  49     CHECKED            = 0x02,
  50     TRISTATE           = 0x04,
  51     HILIGHTED          = 0x08
  52 };
  53 namespace o3tl
  54 {
  55     template<> struct typed_flags<SvItemStateFlags> : is_typed_flags<SvItemStateFlags, 0x0f> {};
  56 }
  57
  58 struct SvLBoxButtonData_Impl;
  59
  60 class SVT_DLLPUBLIC SvLBoxButtonData
  61 {
  62 private:
  63     Link<SvLBoxButtonData*,void> aLink;
  64     long                    nWidth;
  65     long                    nHeight;
  66     std::unique_ptr<SvLBoxButtonData_Impl> pImpl;
  67     bool                    bDataOk;
  68     std::vector<Image>      aBmps;  // indices s. constants BMP_ ....
  69
  70     SVT_DLLPRIVATE void     SetWidthAndHeight();
  71     SVT_DLLPRIVATE void     InitData( bool _bRadioBtn, const Control* pControlForSettings );
  72 public:
  73                             // include creating default images (CheckBox or RadioButton)
  74                             SvLBoxButtonData( const Control* pControlForSettings );
  75                             SvLBoxButtonData( const Control* pControlForSettings, bool _bRadioBtn );
  76
  77                             ~SvLBoxButtonData();
  78
  79     static SvBmp            GetIndex( SvItemStateFlags nItemState );
  80     long                    Width();
  81     long                    Height();
  82     void                    SetLink( const Link<SvLBoxButtonData*,void>& rLink) { aLink=rLink; }
  83     bool                    IsRadio();
  84     // as buttons are not derived from LinkHdl
  85     void                    CallLink();
  86
  87     void                    StoreButtonState( SvTreeListEntry* pEntry );
  88     static SvButtonState    ConvertToButtonState( SvItemStateFlags nItemFlags );
  89
  90     SvTreeListEntry*        GetActEntry() const;
  91
  92     void                    SetImage(SvBmp nIndex, const Image& aImage) { aBmps[static_cast<int>(nIndex)] = aImage; }
  93     Image&                  GetImage(SvBmp nIndex) { return aBmps[static_cast<int>(nIndex)]; }
  94
  95     void                    SetDefaultImages( const Control* pControlForSettings );
  96                                 // set images according to the color scheme of the Control
  97                                 // pControlForSettings == NULL: settings are taken from Application
  98     bool                    HasDefaultImages() const;
  99 };
 100
 101 // **********************************************************************
 102
 103 class SVT_DLLPUBLIC SvLBoxString : public SvLBoxItem
 104 {
 105 protected:
 106     OUString maText;
 107
 108 public:
 109     SvLBoxString(const OUString& rText);
 110     SvLBoxString();
 111     virtual ~SvLBoxString() override;
 112
 113     virtual SvLBoxItemType GetType() const override;
 114     virtual void InitViewData(SvTreeListBox* pView,
 115                               SvTreeListEntry* pEntry,
 116                               SvViewDataItem* pViewData = nullptr) override;
 117
 118     const OUString& GetText() const
 119     {
 120         return maText;
 121     }
 122     void SetText(const OUString& rText)
 123     {
 124         maText = rText;
 125     }
 126
 127     virtual void Paint(const Point& rPos, SvTreeListBox& rOutDev,
 128                        vcl::RenderContext& rRenderContext,
 129                        const SvViewDataEntry* pView,
 130                        const SvTreeListEntry& rEntry) override;
 131
 132     virtual std::unique_ptr<SvLBoxItem> Clone(SvLBoxItem const * pSource) const override;
 133 };
 134
 135 class SVT_DLLPUBLIC SvLBoxButton : public SvLBoxItem
 136 {
 137     bool    isVis;
 138     SvLBoxButtonData*   pData;
 139     SvLBoxButtonKind const eKind;
 140     SvItemStateFlags nItemFlags;
 141
 142     static void ImplAdjustBoxSize( Size& io_rCtrlSize, ControlType i_eType, vcl::RenderContext const & pRenderContext);
 143 public:
 144     // An SvLBoxButton can be of three different kinds: an
 145     // enabled checkbox (the normal kind), a disabled checkbox
 146     // (which cannot be modified via UI), or a static image
 147     // (see SV_BMP_STATICIMAGE; nFlags are effectively ignored
 148     // for that kind).
 149     SvLBoxButton( SvLBoxButtonKind eTheKind, SvLBoxButtonData* pBData );
 150     SvLBoxButton();
 151     virtual ~SvLBoxButton() override;
 152     virtual void InitViewData(SvTreeListBox* pView,
 153                               SvTreeListEntry* pEntry,
 154                               SvViewDataItem* pViewData = nullptr) override;
 155
 156     virtual SvLBoxItemType GetType() const override;
 157     void ClickHdl( SvTreeListEntry* );
 158
 159     virtual void Paint(const Point& rPos,
 160                        SvTreeListBox& rOutDev,
 161                        vcl::RenderContext& rRenderContext,
 162                        const SvViewDataEntry* pView,
 163                        const SvTreeListEntry& rEntry) override;
 164
 165     virtual std::unique_ptr<SvLBoxItem> Clone(SvLBoxItem const * pSource) const override;
 166
 167     SvItemStateFlags GetButtonFlags() const
 168     {
 169         return nItemFlags;
 170     }
 171     bool IsStateChecked() const
 172     {
 173         return bool(nItemFlags & SvItemStateFlags::CHECKED);
 174     }
 175     bool IsStateUnchecked() const
 176     {
 177         return bool(nItemFlags & SvItemStateFlags::UNCHECKED);
 178     }
 179     bool IsStateTristate() const
 180     {
 181         return bool(nItemFlags & SvItemStateFlags::TRISTATE);
 182     }
 183     bool IsStateHilighted() const
 184     {
 185         return bool(nItemFlags & SvItemStateFlags::HILIGHTED);
 186     }
 187     void SetStateChecked();
 188     void SetStateUnchecked();
 189     void SetStateTristate();
 190     void SetStateHilighted(bool bHilight);
 191     void SetStateInvisible();
 192
 193     SvLBoxButtonKind GetKind() const { return eKind; }
 194
 195     // Check whether this button can be modified via UI
 196     bool CheckModification() const;
 197 };
 198
 199 inline void SvLBoxButton::SetStateChecked()
 200 {
 201     nItemFlags &= SvItemStateFlags::HILIGHTED;
 202     nItemFlags |= SvItemStateFlags::CHECKED;
 203 }
 204
 205 inline void SvLBoxButton::SetStateUnchecked()
 206 {
 207     nItemFlags &= SvItemStateFlags::HILIGHTED;
 208     nItemFlags |= SvItemStateFlags::UNCHECKED;
 209 }
 210 inline void SvLBoxButton::SetStateTristate()
 211 {
 212     nItemFlags &= SvItemStateFlags::HILIGHTED;
 213     nItemFlags |= SvItemStateFlags::TRISTATE;
 214 }
 215 inline void SvLBoxButton::SetStateHilighted( bool bHilight )
 216 {
 217     if ( bHilight )
 218         nItemFlags |= SvItemStateFlags::HILIGHTED;
 219     else
 220         nItemFlags &= ~SvItemStateFlags::HILIGHTED;
 221 }
 222
 223 struct SvLBoxContextBmp_Impl;
 224
 225 class SVT_DLLPUBLIC SvLBoxContextBmp : public SvLBoxItem
 226 {
 227     std::unique_ptr<SvLBoxContextBmp_Impl>  m_pImpl;
 228 public:
 229     SvLBoxContextBmp(const Image& aBmp1,
 230                      const Image& aBmp2,
 231                      bool bExpanded);
 232     SvLBoxContextBmp();
 233     virtual ~SvLBoxContextBmp() override;
 234
 235     virtual SvLBoxItemType GetType() const override;
 236     virtual void InitViewData(SvTreeListBox* pView,
 237                               SvTreeListEntry* pEntry,
 238                               SvViewDataItem* pViewData = nullptr) override;
 239     virtual void Paint(const Point& rPos,
 240                        SvTreeListBox& rOutDev,
 241                        vcl::RenderContext& rRenderContext,
 242                        const SvViewDataEntry* pView,
 243                        const SvTreeListEntry& rEntry) override;
 244
 245     virtual std::unique_ptr<SvLBoxItem> Clone(SvLBoxItem const * pSource) const override;
 246
 247     void SetModeImages(const Image& rBitmap1, const Image& rBitmap2);
 248
 249     inline void SetBitmap1(const Image& rImage);
 250     inline void SetBitmap2(const Image& rImage);
 251     inline const Image& GetBitmap1() const;
 252     inline const Image& GetBitmap2() const;
 253
 254 private:
 255     Image& implGetImageStore(bool bFirst);
 256 };
 257
 258 inline void SvLBoxContextBmp::SetBitmap1(const Image& _rImage)
 259 {
 260     implGetImageStore(true) = _rImage;
 261 }
 262
 263 inline void SvLBoxContextBmp::SetBitmap2(const Image& _rImage)
 264 {
 265     implGetImageStore(false) = _rImage;
 266 }
 267
 268 inline const Image& SvLBoxContextBmp::GetBitmap1() const
 269 {
 270     Image& rImage = const_cast<SvLBoxContextBmp*>(this)->implGetImageStore(true);
 271     return rImage;
 272 }
 273
 274 inline const Image& SvLBoxContextBmp::GetBitmap2() const
 275 {
 276     Image& rImage = const_cast<SvLBoxContextBmp*>(this)->implGetImageStore(false);
 277     return rImage;
 278 }
 279
 280 #endif
 281
 282 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */