sd/source/ui/toolpanel/ToolPanelDescriptor.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: ToolPanelDescriptor.hxx,v $
  10  * $Revision: 1.4 $
  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_TOOL_PANEL_DESCRIPTOR_HXX
  32 #define SD_TOOL_PANEL_DESCRIPTOR_HXX
  33
  34 #include <tools/string.hxx>
  35 #include <tools/gen.hxx>
  36 #include <memory>
  37
  38 class Window;
  39
  40 namespace sd { namespace toolpanel {
  41
  42
  43 /** Collection of information the describes entries of the tool
  44     panel.  A descriptor owns the control it is associated with.
  45 */
  46 class ToolPanelDescriptor
  47 {
  48 public:
  49     /** Create a new descriptor for the given control.
  50         @param pControl
  51     */
  52     ToolPanelDescriptor (::std::auto_ptr< ::Window> pControl,
  53         const String& rTitle);
  54
  55     ~ToolPanelDescriptor (void);
  56
  57     /** Return the height of the title bar.
  58         @return
  59             The title bar height is returned in pixels.
  60     */
  61     int GetTitleBarHeight (void) const;
  62
  63
  64     void SetPositionAndSize (const Point& aPosition,
  65         const Size& aSize);
  66     void SetPositionAndSize (const Rectangle& aBox);
  67     void SetWeight (double nWeight);
  68
  69     Window* GetControl (void) const;
  70     const String& GetTitle (void) const;
  71     const Rectangle& GetTitleBox (void) const;
  72     Rectangle GetPositionAndSize (void) const;
  73     double GetWeight (void) const;
  74
  75     int GetTotalHeight (void) const;
  76     int GetWindowHeight (void) const;
  77
  78 private:
  79     ::std::auto_ptr< ::Window> mpControl;
  80     String msTitle;
  81     Rectangle maTitleBox;
  82     double mnWeight;
  83     int mnTotalHeight;
  84
  85     /// Do not use! Assignment operator is not supported.
  86     const ToolPanelDescriptor& operator= (
  87         const ToolPanelDescriptor& aDescriptor);
  88 };
  89
  90 } } // end of namespace ::sd::toolpanel
  91
  92 #endif