xref: /trunk/main/sfx2/source/sidebar/Panel.hxx (revision 8a1a651a)
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 "Context.hxx"
26 #include <vcl/window.hxx>
27 
28 #include <com/sun/star/ui/XUIElement.hpp>
29 #include <com/sun/star/ui/XSidebarPanel.hpp>
30 
31 #include <boost/function.hpp>
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/shared_ptr.hpp>
34 #include <vector>
35 
36 namespace css = ::com::sun::star;
37 namespace cssu = ::com::sun::star::uno;
38 
39 namespace sfx2 { namespace sidebar {
40 
41 class PanelDescriptor;
42 class TitleBar;
43 class PanelTitleBar;
44 
45 
46 class Panel
47     : public Window
48 {
49 public:
50     Panel (
51         const PanelDescriptor& rPanelDescriptor,
52         Window* pParentWindow,
53         const bool bIsInitiallyExpanded,
54         const ::boost::function<void(void)>& rDeckLayoutTrigger,
55         const ::boost::function<Context(void)>& rContextAccess);
56     virtual ~Panel (void);
57 
58     void Dispose (void);
59 
60     PanelTitleBar* GetTitleBar (void) const;
61     bool IsTitleBarOptional (void) const;
62     void SetUIElement (const cssu::Reference<css::ui::XUIElement>& rxElement);
63     cssu::Reference<css::ui::XSidebarPanel> GetPanelComponent (void) const;
64     cssu::Reference<css::awt::XWindow> GetElementWindow (void);
65     void SetExpanded (const bool bIsExpanded);
66     bool IsExpanded (void) const;
67     bool HasIdPredicate (const ::rtl::OUString& rsId) const;
68     const ::rtl::OUString& GetId (void) const;
69 
70     virtual void Paint (const Rectangle& rUpdateArea);
71     virtual void Resize (void);
72     virtual void DataChanged (const DataChangedEvent& rEvent);
73     virtual void Activate (void);
74 
75     void PrintWindowTree (void);
76 
77 private:
78     const ::rtl::OUString msPanelId;
79     ::boost::scoped_ptr<PanelTitleBar> mpTitleBar;
80     const bool mbIsTitleBarOptional;
81     cssu::Reference<css::ui::XUIElement> mxElement;
82     cssu::Reference<css::ui::XSidebarPanel> mxPanelComponent;
83     bool mbIsExpanded;
84     const ::boost::function<void(void)> maDeckLayoutTrigger;
85     const ::boost::function<Context(void)> maContextAccess;
86 };
87 typedef ::boost::shared_ptr<Panel> SharedPanel;
88 typedef ::std::vector<SharedPanel> SharedPanelContainer;
89 
90 
91 } } // end of namespace sfx2::sidebar
92 
93 #endif
94