include/svx/tbcontrl.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 #ifndef INCLUDED_SVX_TBCONTRL_HXX
  20 #define INCLUDED_SVX_TBCONTRL_HXX
  21
  22 /*--------------------------------------------------------------*\
  23
  24     Description:
  25     -------------
  26     ToolBox-Controller for:
  27         Font-Name, Font-Height, Font-Color
  28         Fore-/Background color /-patterns
  29         Frames, Lines
  30         (indentation-)templates
  31
  32     Use:
  33     ----------
  34         SvxFontNameToolBoxControl
  35         -------------------------
  36         Item type:      SvxFontItem
  37         Execute-Id:     SID_ATTR_CHAR_FONT
  38                         -> SvxFontItem
  39         Additional information
  40         from DocShell:   SvxFontListItem (SID_ATTR_CHAR_FONTLIST)
  41
  42         SvxColorToolBoxControl
  43         ----------------------
  44         Item type:      SvxColorItem
  45                         SvxLineItem
  46                         SfxBoolItem
  47                         XLineColorItem
  48                     and XFillColorItem
  49
  50         for font color (writer, ...)
  51         Execute-Id      SID_ATTR_CHAR_COLOR2
  52                     and SID_ATTR_CHAR_COLOR_EXT
  53
  54         for font color
  55         (calc/impress/draw and writer drawing objects)
  56         Execute-Id      SID_ATTR_CHAR_COLOR
  57
  58         for character background color (writer)
  59         Execute-Id      SID_ATTR_CHAR_COLOR_BACKGROUND
  60                     and SID_ATTR_CHAR_COLOR_BACKGROUND_EXT
  61
  62         for paragraph background color (writer)
  63         and cell background color (calc)
  64         Execute-Id      SID_BACKGROUND_COLOR
  65
  66         for table/cell border color (writer, calc)
  67         Execute-Id      SID_FRAME_LINECOLOR
  68
  69         for 3D extrusion
  70         Execute-Id      SID_EXTRUSION_3D_COLOR
  71
  72         for line color
  73         Execute-Id      SID_ATTR_LINE_COLOR
  74
  75         for area fill color
  76         Execute-Id      SID_ATTR_FILL_COLOR
  77
  78         SvxPatternToolBoxControl
  79         ------------------------
  80         Item type:      SvxBrushItem
  81         Execute-Id:     SID_BACKGROUND_PATTERN
  82                         -> SvxBrushItem
  83         Additional information
  84         from DocShell:   presently none
  85                         in future: color palette
  86         Note:           Analysis of BrushItem:
  87                         Brush-FillColor() is misused as switch,
  88                         to distinguish whether a new style
  89                         or a new color has been set
  90
  91                         GetFillColor() == COL_BLACK -> GetStyle() ,
  92                         GetFillColor() == COL_WHITE -> GetColor()
  93
  94         SvxFrameToolBoxControl
  95         ----------------------
  96         Item type:      SvxBoxItem
  97         Execute-Id:     SID_ATTR_BORDER
  98                         -> SvxBoxItem & SvxBoxInfoItem
  99         Additional information
 100         from DocShell:  none
 101         Note:           provides, depending on chosen ValueSet-Item,
 102                         only SvxBoxItem or additionally SvxBoxInfoItem
 103                         If the Controller in SfxUInt16Item receives a
 104                         value != 0, paragraph mode will be switched on,
 105                         i.e. the last line will be hidden.
 106                         A value == 0 switches again to Table mode.
 107
 108         SvxFrameLineStyleToolBoxControl
 109         -------------------------------
 110         Item type:      SvxLineItem
 111         Execute-Id:     SID_FRAME_LINESTYLE
 112                         -> SvxLineItem
 113         Additional information
 114         from DocShell:  none
 115         Note:           provides a SvxLineItem, which provides a SvxBorderLine
 116                         without color information.
 117
 118         SvxStyleToolBoxControl
 119         ----------------------
 120         Item type:      SfxTemplateItem
 121         Execute-Id:     SID_TEMPLATE_APPLY
 122                         -> StyleName (SfxStringItem)
 123                         -> eStyleFamily (SfxUInt16Item)
 124         Additional information
 125         from DocShell:  none
 126         Note:           Switch family by Invalidate
 127                         at the Bindings (->SfxStyleControllerItem)
 128
 129 \*--------------------------------------------------------------*/
 130
 131 // ITEMID_... defines in the *.cxx
 132
 133 #include <rsc/rscsfx.hxx>
 134 #include <svl/lstner.hxx>
 135 #include <sfx2/tbxctrl.hxx>
 136 #include <svx/strarray.hxx>
 137 #include <svx/svxdllapi.h>
 138 #include <com/sun/star/awt/FontDescriptor.hpp>
 139 #include <svx/colorwindow.hxx>
 140 #include <svx/PaletteManager.hxx>
 141 #include <memory>
 142
 143 // important in the tbxctrls.hxx created with HeDaBu !!!
 144 class SvxLineItem;
 145 class SvxBoxInfoItem;
 146 class SvxFontItem;
 147 class SfxStyleControllerItem_Impl;
 148 class SfxStyleSheetBasePool;
 149 class SfxTemplateItem;
 150 class SvxStyleBox_Impl;
 151
 152 namespace svx
 153 {
 154     class ToolboxButtonColorUpdater;
 155 }
 156
 157 class SVX_DLLPUBLIC SvxStyleToolBoxControl : public SfxToolBoxControl
 158 {
 159     struct Impl;
 160     std::unique_ptr<Impl> pImpl;
 161
 162 public:
 163     SFX_DECL_TOOLBOX_CONTROL();
 164
 165     SvxStyleToolBoxControl(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rToolBox);
 166     virtual ~SvxStyleToolBoxControl() override;
 167
 168     virtual VclPtr<vcl::Window> CreateItemWindow(vcl::Window* pParent) override;
 169
 170     virtual void StateChanged(sal_uInt16 nSID, SfxItemState eState,
 171                               const SfxPoolItem* pState) override;
 172
 173     DECL_LINK( VisibilityNotification, SvxStyleBox_Impl&, void );
 174 protected:
 175     // XInitialization
 176     virtual void SAL_CALL initialize(const css::uno::Sequence<css::uno::Any>& aArguments) override;
 177
 178     // XUpdatable
 179     virtual void SAL_CALL update() override;
 180
 181     // XComponent
 182     virtual void SAL_CALL dispose() override;
 183
 184 private:
 185
 186 #define MAX_FAMILIES 5
 187
 188     SfxStyleSheetBasePool* pStyleSheetPool;
 189     SfxStyleControllerItem_Impl* pBoundItems[MAX_FAMILIES];
 190     css::uno::Reference<css::lang::XComponent> m_xBoundItems[MAX_FAMILIES];
 191     SfxTemplateItem* pFamilyState[MAX_FAMILIES];
 192     sal_uInt16 nActFamily; // Id in the ToolBox = Position - 1
 193
 194     SVX_DLLPRIVATE void Update();
 195     SVX_DLLPRIVATE void FillStyleBox();
 196     SVX_DLLPRIVATE void SelectStyle(const OUString& rStyleName);
 197
 198 friend class SfxStyleControllerItem_Impl;
 199
 200     SVX_DLLPRIVATE void SetFamilyState(sal_uInt16 nIdx, const SfxTemplateItem* pItem);
 201     SVX_DLLPRIVATE SfxStyleFamily GetActFamily();
 202 };
 203
 204 typedef std::function<void(const OUString&, const NamedColor&)> ColorSelectFunction;
 205
 206 class SVX_DLLPUBLIC SvxColorToolBoxControl : public cppu::ImplInheritanceHelper< SfxToolBoxControl,
 207                                                                                  css::frame::XSubToolbarController >
 208 {
 209     std::unique_ptr<svx::ToolboxButtonColorUpdater> m_xBtnUpdater;
 210     std::unique_ptr<PaletteManager> m_xPaletteManager;
 211     BorderColorStatus m_aBorderColorStatus;
 212     bool m_bSplitButton;
 213     ColorSelectFunction m_aColorSelectFunction;
 214     DECL_LINK(SelectedHdl, const NamedColor&, void);
 215 public:
 216     SFX_DECL_TOOLBOX_CONTROL();
 217     SvxColorToolBoxControl(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rToolBox);
 218     virtual ~SvxColorToolBoxControl() override;
 219
 220     // XStatusListener
 221     virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& rEvent ) override;
 222
 223     virtual VclPtr<SfxPopupWindow> CreatePopupWindow() override;
 224     virtual void Select(sal_uInt16 nSelectModifier) override;
 225
 226     // XSubToolbarController
 227     virtual sal_Bool SAL_CALL opensSubToolbar() override;
 228     virtual OUString SAL_CALL getSubToolbarName() override;
 229     virtual void SAL_CALL functionSelected( const OUString& rCommand ) override;
 230     virtual void SAL_CALL updateImage() override;
 231
 232     void setColorSelectFunction(const ColorSelectFunction& aColorSelectFunction);
 233     void EnsurePaletteManager();
 234 };
 235
 236 class SVX_DLLPUBLIC SvxSimpleUndoRedoController : public SfxToolBoxControl
 237 {
 238 private:
 239     OUString aDefaultText;
 240
 241 public:
 242     SFX_DECL_TOOLBOX_CONTROL();
 243     SvxSimpleUndoRedoController(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rToolBox);
 244     virtual ~SvxSimpleUndoRedoController() override;
 245
 246     virtual void StateChanged(sal_uInt16 nSID, SfxItemState eState,
 247                               const SfxPoolItem* pState) override;
 248 };
 249
 250 class SVX_DLLPUBLIC SvxCurrencyToolBoxControl : public SfxToolBoxControl
 251 {
 252 private:
 253     OUString     m_aFormatString;
 254     LanguageType m_eLanguage;
 255     sal_uInt32   m_nFormatKey;
 256 public:
 257     static void GetCurrencySymbols( std::vector<OUString>& rList, bool bFlag,
 258                                     std::vector<sal_uInt16>& rCurrencyList );
 259     SFX_DECL_TOOLBOX_CONTROL();
 260     SvxCurrencyToolBoxControl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rBox );
 261     virtual ~SvxCurrencyToolBoxControl() override;
 262     virtual void Select( sal_uInt16 nSelectModifier ) override;
 263     virtual VclPtr<SfxPopupWindow> CreatePopupWindow() override;
 264
 265     // XInitialization
 266     virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& rArguments ) override;
 267 };
 268
 269
 270
 271 #endif // INCLUDED_SVX_TBCONTRL_HXX
 272
 273 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */