]>
Commit | Line | Data |
---|---|---|
3c3ead1d PC |
1 | /////////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/ribbon/bar.h | |
3 | // Purpose: Top-level component of the ribbon-bar-style interface | |
4 | // Author: Peter Cawley | |
5 | // Modified by: | |
6 | // Created: 2009-05-23 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (C) Peter Cawley | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_RIBBON_BAR_H_ | |
13 | #define _WX_RIBBON_BAR_H_ | |
14 | ||
15 | #include "wx/defs.h" | |
16 | ||
17 | #if wxUSE_RIBBON | |
18 | ||
19 | #include "wx/ribbon/control.h" | |
20 | #include "wx/ribbon/page.h" | |
21 | ||
22 | enum wxRibbonBarOption | |
23 | { | |
24 | wxRIBBON_BAR_SHOW_PAGE_LABELS = 1 << 0, | |
25 | wxRIBBON_BAR_SHOW_PAGE_ICONS = 1 << 1, | |
26 | wxRIBBON_BAR_FLOW_HORIZONTAL = 0, | |
27 | wxRIBBON_BAR_FLOW_VERTICAL = 1 << 2, | |
28 | wxRIBBON_BAR_SHOW_PANEL_EXT_BUTTONS = 1 << 3, | |
29 | wxRIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS = 1 << 4, | |
30 | wxRIBBON_BAR_ALWAYS_SHOW_TABS = 1 << 5, | |
31 | ||
32 | wxRIBBON_BAR_DEFAULT_STYLE = wxRIBBON_BAR_FLOW_HORIZONTAL | |
33 | | wxRIBBON_BAR_SHOW_PAGE_LABELS | |
34 | | wxRIBBON_BAR_SHOW_PANEL_EXT_BUTTONS, | |
35 | ||
36 | wxRIBBON_BAR_FOLDBAR_STYLE = wxRIBBON_BAR_FLOW_VERTICAL | |
37 | | wxRIBBON_BAR_SHOW_PAGE_ICONS | |
38 | | wxRIBBON_BAR_SHOW_PANEL_EXT_BUTTONS | |
2f6b64a9 | 39 | | wxRIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS |
3c3ead1d PC |
40 | }; |
41 | ||
42 | class WXDLLIMPEXP_RIBBON wxRibbonBarEvent : public wxNotifyEvent | |
43 | { | |
44 | public: | |
45 | wxRibbonBarEvent(wxEventType command_type = wxEVT_NULL, | |
46 | int win_id = 0, | |
47 | wxRibbonPage* page = NULL) | |
48 | : wxNotifyEvent(command_type, win_id) | |
49 | , m_page(page) | |
50 | { | |
51 | } | |
52 | #ifndef SWIG | |
53 | wxRibbonBarEvent(const wxRibbonBarEvent& c) : wxNotifyEvent(c) | |
54 | { | |
55 | m_page = c.m_page; | |
56 | } | |
57 | #endif | |
58 | wxEvent *Clone() const { return new wxRibbonBarEvent(*this); } | |
59 | ||
60 | wxRibbonPage* GetPage() {return m_page;} | |
61 | void SetPage(wxRibbonPage* page) {m_page = page;} | |
62 | ||
63 | protected: | |
64 | wxRibbonPage* m_page; | |
65 | ||
66 | #ifndef SWIG | |
67 | private: | |
68 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRibbonBarEvent) | |
69 | #endif | |
70 | }; | |
71 | ||
72 | class WXDLLIMPEXP_RIBBON wxRibbonPageTabInfo | |
73 | { | |
74 | public: | |
75 | wxRect rect; | |
76 | wxRibbonPage *page; | |
77 | int ideal_width; | |
78 | int small_begin_need_separator_width; | |
79 | int small_must_have_separator_width; | |
80 | int minimum_width; | |
81 | bool active; | |
82 | bool hovered; | |
5c14ec26 | 83 | bool shown; |
3c3ead1d PC |
84 | }; |
85 | ||
86 | #ifndef SWIG | |
87 | WX_DECLARE_USER_EXPORTED_OBJARRAY(wxRibbonPageTabInfo, wxRibbonPageTabInfoArray, WXDLLIMPEXP_RIBBON); | |
88 | #endif | |
89 | ||
90 | class WXDLLIMPEXP_RIBBON wxRibbonBar : public wxRibbonControl | |
91 | { | |
92 | public: | |
93 | wxRibbonBar(); | |
94 | ||
95 | wxRibbonBar(wxWindow* parent, | |
96 | wxWindowID id = wxID_ANY, | |
97 | const wxPoint& pos = wxDefaultPosition, | |
98 | const wxSize& size = wxDefaultSize, | |
99 | long style = wxRIBBON_BAR_DEFAULT_STYLE); | |
100 | ||
101 | virtual ~wxRibbonBar(); | |
102 | ||
103 | bool Create(wxWindow* parent, | |
104 | wxWindowID id = wxID_ANY, | |
105 | const wxPoint& pos = wxDefaultPosition, | |
106 | const wxSize& size = wxDefaultSize, | |
107 | long style = wxRIBBON_BAR_DEFAULT_STYLE); | |
108 | ||
109 | void SetTabCtrlMargins(int left, int right); | |
110 | ||
111 | void SetArtProvider(wxRibbonArtProvider* art); | |
112 | ||
113 | bool SetActivePage(size_t page); | |
114 | bool SetActivePage(wxRibbonPage* page); | |
115 | int GetActivePage() const; | |
116 | wxRibbonPage* GetPage(int n); | |
c21b99e0 | 117 | size_t GetPageCount() const; |
3c3ead1d | 118 | bool DismissExpandedPanel(); |
5c14ec26 | 119 | int GetPageNumber(wxRibbonPage* page) const; |
3c3ead1d | 120 | |
c21b99e0 VZ |
121 | void DeletePage(size_t n); |
122 | void ClearPages(); | |
123 | ||
5c14ec26 VZ |
124 | bool IsPageShown(size_t page) const; |
125 | void ShowPage(size_t page, bool show = true); | |
126 | void HidePage(size_t page) { ShowPage(page, false); } | |
127 | ||
3603e565 VZ |
128 | void ShowPanels(bool show = true); |
129 | void HidePanels() { ShowPanels(false); } | |
130 | bool ArePanelsShown() const { return m_arePanelsShown; } | |
131 | ||
3c3ead1d PC |
132 | virtual bool HasMultiplePages() const { return true; } |
133 | ||
134 | void SetWindowStyleFlag(long style); | |
135 | long GetWindowStyleFlag() const; | |
136 | virtual bool Realize(); | |
137 | ||
138 | protected: | |
139 | friend class wxRibbonPage; | |
140 | ||
cff9681b | 141 | virtual wxSize DoGetBestSize() const; |
3c3ead1d PC |
142 | wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } |
143 | wxRibbonPageTabInfo* HitTestTabs(wxPoint position, int* index = NULL); | |
144 | ||
145 | void CommonInit(long style); | |
146 | void AddPage(wxRibbonPage *page); | |
147 | void RecalculateTabSizes(); | |
148 | void RecalculateMinSize(); | |
149 | void ScrollTabBar(int npixels); | |
150 | void RefreshTabBar(); | |
151 | void RepositionPage(wxRibbonPage *page); | |
152 | ||
153 | void OnPaint(wxPaintEvent& evt); | |
154 | void OnEraseBackground(wxEraseEvent& evt); | |
155 | void DoEraseBackground(wxDC& dc); | |
156 | void OnSize(wxSizeEvent& evt); | |
157 | void OnMouseLeftDown(wxMouseEvent& evt); | |
158 | void OnMouseLeftUp(wxMouseEvent& evt); | |
159 | void OnMouseMiddleDown(wxMouseEvent& evt); | |
160 | void OnMouseMiddleUp(wxMouseEvent& evt); | |
161 | void OnMouseRightDown(wxMouseEvent& evt); | |
162 | void OnMouseRightUp(wxMouseEvent& evt); | |
163 | void OnMouseMove(wxMouseEvent& evt); | |
164 | void OnMouseLeave(wxMouseEvent& evt); | |
a65b84f4 | 165 | void OnMouseDoubleClick(wxMouseEvent& evt); |
3c3ead1d PC |
166 | void DoMouseButtonCommon(wxMouseEvent& evt, wxEventType tab_event_type); |
167 | ||
168 | wxRibbonPageTabInfoArray m_pages; | |
169 | wxRect m_tab_scroll_left_button_rect; | |
170 | wxRect m_tab_scroll_right_button_rect; | |
171 | long m_flags; | |
172 | int m_tabs_total_width_ideal; | |
173 | int m_tabs_total_width_minimum; | |
174 | int m_tab_margin_left; | |
175 | int m_tab_margin_right; | |
176 | int m_tab_height; | |
177 | int m_tab_scroll_amount; | |
178 | int m_current_page; | |
179 | int m_current_hovered_page; | |
180 | int m_tab_scroll_left_button_state; | |
181 | int m_tab_scroll_right_button_state; | |
182 | bool m_tab_scroll_buttons_shown; | |
3603e565 | 183 | bool m_arePanelsShown; |
3c3ead1d PC |
184 | |
185 | #ifndef SWIG | |
186 | DECLARE_CLASS(wxRibbonBar) | |
187 | DECLARE_EVENT_TABLE() | |
188 | #endif | |
189 | }; | |
190 | ||
191 | #ifndef SWIG | |
192 | ||
193 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, wxRibbonBarEvent); | |
194 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, wxRibbonBarEvent); | |
195 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN, wxRibbonBarEvent); | |
196 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP, wxRibbonBarEvent); | |
197 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN, wxRibbonBarEvent); | |
198 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP, wxRibbonBarEvent); | |
a65b84f4 | 199 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK, wxRibbonBarEvent); |
3c3ead1d PC |
200 | |
201 | typedef void (wxEvtHandler::*wxRibbonBarEventFunction)(wxRibbonBarEvent&); | |
202 | ||
203 | #define wxRibbonBarEventHandler(func) \ | |
204 | wxEVENT_HANDLER_CAST(wxRibbonBarEventFunction, func) | |
205 | ||
206 | #define EVT_RIBBONBAR_PAGE_CHANGED(winid, fn) \ | |
207 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, winid, wxRibbonBarEventHandler(fn)) | |
208 | #define EVT_RIBBONBAR_PAGE_CHANGING(winid, fn) \ | |
209 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, winid, wxRibbonBarEventHandler(fn)) | |
210 | #define EVT_RIBBONBAR_TAB_MIDDLE_DOWN(winid, fn) \ | |
211 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN, winid, wxRibbonBarEventHandler(fn)) | |
212 | #define EVT_RIBBONBAR_TAB_MIDDLE_UP(winid, fn) \ | |
213 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP, winid, wxRibbonBarEventHandler(fn)) | |
214 | #define EVT_RIBBONBAR_TAB_RIGHT_DOWN(winid, fn) \ | |
215 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN, winid, wxRibbonBarEventHandler(fn)) | |
216 | #define EVT_RIBBONBAR_TAB_RIGHT_UP(winid, fn) \ | |
217 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP, winid, wxRibbonBarEventHandler(fn)) | |
a65b84f4 VZ |
218 | #define EVT_RIBBONBAR_TAB_LEFT_DCLICK(winid, fn) \ |
219 | wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK, winid, wxRibbonBarEventHandler(fn)) | |
3c3ead1d PC |
220 | #else |
221 | ||
222 | // wxpython/swig event work | |
223 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED; | |
224 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING; | |
225 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN; | |
226 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP; | |
227 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN; | |
228 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP; | |
a65b84f4 | 229 | %constant wxEventType wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK; |
3c3ead1d PC |
230 | |
231 | %pythoncode { | |
232 | EVT_RIBBONBAR_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGED, 1 ) | |
233 | EVT_RIBBONBAR_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_PAGE_CHANGING, 1 ) | |
234 | EVT_RIBBONBAR_TAB_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_DOWN, 1 ) | |
235 | EVT_RIBBONBAR_TAB_MIDDLE_UP = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_TAB_MIDDLE_UP, 1 ) | |
236 | EVT_RIBBONBAR_TAB_RIGHT_DOWN = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_DOWN, 1 ) | |
237 | EVT_RIBBONBAR_TAB_RIGHT_UP = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_TAB_RIGHT_UP, 1 ) | |
a65b84f4 | 238 | EVT_RIBBONBAR_TAB_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBAR_TAB_LEFT_DCLICK, 1 ) |
3c3ead1d PC |
239 | } |
240 | #endif | |
241 | ||
242 | #endif // wxUSE_RIBBON | |
243 | ||
244 | #endif // _WX_RIBBON_BAR_H_ | |
245 |