sd/source/ui/toolpanel/ControlContainerDescriptor.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 SD_TASKPANE_CONTROL_CONTAINER_DESCRIPTOR_HXX
  21 #define SD_TASKPANE_CONTROL_CONTAINER_DESCRIPTOR_HXX
  22
  23 #include "taskpane/ILayoutableWindow.hxx"
  24 #include "taskpane/TitleBar.hxx"
  25 #include <tools/string.hxx>
  26 #include <tools/gen.hxx>
  27 #include <vcl/window.hxx>
  28 #include <memory>
  29
  30 class Window;
  31
  32 namespace sd { namespace toolpanel {
  33
  34 class ControlContainer;
  35
  36 /** Collection of information the describes entries of the tool
  37     panel.  A descriptor owns the control it is associated with.
  38 */
  39 class ControlContainerDescriptor
  40     : public ::Window,
  41       public virtual ILayoutableWindow
  42 {
  43 public:
  44     /** Create a new descriptor for the given control.
  45         @param rContainer
  46             The container to inform about selection (caused by mouse
  47             clicks or keyboard.)
  48         @param pParent
  49             The parent window of the new descriptor.
  50         @param pControl
  51             The control that is shown when being in the expanded
  52             state.
  53         @param rTitle
  54             String that is shown as title in the title area above the
  55             control.
  56         @param eType
  57             Type of the title bar.  This specifies how the title bar
  58             will be formated.  For more information see TitleBar.
  59
  60     */
  61     ControlContainerDescriptor (
  62         ControlContainer& rContainer,
  63         ::Window* pParent,
  64         ::std::auto_ptr<ILayoutableWindow> pControl,
  65         const String& rTitle,
  66         TitleBar::TitleBarType eType);
  67
  68     virtual ~ControlContainerDescriptor (void);
  69
  70
  71     virtual Size GetPreferredSize (void);
  72     virtual int GetPreferredWidth (int nHeight);
  73     virtual int GetPreferredHeight (int nWidth);
  74     virtual bool IsResizable (void);
  75     virtual ::Window* GetWindow (void);
  76
  77     virtual void Resize (void);
  78     virtual void GetFocus (void);
  79     virtual void LoseFocus (void);
  80     virtual void MouseButtonUp (const MouseEvent& rMouseEvent);
  81     virtual void KeyInput (const KeyEvent& rEvent);
  82
  83     void Select (bool bExpansionState);
  84
  85     //    const Rectangle& GetTitleBarBox (void) const;
  86
  87     Window* GetControl (void) const;
  88     const String& GetTitle (void) const;
  89
  90     void Expand (bool bExpanded = true);
  91     void Collapse (void);
  92     bool IsExpanded (void) const;
  93
  94     /** Ownership of the given data remains with the caller.  The data
  95         is thus not destroyed when the destructor of this class is
  96         called.
  97     */
  98     void SetUserData (void* pUserData);
  99     void* GetUserData (void) const;
 100
 101     bool IsVisible (void) const;
 102     void SetVisible (bool bVisible);
 103
 104     using Window::GetWindow;
 105     using sd::toolpanel::ILayoutableWindow::GetPreferredWidth;
 106     using sd::toolpanel::ILayoutableWindow::GetPreferredHeight;
 107
 108 private:
 109     ControlContainer& mrContainer;
 110     ::std::auto_ptr<TitleBar> mpTitleBar;
 111     ::std::auto_ptr<ILayoutableWindow> mpControl;
 112     String msTitle;
 113     bool mbExpanded;
 114     bool mbVisible;
 115     void* mpUserData;
 116     bool mnVisible;
 117
 118     /// Do not use! Assignment operator is not supported.
 119     const ControlContainerDescriptor& operator= (
 120         const ControlContainerDescriptor& aDescriptor);
 121
 122     void UpdateStates (void);
 123
 124     DECL_LINK(WindowEventListener, VclSimpleEvent*);
 125 };
 126
 127 } } // end of namespace ::sd::toolpanel
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */