include/wx/menu.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/menu.h
   3 // Purpose:     wxMenu and wxMenuBar classes
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     26.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MENU_H_BASE_
  13 #define _WX_MENU_H_BASE_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "menubase.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/list.h"        // for "template" list classes
  24 #include "wx/window.h"      // base class for wxMenuBar
  25
  26 // also include this one to ensure compatibility with old code which only
  27 // included wx/menu.h
  28 #include "wx/menuitem.h"
  29
  30 class WXDLLEXPORT wxMenu;
  31 class WXDLLEXPORT wxMenuBar;
  32 class WXDLLEXPORT wxMenuItem;
  33
  34 // pseudo template list classes
  35 WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList);
  36 WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList);
  37
  38 // ----------------------------------------------------------------------------
  39 // conditional compilation
  40 // ----------------------------------------------------------------------------
  41
  42 // having callbacks in menus is a wxWin 1.6x feature which should be replaced
  43 // with event tables in wxWin 2.xx code - however provide it because many
  44 // people like it a lot by default
  45 #ifndef wxUSE_MENU_CALLBACK
  46     #if WXWIN_COMPATIBILITY_2
  47         #define wxUSE_MENU_CALLBACK 1
  48     #else
  49         #define wxUSE_MENU_CALLBACK 0
  50     #endif // WXWIN_COMPATIBILITY_2
  51 #endif // !defined(wxUSE_MENU_CALLBACK)
  52
  53 // ----------------------------------------------------------------------------
  54 // wxMenu
  55 // ----------------------------------------------------------------------------
  56
  57 class WXDLLEXPORT wxMenuBase : public wxEvtHandler
  58 {
  59 public:
  60     // create a menu
  61     static wxMenu *New(const wxString& title = wxEmptyString, long style = 0);
  62
  63     // ctors
  64     wxMenuBase(const wxString& title, long style = 0) : m_title(title)
  65         { Init(style); }
  66     wxMenuBase(long style = 0)
  67         { Init(style); }
  68
  69     // dtor deletes all the menu items we own
  70     virtual ~wxMenuBase();
  71
  72     // menu construction
  73     // -----------------
  74
  75     // append a normal item to the menu
  76     void Append(int id,
  77                 const wxString& text,
  78                 const wxString& help = wxEmptyString,
  79                 bool isCheckable = FALSE)
  80     {
  81         DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable));
  82     }
  83
  84     // append a separator to the menu
  85     void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
  86
  87     // append a submenu
  88     void Append(int id,
  89                 const wxString& text,
  90                 wxMenu *submenu,
  91                 const wxString& help = wxEmptyString)
  92     {
  93         DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu));
  94     }
  95
  96     // the most generic form of Append() - append anything
  97     void Append(wxMenuItem *item) { DoAppend(item); }
  98
  99     // insert a break in the menu (only works when appending the items, not
 100     // inserting them)
 101     virtual void Break() { }
 102
 103     // insert an item before given position
 104     bool Insert(size_t pos, wxMenuItem *item);
 105     void Insert(size_t pos,
 106                 int id,
 107                 const wxString& text,
 108                 const wxString& help = wxEmptyString,
 109                 bool isCheckable = FALSE)
 110     {
 111         Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable));
 112     }
 113
 114     // insert a separator
 115     void InsertSeparator(size_t pos)
 116     {
 117         Insert(pos, wxMenuItem::New((wxMenu *)this));
 118     }
 119
 120     // insert a submenu
 121     void Insert(size_t pos,
 122                 int id,
 123                 const wxString& text,
 124                 wxMenu *submenu,
 125                 const wxString& help = wxEmptyString)
 126     {
 127         Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu));
 128     }
 129
 130     // prepend an item to the menu
 131     void Prepend(wxMenuItem *item)
 132     {
 133         Insert(0u, item);
 134     }
 135
 136     void Prepend(int id,
 137                  const wxString& text,
 138                  const wxString& help = wxEmptyString,
 139                  bool isCheckable = FALSE)
 140     {
 141         Insert(0u, id, text, help, isCheckable);
 142     }
 143
 144     // insert a separator
 145     void PrependSeparator()
 146     {
 147         InsertSeparator(0u);
 148     }
 149
 150     // insert a submenu
 151     void Prepend(int id,
 152                  const wxString& text,
 153                  wxMenu *submenu,
 154                  const wxString& help = wxEmptyString)
 155     {
 156         Insert(0u, id, text, submenu, help);
 157     }
 158
 159     // detach an item from the menu, but don't delete it so that it can be
 160     // added back later (but if it's not, the caller is responsible for
 161     // deleting it!)
 162     wxMenuItem *Remove(int id) { return Remove(FindChildItem(id)); }
 163     wxMenuItem *Remove(wxMenuItem *item);
 164
 165     // delete an item from the menu (submenus are not destroyed by this
 166     // function, see Destroy)
 167     bool Delete(int id) { return Delete(FindChildItem(id)); }
 168     bool Delete(wxMenuItem *item);
 169
 170     // delete the item from menu and destroy it (if it's a submenu)
 171     bool Destroy(int id) { return Destroy(FindChildItem(id)); }
 172     bool Destroy(wxMenuItem *item);
 173
 174     // menu items access
 175     // -----------------
 176
 177     // get the items
 178     size_t GetMenuItemCount() const { return m_items.GetCount(); }
 179
 180     const wxMenuItemList& GetMenuItems() const { return m_items; }
 181     wxMenuItemList& GetMenuItems() { return m_items; }
 182
 183     // search
 184     virtual int FindItem(const wxString& itemString) const;
 185     wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const;
 186
 187     // get/set items attributes
 188     void Enable(int id, bool enable);
 189     bool IsEnabled(int id) const;
 190
 191     void Check(int id, bool check);
 192     bool IsChecked(int id) const;
 193
 194     void SetLabel(int id, const wxString& label);
 195     wxString GetLabel(int id) const;
 196
 197     virtual void SetHelpString(int id, const wxString& helpString);
 198     virtual wxString GetHelpString(int id) const;
 199
 200     // misc accessors
 201     // --------------
 202
 203     // the title
 204     virtual void SetTitle(const wxString& title) { m_title = title; }
 205     const wxString GetTitle() const { return m_title; }
 206
 207     // client data
 208     void SetClientData(void* clientData) { m_clientData = clientData; }
 209     void* GetClientData() const { return m_clientData; }
 210
 211     // event handler
 212     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 213     wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
 214
 215     // invoking window
 216     void SetInvokingWindow(wxWindow *win) { m_invokingWindow = win; }
 217     wxWindow *GetInvokingWindow() const { return m_invokingWindow; }
 218
 219     // style
 220     long GetStyle() const { return m_style; }
 221
 222     // implementation helpers
 223     // ----------------------
 224
 225     // Updates the UI for a menu and all submenus recursively. source is the
 226     // object that has the update event handlers defined for it. If NULL, the
 227     // menu or associated window will be used.
 228     void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL);
 229
 230     // is the menu attached to a menu bar (or is it a popup one)?
 231     bool IsAttached() const { return m_menuBar != NULL; }
 232
 233     // set/get the parent of this menu
 234     void SetParent(wxMenu *parent) { m_menuParent = parent; }
 235     wxMenu *GetParent() const { return m_menuParent; }
 236
 237 #if WXWIN_COMPATIBILITY
 238     // compatibility: these functions are deprecated, use the new ones instead
 239     bool Enabled(int id) const { return IsEnabled(id); }
 240     bool Checked(int id) const { return IsChecked(id); }
 241
 242     wxMenuItem* FindItemForId(int itemId, wxMenu **itemMenu) const
 243         { return FindItem(itemId, itemMenu); }
 244
 245     wxList& GetItems() const { return (wxList &)m_items; }
 246 #endif // WXWIN_COMPATIBILITY
 247
 248 #if wxUSE_MENU_CALLBACK
 249     // wxWin 1.6x compatible menu event handling
 250     wxFunction GetCallback() const { return m_callback; }
 251     void Callback(const wxFunction func) { m_callback = func; }
 252
 253     wxFunction m_callback;
 254 #endif // wxUSE_MENU_CALLBACK
 255
 256     // unlike FindItem(), this function doesn't recurse but only looks through
 257     // our direct children and also may return the index of the found child if
 258     // pos != NULL
 259     wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const;
 260
 261 protected:
 262     // virtuals to override in derived classes
 263     // ---------------------------------------
 264
 265     virtual bool DoAppend(wxMenuItem *item);
 266     virtual bool DoInsert(size_t pos, wxMenuItem *item);
 267
 268     virtual wxMenuItem *DoRemove(wxMenuItem *item);
 269     virtual bool DoDelete(wxMenuItem *item);
 270     virtual bool DoDestroy(wxMenuItem *item);
 271
 272     // helpers
 273     // -------
 274
 275     // common part of all ctors
 276     void Init(long style);
 277
 278 protected:
 279     wxMenuBar     *m_menuBar;           // menubar we belong to or NULL
 280     wxMenu        *m_menuParent;        // parent menu or NULL
 281
 282     wxString       m_title;             // the menu title or label
 283     wxMenuItemList m_items;             // the list of menu items
 284
 285     wxWindow      *m_invokingWindow;    // for popup menus
 286     void          *m_clientData;        // associated with the menu
 287
 288     long           m_style;             // combination of wxMENU_XXX flags
 289
 290     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler
 291 };
 292
 293 // ----------------------------------------------------------------------------
 294 // wxMenuBar
 295 // ----------------------------------------------------------------------------
 296
 297 class WXDLLEXPORT wxMenuBarBase : public wxWindow
 298 {
 299 public:
 300     // default ctor
 301     wxMenuBarBase();
 302
 303     // dtor will delete all menus we own
 304     virtual ~wxMenuBarBase();
 305
 306     // menu bar construction
 307     // ---------------------
 308
 309     // append a menu to the end of menubar, return TRUE if ok
 310     virtual bool Append(wxMenu *menu, const wxString& title);
 311
 312     // insert a menu before the given position into the menubar, return TRUE
 313     // if inserted ok
 314     virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 315
 316     // menu bar items access
 317     // ---------------------
 318
 319     // get the number of menus in the menu bar
 320     size_t GetMenuCount() const { return m_menus.GetCount(); }
 321
 322     // get the menu at given position
 323     wxMenu *GetMenu(size_t pos) const;
 324
 325     // replace the menu at given position with another one, returns the
 326     // previous menu (which should be deleted by the caller)
 327     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
 328
 329     // delete the menu at given position from the menu bar, return the pointer
 330     // to the menu (which should be  deleted by the caller)
 331     virtual wxMenu *Remove(size_t pos);
 332
 333     // enable or disable a submenu
 334     virtual void EnableTop(size_t pos, bool enable) = 0;
 335
 336     // get or change the label of the menu at given position
 337     virtual void SetLabelTop(size_t pos, const wxString& label) = 0;
 338     virtual wxString GetLabelTop(size_t pos) const = 0;
 339
 340     // item search
 341     // -----------
 342
 343     // by menu and item names, returns wxNOT_FOUND if not found or id of the
 344     // found item
 345     virtual int FindMenuItem(const wxString& menuString,
 346                              const wxString& itemString) const = 0;
 347
 348     // find item by id (in any menu), returns NULL if not found
 349     //
 350     // if menu is !NULL, it will be filled with wxMenu this item belongs to
 351     virtual wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const = 0;
 352
 353     // find menu by its caption, return wxNOT_FOUND on failure
 354     int FindMenu(const wxString& title) const;
 355
 356     // item access
 357     // -----------
 358
 359     // all these functions just use FindItem() and then call an appropriate
 360     // method on it
 361     //
 362     // NB: under MSW, these methods can only be used after the menubar had
 363     //     been attached to the frame
 364
 365     void Enable(int id, bool enable);
 366     void Check(int id, bool check);
 367     bool IsChecked(int id) const;
 368     bool IsEnabled(int id) const;
 369
 370     void SetLabel(int id, const wxString &label);
 371     wxString GetLabel(int id) const;
 372
 373     void SetHelpString(int id, const wxString& helpString);
 374     wxString GetHelpString(int id) const;
 375
 376     // need to override these ones to avoid virtual function hiding
 377     virtual bool Enable(bool enable = TRUE) { return wxWindow::Enable(enable); }
 378     virtual void SetLabel(const wxString& s) { wxWindow::SetLabel(s); }
 379     virtual wxString GetLabel() const { return wxWindow::GetLabel(); }
 380
 381     // compatibility only: these functions are deprecated, use the new ones
 382     // instead
 383 #if WXWIN_COMPATIBILITY
 384     bool Enabled(int id) const { return IsEnabled(id); }
 385     bool Checked(int id) const { return IsChecked(id); }
 386
 387     wxMenuItem* FindMenuItemById(int id) const
 388         { return FindItem(id); }
 389     wxMenuItem* FindItemForId(int id, wxMenu **menu = NULL) const
 390         { return FindItem(id, menu); }
 391 #endif // WXWIN_COMPATIBILITY
 392
 393 protected:
 394     // the list of all our menus
 395     wxMenuList m_menus;
 396 };
 397
 398 // ----------------------------------------------------------------------------
 399 // include the real class declaration
 400 // ----------------------------------------------------------------------------
 401
 402 #ifdef wxUSE_BASE_CLASSES_ONLY
 403     #define wxMenuItem wxMenuItemBase
 404 #else // !wxUSE_BASE_CLASSES_ONLY
 405 #if defined(__WXMSW__)
 406     #include "wx/msw/menu.h"
 407 #elif defined(__WXMOTIF__)
 408     #include "wx/motif/menu.h"
 409 #elif defined(__WXGTK__)
 410     #include "wx/gtk/menu.h"
 411 #elif defined(__WXQT__)
 412     #include "wx/qt/menu.h"
 413 #elif defined(__WXMAC__)
 414     #include "wx/mac/menu.h"
 415 #elif defined(__WXPM__)
 416     #include "wx/os2/menu.h"
 417 #elif defined(__WXSTUBS__)
 418     #include "wx/stubs/menu.h"
 419 #endif
 420 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
 421
 422 #endif
 423     // _WX_MENU_H_BASE_