xref: /AOO41X/main/sd/source/ui/inc/PaneDockingWindow.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef SD_PANE_DOCKING_WINDOW_HXX
29*cdf0e10cSrcweir #define SD_PANE_DOCKING_WINDOW_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <sfx2/titledockwin.hxx>
32*cdf0e10cSrcweir #include <sfx2/viewfrm.hxx>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include <boost/scoped_ptr.hpp>
35*cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir class ToolBox;
38*cdf0e10cSrcweir class SplitWindow;
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir namespace sd {
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir     class PaneDockingWindow : public ::sfx2::TitledDockingWindow
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir public:
45*cdf0e10cSrcweir     /** Create a new docking window.
46*cdf0e10cSrcweir         @param pBindings
47*cdf0e10cSrcweir             Used, among others, to determine the ViewShellBase and
48*cdf0e10cSrcweir             PaneManager that manage the new docking window.
49*cdf0e10cSrcweir         @param pChildWindow
50*cdf0e10cSrcweir             This child window is the logical container for the new docking
51*cdf0e10cSrcweir             window.
52*cdf0e10cSrcweir         @param pParent
53*cdf0e10cSrcweir             The parent window of the new docking window.
54*cdf0e10cSrcweir         @param rResId
55*cdf0e10cSrcweir             The resource is used to determine initial size and attributes.
56*cdf0e10cSrcweir         @param rsTitle
57*cdf0e10cSrcweir             the initial title
58*cdf0e10cSrcweir     */
59*cdf0e10cSrcweir     PaneDockingWindow (
60*cdf0e10cSrcweir         SfxBindings *pBindings,
61*cdf0e10cSrcweir         SfxChildWindow *pChildWindow,
62*cdf0e10cSrcweir         ::Window* pParent,
63*cdf0e10cSrcweir         const ResId& rResId,
64*cdf0e10cSrcweir         const ::rtl::OUString& rsTitle);
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir     virtual ~PaneDockingWindow (void);
67*cdf0e10cSrcweir 	virtual void StateChanged( StateChangedType nType );
68*cdf0e10cSrcweir     virtual void MouseButtonDown (const MouseEvent& rEvent);
69*cdf0e10cSrcweir     /** When docked the given range is passed to the parent SplitWindow.
70*cdf0e10cSrcweir     */
71*cdf0e10cSrcweir     void SetValidSizeRange (const Range aValidSizeRange);
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir     enum Orientation { HorizontalOrientation, VerticalOrientation, UnknownOrientation };
74*cdf0e10cSrcweir     /** When the PaneDockingWindow is docked and managed by a split window
75*cdf0e10cSrcweir         it can derive its orientation from the orientation of the split
76*cdf0e10cSrcweir         window and return either HorizontalOrientation or
77*cdf0e10cSrcweir         VerticalOrientation.
78*cdf0e10cSrcweir         Otherwise UnknownOrientation is returned.
79*cdf0e10cSrcweir     */
80*cdf0e10cSrcweir     Orientation GetOrientation (void) const;
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir     /** The current height of the title bar.
83*cdf0e10cSrcweir     */
84*cdf0e10cSrcweir     sal_Int32 mnTitleBarHeight;
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir };
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir } // end of namespace ::sd
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir #endif
91