]> git.saurik.com Git - wxWidgets.git/blame - include/wx/mac/menu.h
wxCursor(wxImage) added (Chris Elliott, patch 517439)
[wxWidgets.git] / include / wx / mac / menu.h
CommitLineData
0dbd6262
SC
1/////////////////////////////////////////////////////////////////////////////
2// Name: menu.h
3// Purpose: wxMenu, wxMenuBar classes
4// Author: AUTHOR
5// Modified by:
6// Created: ??/??/98
7// RCS-ID: $Id$
8// Copyright: (c) AUTHOR
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_MENU_H_
13#define _WX_MENU_H_
14
15#ifdef __GNUG__
16#pragma interface "menu.h"
17#endif
18
e7549107
SC
19#if wxUSE_ACCEL
20 #include "wx/accel.h"
21 #include "wx/dynarray.h"
0dbd6262 22
e7549107
SC
23 WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);
24#endif // wxUSE_ACCEL
0dbd6262 25
e7549107 26class WXDLLEXPORT wxFrame;
0dbd6262
SC
27
28// ----------------------------------------------------------------------------
29// Menu
30// ----------------------------------------------------------------------------
0dbd6262 31
e7549107
SC
32class WXDLLEXPORT wxMenu : public wxMenuBase
33{
0dbd6262 34public:
e7549107
SC
35 // ctors & dtor
36 wxMenu(const wxString& title, long style = 0)
37 : wxMenuBase(title, style) { Init(); }
519cb848 38
e7549107
SC
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 // MSW-specific
53 bool ProcessCommand(wxCommandEvent& event);
54
55#if WXWIN_COMPATIBILITY
56 wxMenu(const wxString& title, const wxFunction func)
57 : wxMenuBase(title)
58 {
59 Callback(func);
60 }
61#endif // WXWIN_COMPATIBILITY
62
63 // implementation only from now on
64 // -------------------------------
65
66 bool MacMenuSelect(wxEvtHandler* handler, long when , int macMenuId, int macMenuItemNum) ;
67 int MacGetIndexFromId( int id ) ;
68 int MacGetIndexFromItem( wxMenuItem *pItem ) ;
69 void MacEnableMenu( bool bDoEnable ) ;
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
e7549107
SC
77 short MacGetMenuId() { return m_macMenuId ; }
78#if wxUSE_ACCEL
79 // called by wxMenuBar to build its accel table from the accels of all menus
80 bool HasAccels() const { return !m_accels.IsEmpty(); }
81 size_t GetAccelCount() const { return m_accels.GetCount(); }
82 size_t CopyAccels(wxAcceleratorEntry *accels) const;
83
84 // called by wxMenuItem when its accels changes
85 void UpdateAccel(wxMenuItem *item);
86
87 // helper used by wxMenu itself (returns the index in m_accels)
88 int FindAccel(int id) const;
89#endif // wxUSE_ACCEL
90
91private:
92 // common part of all ctors
93 void Init();
94
95 // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
96 bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
97
98 // if TRUE, insert a breal before appending the next item
99 bool m_doBreak;
100
101 // the menu handle of this menu
102 WXHMENU m_hMenu;
103
104 short m_macMenuId;
105
106 static short s_macNextMenuId ;
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)
0dbd6262
SC
113};
114
115// ----------------------------------------------------------------------------
116// Menu Bar (a la Windows)
117// ----------------------------------------------------------------------------
e7549107
SC
118
119class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
0dbd6262 120{
e7549107
SC
121public:
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 // if the menubar is modified, the display is not updated automatically,
175 // call this function to update it (m_menuBarFrame should be !NULL)
176 void Refresh();
0dbd6262 177
519cb848
SC
178 void MacInstallMenuBar() ;
179 void MacMenuSelect(wxEvtHandler* handler, long when , int macMenuId, int macMenuItemNum) ;
e7549107
SC
180 static wxMenuBar* MacGetInstalledMenuBar() { return s_macInstalledMenuBar ; }
181
182protected:
183 // common part of all ctors
184 void Init();
519cb848 185
e7549107
SC
186#if WXWIN_COMPATIBILITY
187 wxEvtHandler *m_eventHandler;
188#endif // WXWIN_COMPATIBILITY
519cb848 189
e7549107
SC
190 wxArrayString m_titles;
191
e7549107
SC
192#if wxUSE_ACCEL
193 // the accelerator table for all accelerators in all our menus
194 wxAcceleratorTable m_accelTable;
195#endif // wxUSE_ACCEL
196
197private:
519cb848 198 static wxMenuBar* s_macInstalledMenuBar ;
e7549107
SC
199
200 DECLARE_DYNAMIC_CLASS(wxMenuBar)
0dbd6262
SC
201};
202
203#endif // _WX_MENU_H_