sd/source/ui/inc/taskpane/TitledControl.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TitledControl.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_TASKPANE_TITLED_CONTROL_HXX
  32 #define SD_TASKPANE_TITLED_CONTROL_HXX
  33
  34 #include "taskpane/TaskPaneTreeNode.hxx"
  35 #include "taskpane/ControlContainer.hxx"
  36 #include "TitleBar.hxx"
  37 #include <com/sun/star/drawing/framework/XResourceId.hpp>
  38 #include <tools/string.hxx>
  39 #include <tools/gen.hxx>
  40 #ifndef SD_WINDOW_HXX
  41 #include <vcl/window.hxx>
  42 #endif
  43 #include <memory>
  44 #include <boost/function.hpp>
  45
  46 class Window;
  47
  48 namespace sd { namespace toolpanel {
  49
  50 class ControlContainer;
  51 class ControlFactory;
  52
  53 /** This wrapper adds a title bar to a control.  Both title bar and
  54     control are child windows.
  55 */
  56 class TitledControl
  57     : public ::Window,
  58       public TreeNode
  59 {
  60 public:
  61     typedef ::boost::function1<void, TitledControl&> ClickHandler;
  62
  63     /** Create a new descriptor for the given control.
  64         @param pParent
  65             The parent window of the new descriptor.
  66         @param pControl
  67             The control that is shown when being in the expanded
  68             state.
  69         @param rTitle
  70             String that is shown as title in the title area above the
  71             control.
  72         @param rClickHandler
  73             The typical action of the click handler is to expand the control.
  74         @param eType
  75             Type of the title bar.  This specifies how the title bar
  76             will be formated.  For more information see TitleBar.
  77
  78     */
  79     TitledControl (
  80         TreeNode* pParent,
  81         ::std::auto_ptr<TreeNode> pControl,
  82         const String& rTitle,
  83         const ClickHandler& rClickHandler,
  84         TitleBar::TitleBarType eType);
  85
  86     TitledControl (
  87         TreeNode* pParent,
  88         ::std::auto_ptr<ControlFactory> pControlFactory,
  89         const String& rTitle,
  90         const ClickHandler& rClickHandler,
  91         TitleBar::TitleBarType eType);
  92
  93     virtual ~TitledControl (void);
  94
  95
  96     virtual Size GetPreferredSize (void);
  97     virtual sal_Int32 GetPreferredWidth (sal_Int32 nHeight);
  98     virtual sal_Int32 GetPreferredHeight (sal_Int32 nWidth);
  99     virtual bool IsResizable (void);
 100     virtual ::Window* GetWindow (void);
 101
 102     virtual void Resize (void);
 103     virtual void GetFocus (void);
 104     virtual void LoseFocus (void);
 105     virtual void KeyInput (const KeyEvent& rEvent);
 106
 107     //    void Select (bool bExpansionState);
 108
 109     TitleBar* GetTitleBar (void);
 110     /** Return the control child.  When a control factory has been given and
 111         the control has not yet been created and the given flag is <TRUE/>
 112         then the control is created.
 113     */
 114     TreeNode* GetControl (bool bCreate=true);
 115     const TreeNode* GetConstControl (bool bCreate=true) const;
 116
 117     const String& GetTitle (void) const;
 118
 119     /** Expand the control without informing its container.  This
 120         method ususally is called by the container as a result of a
 121         higher level expand command.  You may want to use
 122         ExpandViaContainer() instead.
 123         @param bExpanded
 124             When <TRUE/> then the control is expanded, otherwise it is
 125             collapsed.
 126     */
 127     virtual bool Expand (bool bExpanded = true);
 128
 129     /** Return whether the control is currently expanded (<TRUE/>) or
 130         not (<FALSE/>).
 131     */
 132     virtual bool IsExpanded (void) const;
 133
 134     /** Returns the value of the control.
 135     */
 136     virtual bool IsExpandable (void) const;
 137
 138     virtual void SetEnabledState(bool bFlag);
 139
 140     /** Ownership of the given data remains with the caller.  The data
 141         is thus not destroyed when the destructor of this class is
 142         called.
 143     */
 144     void SetUserData (void* pUserData);
 145     void* GetUserData (void) const;
 146
 147     virtual bool IsShowing (void) const;
 148     virtual void Show (bool bVisible);
 149
 150     virtual ::com::sun::star::uno::Reference<
 151         ::com::sun::star::accessibility::XAccessible > CreateAccessibleObject (
 152             const ::com::sun::star::uno::Reference<
 153             ::com::sun::star::accessibility::XAccessible>& rxParent);
 154
 155     using Window::GetWindow;
 156     using Window::Show;
 157
 158 private:
 159     String msTitle;
 160     bool mbVisible;
 161     void* mpUserData;
 162     ::std::auto_ptr<ControlFactory> mpControlFactory;
 163     ::std::auto_ptr<ClickHandler> mpClickHandler;
 164
 165     /** Remember whether to toggle (true) the expansion state when the title
 166         bar is clicked on.  When set to false then the control is always
 167         expanded.
 168     */
 169     bool mbExpansionModeIsToggle;
 170
 171     /// Do not use! Assignment operator is not supported.
 172     const TitledControl& operator= (
 173         const TitledControl& aDescriptor);
 174
 175     void UpdateStates (void);
 176
 177     DECL_LINK(WindowEventListener, VclSimpleEvent*);
 178 };
 179
 180
 181
 182
 183 /** This standard implementation of the ClickHandler expands, or toggles the
 184     expansion state, of the control, whose title was clicked.
 185 */
 186 class TitledControlStandardClickHandler
 187 {
 188 public:
 189     /** Create a new instance of this class.
 190         @param rControlContainer
 191             The container of which the TitledControl is part of.
 192         @param eExpansionState
 193             This specifies whether to always expand the titled control or to
 194             toggle its expansion state.
 195     */
 196     TitledControlStandardClickHandler (
 197         ControlContainer& rControlContainer,
 198         ControlContainer::ExpansionState eExpansionState);
 199     void operator () (TitledControl& rTitledControl);
 200 private:
 201     ControlContainer& mrControlContainer;
 202     ControlContainer::ExpansionState meExpansionState;
 203 };
 204
 205 } } // end of namespace ::sd::toolpanel
 206
 207 #endif