]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: menu.h | |
3 | // Purpose: wxMenu, wxMenuBar classes | |
4 | // Author: Julian Smart | |
5 | // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file) | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Julian Smart and Markus Holzem | |
9 | // Licence: wxWindows license | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_MENU_H_ | |
13 | #define _WX_MENU_H_ | |
14 | ||
15 | #ifdef __GNUG__ | |
16 | #pragma interface "menu.h" | |
17 | #endif | |
18 | ||
19 | #if wxUSE_ACCEL | |
20 | #include "wx/accel.h" | |
21 | #include "wx/dynarray.h" | |
22 | ||
23 | WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray); | |
24 | #endif // wxUSE_ACCEL | |
25 | ||
26 | class WXDLLEXPORT wxFrame; | |
27 | ||
28 | // ---------------------------------------------------------------------------- | |
29 | // Menu | |
30 | // ---------------------------------------------------------------------------- | |
31 | ||
32 | class WXDLLEXPORT wxMenu : public wxMenuBase | |
33 | { | |
34 | public: | |
35 | // ctors & dtor | |
36 | wxMenu(const wxString& title, long style = 0) | |
37 | : wxMenuBase(title, style) { Init(); } | |
38 | ||
39 | wxMenu(long style = 0) : wxMenuBase(style) { Init(); } | |
40 | ||
41 | virtual ~wxMenu(); | |
42 | ||
43 | // implement base class virtuals | |
44 | virtual bool DoAppend(wxMenuItem *item); | |
45 | virtual bool DoInsert(size_t pos, wxMenuItem *item); | |
46 | virtual wxMenuItem *DoRemove(wxMenuItem *item); | |
47 | ||
48 | virtual void Break(); | |
49 | ||
50 | virtual void SetTitle(const wxString& title); | |
51 | ||
52 | // deprecated functions | |
53 | #if wxUSE_MENU_CALLBACK | |
54 | wxMenu(const wxString& title, const wxFunction func) | |
55 | : wxMenuBase(title) | |
56 | { | |
57 | Init(); | |
58 | ||
59 | Callback(func); | |
60 | } | |
61 | #endif // wxUSE_MENU_CALLBACK | |
62 | ||
63 | // MSW-specific | |
64 | bool ProcessCommand(wxCommandEvent& event); | |
65 | ||
66 | // implementation only from now on | |
67 | // ------------------------------- | |
68 | ||
69 | bool MSWCommand(WXUINT param, WXWORD id); | |
70 | ||
71 | // semi-private accessors | |
72 | // get the window which contains this menu | |
73 | wxWindow *GetWindow() const; | |
74 | // get the menu handle | |
75 | WXHMENU GetHMenu() const { return m_hMenu; } | |
76 | ||
77 | // attach/detach menu to/from wxMenuBar | |
78 | void Attach(wxMenuBar *menubar); | |
79 | void Detach(); | |
80 | ||
81 | #if wxUSE_ACCEL | |
82 | // called by wxMenuBar to build its accel table from the accels of all menus | |
83 | bool HasAccels() const { return !m_accels.IsEmpty(); } | |
84 | size_t GetAccelCount() const { return m_accels.GetCount(); } | |
85 | size_t CopyAccels(wxAcceleratorEntry *accels) const; | |
86 | ||
87 | // called by wxMenuItem when its accels changes | |
88 | void UpdateAccel(wxMenuItem *item); | |
89 | ||
90 | // helper used by wxMenu itself (returns the index in m_accels) | |
91 | int FindAccel(int id) const; | |
92 | #endif // wxUSE_ACCEL | |
93 | ||
94 | private: | |
95 | // common part of all ctors | |
96 | void Init(); | |
97 | ||
98 | // common part of Append/Insert (behaves as Append is pos == (size_t)-1) | |
99 | bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1); | |
100 | ||
101 | // if TRUE, insert a breal before appending the next item | |
102 | bool m_doBreak; | |
103 | ||
104 | // the menu handle of this menu | |
105 | WXHMENU m_hMenu; | |
106 | ||
107 | #if wxUSE_ACCEL | |
108 | // the accelerators for our menu items | |
109 | wxAcceleratorArray m_accels; | |
110 | #endif // wxUSE_ACCEL | |
111 | ||
112 | DECLARE_DYNAMIC_CLASS(wxMenu) | |
113 | }; | |
114 | ||
115 | // ---------------------------------------------------------------------------- | |
116 | // Menu Bar (a la Windows) | |
117 | // ---------------------------------------------------------------------------- | |
118 | ||
119 | class WXDLLEXPORT wxMenuBar : public wxMenuBarBase | |
120 | { | |
121 | public: | |
122 | // ctors & dtor | |
123 | // default constructor | |
124 | wxMenuBar(); | |
125 | // unused under MSW | |
126 | wxMenuBar(long style); | |
127 | // menubar takes ownership of the menus arrays but copies the titles | |
128 | wxMenuBar(int n, wxMenu *menus[], const wxString titles[]); | |
129 | virtual ~wxMenuBar(); | |
130 | ||
131 | // menubar construction | |
132 | virtual bool Append( wxMenu *menu, const wxString &title ); | |
133 | virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title); | |
134 | virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title); | |
135 | virtual wxMenu *Remove(size_t pos); | |
136 | ||
137 | virtual int FindMenuItem(const wxString& menuString, | |
138 | const wxString& itemString) const; | |
139 | virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const; | |
140 | ||
141 | virtual void EnableTop( size_t pos, bool flag ); | |
142 | virtual void SetLabelTop( size_t pos, const wxString& label ); | |
143 | virtual wxString GetLabelTop( size_t pos ) const; | |
144 | ||
145 | // compatibility: these functions are deprecated | |
146 | #if WXWIN_COMPATIBILITY | |
147 | void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } | |
148 | wxEvtHandler *GetEventHandler() { return m_eventHandler; } | |
149 | ||
150 | bool Enabled(int id) const { return IsEnabled(id); } | |
151 | bool Checked(int id) const { return IsChecked(id); } | |
152 | #endif // WXWIN_COMPATIBILITY | |
153 | ||
154 | // implementation from now on | |
155 | WXHMENU Create(); | |
156 | int FindMenu(const wxString& title); | |
157 | void Detach(); | |
158 | ||
159 | // returns TRUE if we're attached to a frame | |
160 | bool IsAttached() const { return m_menuBarFrame != NULL; } | |
161 | // get the frame we live in | |
162 | wxFrame *GetFrame() const { return m_menuBarFrame; } | |
163 | // attach to a frame | |
164 | void Attach(wxFrame *frame); | |
165 | ||
166 | #if wxUSE_ACCEL | |
167 | // get the accel table for all the menus | |
168 | const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; } | |
169 | ||
170 | // update the accel table (must be called after adding/deletign a menu) | |
171 | void RebuildAccelTable(); | |
172 | #endif // wxUSE_ACCEL | |
173 | ||
174 | // get the menu handle | |
175 | WXHMENU GetHMenu() const { return m_hMenu; } | |
176 | ||
177 | // if the menubar is modified, the display is not updated automatically, | |
178 | // call this function to update it (m_menuBarFrame should be !NULL) | |
179 | void Refresh(); | |
180 | ||
181 | protected: | |
182 | // common part of all ctors | |
183 | void Init(); | |
184 | ||
185 | #if WXWIN_COMPATIBILITY | |
186 | wxEvtHandler *m_eventHandler; | |
187 | #endif // WXWIN_COMPATIBILITY | |
188 | ||
189 | wxArrayString m_titles; | |
190 | ||
191 | wxFrame *m_menuBarFrame; | |
192 | WXHMENU m_hMenu; | |
193 | ||
194 | #if wxUSE_ACCEL | |
195 | // the accelerator table for all accelerators in all our menus | |
196 | wxAcceleratorTable m_accelTable; | |
197 | #endif // wxUSE_ACCEL | |
198 | ||
199 | private: | |
200 | DECLARE_DYNAMIC_CLASS(wxMenuBar) | |
201 | }; | |
202 | ||
203 | #endif // _WX_MENU_H_ |