1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxMenu, wxMenuBar classes
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "menu.h"
21 #include "wx/dynarray.h"
22 #include "wx/string.h"
28 class WXDLLEXPORT wxMenuItem
;
29 class WXDLLEXPORT wxMenuBar
;
30 class WXDLLEXPORT wxMenu
;
31 class WXDLLEXPORT wxFrame
;
33 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
35 WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry
*, wxAcceleratorArray
);
37 // ----------------------------------------------------------------------------
39 // ----------------------------------------------------------------------------
41 class WXDLLEXPORT wxMenu
: public wxEvtHandler
43 DECLARE_DYNAMIC_CLASS(wxMenu
)
47 wxMenu(const wxString
& title
,
48 const wxFunction func
)
53 wxMenu( long WXUNUSED(style
) )
55 Init( wxEmptyString
);
58 wxMenu(const wxString
& title
= wxEmptyString
, long WXUNUSED(style
) = 0)
66 // append a separator to the menu
67 void AppendSeparator();
68 // append a normal item to the menu
69 void Append(int id
, const wxString
& label
,
70 const wxString
& helpString
= wxEmptyString
,
71 bool checkable
= FALSE
);
73 void Append(int id
, const wxString
& label
,
75 const wxString
& helpString
= wxEmptyString
);
76 // append anything (create wxMenuItem first)
77 void Append(wxMenuItem
*pItem
);
79 // insert a break in the menu
83 // If it's a submenu, menu is not destroyed.
84 // VZ: why? shouldn't it return "wxMenu *" then?
88 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
89 void* GetClientData() const { return m_clientData
; }
92 // enable/disable item
93 void Enable(int id
, bool enable
);
95 bool IsEnabled(int id
) const;
97 // check/uncheck item - only for checkable items, of course
98 void Check(int id
, bool check
);
100 bool IsChecked(int id
) const;
104 void SetTitle(const wxString
& label
);
105 const wxString
GetTitle() const;
107 void SetLabel(int id
, const wxString
& label
);
108 wxString
GetLabel(int id
) const;
110 virtual void SetHelpString(int id
, const wxString
& helpString
);
111 virtual wxString
GetHelpString(int id
) const;
113 // get the list of items
114 wxList
& GetItems() const { return (wxList
&)m_menuItems
; }
117 // returns id of the item matching the given string or wxNOT_FOUND
118 virtual int FindItem(const wxString
& itemString
) const;
119 // returns NULL if not found
120 wxMenuItem
* FindItem(int id
) const { return FindItemForId(id
); }
121 // find wxMenuItem by ID, and item's menu too if itemMenu is !NULL
122 wxMenuItem
*FindItemForId(int itemId
, wxMenu
**itemMenu
= NULL
) const;
124 // Updates the UI for a menu and all submenus recursively. source is the
125 // object that has the update event handlers defined for it. If NULL, the
126 // menu or associated window will be used.
127 void UpdateUI(wxEvtHandler
* source
= (wxEvtHandler
*)NULL
);
129 bool ProcessCommand(wxCommandEvent
& event
);
131 void SetEventHandler(wxEvtHandler
*handler
) { m_eventHandler
= handler
; }
132 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
135 bool MSWCommand(WXUINT param
, WXWORD id
);
137 void SetInvokingWindow(wxWindow
*pWin
) { m_pInvokingWindow
= pWin
; }
138 wxWindow
*GetInvokingWindow() const { return m_pInvokingWindow
; }
140 // semi-private accessors
141 // get the window which contains this menu
142 wxWindow
*GetWindow() const;
143 // get the menu handle
144 WXHMENU
GetHMenu() const;
146 // only for wxMenuBar
147 void Attach(wxMenuBar
*menubar
);
151 size_t GetAccelCount() const { return m_accels
.GetCount(); }
152 size_t CopyAccels(wxAcceleratorEntry
*accels
) const;
153 #endif // wxUSE_ACCEL
155 wxFunction
GetCallback() const { return m_callback
; }
156 void Callback(const wxFunction func
) { m_callback
= func
; }
157 wxFunction m_callback
;
159 #ifdef WXWIN_COMPATIBILITY
160 // compatibility: these functions are deprecated
161 bool Enabled(int id
) const { return IsEnabled(id
); }
162 bool Checked(int id
) const { return IsChecked(id
); }
164 #endif // WXWIN_COMPATIBILITY
167 // common part of all ctors
168 void Init(const wxString
& title
, const wxFunction func
= NULL
);
172 // This is used when m_hMenu is NULL because we don't want to
173 // delete it in ~wxMenu (it's been added to a parent menu).
174 // But we'll still need the handle for other purposes.
175 // Might be better to have a flag saying whether it's deleteable or not.
176 WXHMENU m_savehMenu
; // Used for Enable() on popup
181 wxMenu
* m_topLevelMenu
;
182 wxMenuBar
* m_menuBar
;
184 wxEvtHandler
* m_eventHandler
;
185 wxWindow
*m_pInvokingWindow
;
189 // the accelerators for our menu items
190 wxAcceleratorArray m_accels
;
191 #endif // wxUSE_ACCEL
194 // ----------------------------------------------------------------------------
195 // Menu Bar (a la Windows)
196 // ----------------------------------------------------------------------------
198 class WXDLLEXPORT wxMenuBar
: public wxMenuBarBase
202 // default constructor
205 wxMenuBar(long style
);
206 // menubar takes ownership of the menus arrays but copies the titles
207 wxMenuBar(int n
, wxMenu
*menus
[], const wxString titles
[]);
208 virtual ~wxMenuBar();
210 // menubar construction
211 virtual bool Append( wxMenu
*menu
, const wxString
&title
);
212 virtual bool Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
);
213 virtual wxMenu
*Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
);
214 virtual wxMenu
*Remove(size_t pos
);
216 virtual int FindMenuItem(const wxString
& menuString
,
217 const wxString
& itemString
) const;
218 virtual wxMenuItem
* FindItem( int id
, wxMenu
**menu
= NULL
) const;
220 virtual void EnableTop( size_t pos
, bool flag
);
221 virtual void SetLabelTop( size_t pos
, const wxString
& label
);
222 virtual wxString
GetLabelTop( size_t pos
) const;
224 // compatibility: these functions are deprecated
225 #ifdef WXWIN_COMPATIBILITY
226 void SetEventHandler(wxEvtHandler
*handler
) { m_eventHandler
= handler
; }
227 wxEvtHandler
*GetEventHandler() { return m_eventHandler
; }
229 bool Enabled(int id
) const { return IsEnabled(id
); }
230 bool Checked(int id
) const { return IsChecked(id
); }
231 #endif // WXWIN_COMPATIBILITY
233 // implementation from now on
235 int FindMenu(const wxString
& title
);
238 // returns TRUE if we're attached to a frame
239 bool IsAttached() const { return m_menuBarFrame
!= NULL
; }
240 // get the frame we live in
241 wxFrame
*GetFrame() const { return m_menuBarFrame
; }
243 void Attach(wxFrame
*frame
);
246 // get the accel table for the menus
247 const wxAcceleratorTable
& GetAccelTable() const { return m_accelTable
; }
248 #endif // wxUSE_ACCEL
250 // get the menu handle
251 WXHMENU
GetHMenu() const { return m_hMenu
; }
253 // if the menubar is modified, the display is not updated automatically,
254 // call this function to update it (m_menuBarFrame should be !NULL)
258 // common part of all ctors
261 #ifdef WXWIN_COMPATIBILITY
262 wxEvtHandler
*m_eventHandler
;
263 #endif // WXWIN_COMPATIBILITY
265 wxArrayString m_titles
;
267 wxFrame
*m_menuBarFrame
;
271 // the accelerator table for all accelerators in all our menus
272 wxAcceleratorTable m_accelTable
;
273 #endif // wxUSE_ACCEL
276 DECLARE_DYNAMIC_CLASS(wxMenuBar
)
279 #endif // _WX_MENU_H_