xref: /aoo41x/main/sfx2/source/sidebar/Panel.hxx (revision c545150f)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 #ifndef SFX_SIDEBAR_PANEL_HXX
23 #define SFX_SIDEBAR_PANEL_HXX
24 
25 #include <vcl/window.hxx>
26 
27 #include <com/sun/star/ui/XUIElement.hpp>
28 #include <com/sun/star/ui/XSidebarPanel.hpp>
29 
30 #include <boost/function.hpp>
31 #include <boost/scoped_ptr.hpp>
32 #include <boost/shared_ptr.hpp>
33 #include <vector>
34 
35 namespace css = ::com::sun::star;
36 namespace cssu = ::com::sun::star::uno;
37 
38 namespace sfx2 { namespace sidebar {
39 
40 class PanelDescriptor;
41 class TitleBar;
42 class PanelTitleBar;
43 
44 
45 class Panel
46     : public Window
47 {
48 public:
49     Panel (
50         const PanelDescriptor& rPanelDescriptor,
51         Window* pParentWindow,
52         const ::boost::function<void(void)>& rDeckLayoutTrigger );
53     virtual ~Panel (void);
54 
55     void Dispose (void);
56 
57     void SetShowMenuFunctor( const ::boost::function<void(void)>& rShowMenuFunctor );
58     TitleBar* GetTitleBar (void) const;
59     bool IsTitleBarOptional (void) const;
60     void SetUIElement (const cssu::Reference<css::ui::XUIElement>& rxElement);
61     cssu::Reference<css::ui::XSidebarPanel> GetPanelComponent (void) const;
62     cssu::Reference<css::awt::XWindow> GetElementWindow (void);
63     void SetExpanded (const bool bIsExpanded);
64     bool IsExpanded (void) const;
65     bool HasIdPredicate (const ::rtl::OUString& rsId) const;
66     const ::rtl::OUString& GetId (void) const;
67 
68     virtual void Paint (const Rectangle& rUpdateArea);
69     virtual void Resize (void);
70     virtual void DataChanged (const DataChangedEvent& rEvent);
71     virtual void Activate (void);
72 
73     void PrintWindowTree (void);
74 
75 private:
76     const ::rtl::OUString msPanelId;
77     ::boost::scoped_ptr<PanelTitleBar> mpTitleBar;
78     const bool mbIsTitleBarOptional;
79     cssu::Reference<css::ui::XUIElement> mxElement;
80     cssu::Reference<css::ui::XSidebarPanel> mxPanelComponent;
81     bool mbIsExpanded;
82     const ::boost::function<void(void)> maDeckLayoutTrigger;
83     Rectangle maBoundingBox;
84 };
85 typedef ::boost::shared_ptr<Panel> SharedPanel;
86 typedef ::std::vector<SharedPanel> SharedPanelContainer;
87 
88 
89 } } // end of namespace sfx2::sidebar
90 
91 #endif
92