create the DIBs in correct (and not down up) line order

[wxWidgets.git] / include / wx / menu.h

diff --git a/include/wx/menu.h b/include/wx/menu.h
index cf5e6b3f93ff395a533101182a1707da308349b3..12ed13942567a88abd5b63260071171b4b5d6872 100644 (file)
--- a/include/wx/menu.h
+++ b/include/wx/menu.h
@@ -6,16 +6,18 @@
 // Created:     26.10.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
 // Created:     26.10.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENU_H_BASE_
 #define _WX_MENU_H_BASE_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENU_H_BASE_
 #define _WX_MENU_H_BASE_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

     #pragma interface "menubase.h"
 #endif
 
     #pragma interface "menubase.h"
 #endif
 

+#if wxUSE_MENUS
+

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -28,12 +30,13 @@
 #include "wx/menuitem.h"
 
 class WXDLLEXPORT wxMenu;
 #include "wx/menuitem.h"
 
 class WXDLLEXPORT wxMenu;

+class WXDLLEXPORT wxMenuBarBase;

 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxMenuItem;
 
 // pseudo template list classes
 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxMenuItem;
 
 // pseudo template list classes

-WX_DECLARE_LIST(wxMenu, wxMenuList);
-WX_DECLARE_LIST(wxMenuItem, wxMenuItemList);
+WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList);
+WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList);

 
 // ----------------------------------------------------------------------------
 // conditional compilation
 
 // ----------------------------------------------------------------------------
 // conditional compilation


@@ -72,25 +75,42 @@ public:
     // menu construction
     // -----------------
 
     // menu construction
     // -----------------
 

-    // append a normal item to the menu
-    void Append(int id,
+    // append any kind of item (normal/check/radio/separator)
+    void Append(int itemid,

                 const wxString& text,
                 const wxString& help = wxEmptyString,
                 const wxString& text,
                 const wxString& help = wxEmptyString,

-                bool isCheckable = FALSE)
+                wxItemKind kind = wxITEM_NORMAL)

     {
     {

-        DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable));
+        DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));

     }
 
     // append a separator to the menu
     void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
 
     }
 
     // append a separator to the menu
     void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
 

+    // append a check item
+    void AppendCheckItem(int itemid,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Append(itemid, text, help, wxITEM_CHECK);
+    }
+
+    // append a radio item
+    void AppendRadioItem(int itemid,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Append(itemid, text, help, wxITEM_RADIO);
+    }
+

     // append a submenu
     // append a submenu

-    void Append(int id,
+    void Append(int itemid,

                 const wxString& text,
                 wxMenu *submenu,
                 const wxString& help = wxEmptyString)
     {
                 const wxString& text,
                 wxMenu *submenu,
                 const wxString& help = wxEmptyString)
     {

-        DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu));
+        DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help,
+                                 wxITEM_NORMAL, submenu));

     }
 
     // the most generic form of Append() - append anything
     }
 
     // the most generic form of Append() - append anything


@@ -103,19 +123,110 @@ public:
     // insert an item before given position
     bool Insert(size_t pos, wxMenuItem *item);
 
     // insert an item before given position
     bool Insert(size_t pos, wxMenuItem *item);
 

+    // insert an item before given position
+    void Insert(size_t pos,
+                int itemid,
+                const wxString& text,
+                const wxString& help = wxEmptyString,
+                wxItemKind kind = wxITEM_NORMAL)
+    {
+        Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
+    }
+
+    // insert a separator
+    void InsertSeparator(size_t pos)
+    {
+        Insert(pos, wxMenuItem::New((wxMenu *)this));
+    }
+
+    // insert a check item
+    void InsertCheckItem(size_t pos,
+                         int itemid,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Insert(pos, itemid, text, help, wxITEM_CHECK);
+    }
+
+    // insert a radio item
+    void InsertRadioItem(size_t pos,
+                         int itemid,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Insert(pos, itemid, text, help, wxITEM_RADIO);
+    }
+
+    // insert a submenu
+    void Insert(size_t pos,
+                int itemid,
+                const wxString& text,
+                wxMenu *submenu,
+                const wxString& help = wxEmptyString)
+    {
+        Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help,
+                                    wxITEM_NORMAL, submenu));
+    }
+
+    // prepend an item to the menu
+    void Prepend(wxMenuItem *item)
+    {
+        Insert(0u, item);
+    }
+
+    // prepend any item to the menu
+    void Prepend(int itemid,
+                 const wxString& text,
+                 const wxString& help = wxEmptyString,
+                 wxItemKind kind = wxITEM_NORMAL)
+    {
+        Insert(0u, itemid, text, help, kind);
+    }
+
+    // prepend a separator
+    void PrependSeparator()
+    {
+        InsertSeparator(0u);
+    }
+
+    // prepend a check item
+    void PrependCheckItem(int itemid,
+                          const wxString& text,
+                          const wxString& help = wxEmptyString)
+    {
+        InsertCheckItem(0u, itemid, text, help);
+    }
+
+    // prepend a radio item
+    void PrependRadioItem(int itemid,
+                          const wxString& text,
+                          const wxString& help = wxEmptyString)
+    {
+        InsertRadioItem(0u, itemid, text, help);
+    }
+
+    // prepend a submenu
+    void Prepend(int itemid,
+                 const wxString& text,
+                 wxMenu *submenu,
+                 const wxString& help = wxEmptyString)
+    {
+        Insert(0u, itemid, text, submenu, help);
+    }
+

     // detach an item from the menu, but don't delete it so that it can be
     // added back later (but if it's not, the caller is responsible for
     // deleting it!)
     // detach an item from the menu, but don't delete it so that it can be
     // added back later (but if it's not, the caller is responsible for
     // deleting it!)

-    wxMenuItem *Remove(int id) { return Remove(FindChildItem(id)); }
+    wxMenuItem *Remove(int itemid) { return Remove(FindChildItem(itemid)); }

     wxMenuItem *Remove(wxMenuItem *item);
 
     // delete an item from the menu (submenus are not destroyed by this
     // function, see Destroy)
     wxMenuItem *Remove(wxMenuItem *item);
 
     // delete an item from the menu (submenus are not destroyed by this
     // function, see Destroy)

-    bool Delete(int id) { return Delete(FindChildItem(id)); }
+    bool Delete(int itemid) { return Delete(FindChildItem(itemid)); }

     bool Delete(wxMenuItem *item);
 
     // delete the item from menu and destroy it (if it's a submenu)
     bool Delete(wxMenuItem *item);
 
     // delete the item from menu and destroy it (if it's a submenu)

-    bool Destroy(int id) { return Destroy(FindChildItem(id)); }
+    bool Destroy(int itemid) { return Destroy(FindChildItem(itemid)); }

     bool Destroy(wxMenuItem *item);
 
     // menu items access
     bool Destroy(wxMenuItem *item);
 
     // menu items access


@@ -128,21 +239,21 @@ public:
     wxMenuItemList& GetMenuItems() { return m_items; }
 
     // search
     wxMenuItemList& GetMenuItems() { return m_items; }
 
     // search

-    virtual int FindItem(const wxString& itemString) const;
-    wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const;
+    virtual int FindItem(const wxString& item) const;
+    wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const;

 
     // get/set items attributes
 
     // get/set items attributes

-    void Enable(int id, bool enable);
-    bool IsEnabled(int id) const;
+    void Enable(int itemid, bool enable);
+    bool IsEnabled(int itemid) const;

 
 

-    void Check(int id, bool check);
-    bool IsChecked(int id) const;
+    void Check(int itemid, bool check);
+    bool IsChecked(int itemid) const;

 
 

-    void SetLabel(int id, const wxString& label);
-    wxString GetLabel(int id) const;
+    void SetLabel(int itemid, const wxString& label);
+    wxString GetLabel(int itemid) const;

 
 

-    virtual void SetHelpString(int id, const wxString& helpString);
-    virtual wxString GetHelpString(int id) const;
+    virtual void SetHelpString(int itemid, const wxString& helpString);
+    virtual wxString GetHelpString(int itemid) const;

 
     // misc accessors
     // --------------
 
     // misc accessors
     // --------------


@@ -151,10 +262,6 @@ public:
     virtual void SetTitle(const wxString& title) { m_title = title; }
     const wxString GetTitle() const { return m_title; }
 
     virtual void SetTitle(const wxString& title) { m_title = title; }
     const wxString GetTitle() const { return m_title; }
 

-    // client data
-    void SetClientData(void* clientData) { m_clientData = clientData; }
-    void* GetClientData() const { return m_clientData; }
-

     // event handler
     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
     wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
     // event handler
     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
     wxEvtHandler *GetEventHandler() const { return m_eventHandler; }


@@ -174,6 +281,14 @@ public:
     // menu or associated window will be used.
     void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL);
 
     // menu or associated window will be used.
     void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL);
 

+    // get the menu bar this menu is attached to (may be NULL, always NULL for
+    // popup menus)
+    wxMenuBar *GetMenuBar() const { return m_menuBar; }
+
+    // called when the menu is attached/detached to/from a menu bar
+    virtual void Attach(wxMenuBarBase *menubar);
+    virtual void Detach();
+

     // is the menu attached to a menu bar (or is it a popup one)?
     bool IsAttached() const { return m_menuBar != NULL; }
 
     // is the menu attached to a menu bar (or is it a popup one)?
     bool IsAttached() const { return m_menuBar != NULL; }
 


@@ -181,10 +296,53 @@ public:
     void SetParent(wxMenu *parent) { m_menuParent = parent; }
     wxMenu *GetParent() const { return m_menuParent; }
 
     void SetParent(wxMenu *parent) { m_menuParent = parent; }
     wxMenu *GetParent() const { return m_menuParent; }
 

-#if WXWIN_COMPATIBILITY
+    // implementation only from now on
+    // -------------------------------
+
+    // unlike FindItem(), this function doesn't recurse but only looks through
+    // our direct children and also may return the index of the found child if
+    // pos != NULL
+    wxMenuItem *FindChildItem(int itemid, size_t *pos = NULL) const;
+
+    // called to generate a wxCommandEvent, return TRUE if it was processed,
+    // FALSE otherwise
+    //
+    // the checked parameter may have boolean value or -1 for uncheckable items
+    bool SendEvent(int itemid, int checked = -1);
+

     // compatibility: these functions are deprecated, use the new ones instead
     // compatibility: these functions are deprecated, use the new ones instead

-    bool Enabled(int id) const { return IsEnabled(id); }
-    bool Checked(int id) const { return IsChecked(id); }
+    // -----------------------------------------------------------------------
+
+    // use the versions taking wxItem_XXX now instead, they're more readable
+    // and allow adding the radio items as well
+    void Append(int itemid,
+                const wxString& text,
+                const wxString& help,
+                bool isCheckable)
+    {
+        Append(itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
+    }
+
+    void Insert(size_t pos,
+                int itemid,
+                const wxString& text,
+                const wxString& help,
+                bool isCheckable)
+    {
+        Insert(pos, itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
+    }
+
+    void Prepend(int itemid,
+                 const wxString& text,
+                 const wxString& help,
+                 bool isCheckable)
+    {
+        Insert(0u, itemid, text, help, isCheckable);
+    }
+
+#if WXWIN_COMPATIBILITY
+    bool Enabled(int itemid) const { return IsEnabled(itemid); }
+    bool Checked(int itemid) const { return IsChecked(itemid); }

 
     wxMenuItem* FindItemForId(int itemId, wxMenu **itemMenu) const
         { return FindItem(itemId, itemMenu); }
 
     wxMenuItem* FindItemForId(int itemId, wxMenu **itemMenu) const
         { return FindItem(itemId, itemMenu); }


@@ -192,7 +350,7 @@ public:
     wxList& GetItems() const { return (wxList &)m_items; }
 #endif // WXWIN_COMPATIBILITY
 
     wxList& GetItems() const { return (wxList &)m_items; }
 #endif // WXWIN_COMPATIBILITY
 

-#if wxUSE_MENU_CALLBACK
+#if wxUSE_MENU_CALLBACK || defined(__WXMOTIF__)

     // wxWin 1.6x compatible menu event handling
     wxFunction GetCallback() const { return m_callback; }
     void Callback(const wxFunction func) { m_callback = func; }
     // wxWin 1.6x compatible menu event handling
     wxFunction GetCallback() const { return m_callback; }
     void Callback(const wxFunction func) { m_callback = func; }


@@ -200,11 +358,6 @@ public:
     wxFunction m_callback;
 #endif // wxUSE_MENU_CALLBACK
 
     wxFunction m_callback;
 #endif // wxUSE_MENU_CALLBACK
 

-    // unlike FindItem(), this function doesn't recurse but only looks through
-    // our direct children and also may return the index of the found child if
-    // pos != NULL
-    wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const;
-

 protected:
     // virtuals to override in derived classes
     // ---------------------------------------
 protected:
     // virtuals to override in derived classes
     // ---------------------------------------


@@ -222,7 +375,9 @@ protected:
     // common part of all ctors
     void Init(long style);
 
     // common part of all ctors
     void Init(long style);
 

-protected:
+    // associate the submenu with this menu
+    void AddSubMenu(wxMenu *submenu);
+

     wxMenuBar     *m_menuBar;           // menubar we belong to or NULL
     wxMenu        *m_menuParent;        // parent menu or NULL
 
     wxMenuBar     *m_menuBar;           // menubar we belong to or NULL
     wxMenu        *m_menuParent;        // parent menu or NULL
 


@@ -230,11 +385,12 @@ protected:
     wxMenuItemList m_items;             // the list of menu items
 
     wxWindow      *m_invokingWindow;    // for popup menus
     wxMenuItemList m_items;             // the list of menu items
 
     wxWindow      *m_invokingWindow;    // for popup menus

-    void          *m_clientData;        // associated with the menu

 
     long           m_style;             // combination of wxMENU_XXX flags
 
     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler
 
     long           m_style;             // combination of wxMENU_XXX flags
 
     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler

+
+    DECLARE_NO_COPY_CLASS(wxMenuBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -280,6 +436,9 @@ public:
     // enable or disable a submenu
     virtual void EnableTop(size_t pos, bool enable) = 0;
 
     // enable or disable a submenu
     virtual void EnableTop(size_t pos, bool enable) = 0;
 

+    // is the menu enabled?
+    virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return TRUE; }
+

     // get or change the label of the menu at given position
     virtual void SetLabelTop(size_t pos, const wxString& label) = 0;
     virtual wxString GetLabelTop(size_t pos) const = 0;
     // get or change the label of the menu at given position
     virtual void SetLabelTop(size_t pos, const wxString& label) = 0;
     virtual wxString GetLabelTop(size_t pos) const = 0;


@@ -289,16 +448,15 @@ public:
 
     // by menu and item names, returns wxNOT_FOUND if not found or id of the
     // found item
 
     // by menu and item names, returns wxNOT_FOUND if not found or id of the
     // found item

-    virtual int FindMenuItem(const wxString& menuString,
-                             const wxString& itemString) const = 0;
+    virtual int FindMenuItem(const wxString& menu, const wxString& item) const;

 
     // find item by id (in any menu), returns NULL if not found
     //
     // if menu is !NULL, it will be filled with wxMenu this item belongs to
 
     // find item by id (in any menu), returns NULL if not found
     //
     // if menu is !NULL, it will be filled with wxMenu this item belongs to

-    virtual wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const = 0;
+    virtual wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const;

 
     // find menu by its caption, return wxNOT_FOUND on failure
 
     // find menu by its caption, return wxNOT_FOUND on failure

-    int FindMenu(const wxString& title);
+    int FindMenu(const wxString& title) const;

 
     // item access
     // -----------
 
     // item access
     // -----------


@@ -309,37 +467,59 @@ public:
     // NB: under MSW, these methods can only be used after the menubar had
     //     been attached to the frame
 
     // NB: under MSW, these methods can only be used after the menubar had
     //     been attached to the frame
 

-    void Enable(int id, bool enable);
-    void Check(int id, bool check);
-    bool IsChecked(int id) const;
-    bool IsEnabled(int id) const;
+    void Enable(int itemid, bool enable);
+    void Check(int itemid, bool check);
+    bool IsChecked(int itemid) const;
+    bool IsEnabled(int itemid) const;
+
+    void SetLabel(int itemid, const wxString &label);
+    wxString GetLabel(int itemid) const;
+
+    void SetHelpString(int itemid, const wxString& helpString);
+    wxString GetHelpString(int itemid) const;
+
+    // implementation helpers
+
+    // get the frame we are attached to (may return NULL)
+    wxFrame *GetFrame() const { return m_menuBarFrame; }

 
 

-    void SetLabel(int id, const wxString &label);
-    wxString GetLabel(int id) const;
+    // returns TRUE if we're attached to a frame
+    bool IsAttached() const { return GetFrame() != NULL; }

 
 

-    void SetHelpString(int id, const wxString& helpString);
-    wxString GetHelpString(int id) const;
+    // associate the menubar with the frame
+    virtual void Attach(wxFrame *frame);
+
+    // called before deleting the menubar normally
+    virtual void Detach();

 
     // need to override these ones to avoid virtual function hiding
     virtual bool Enable(bool enable = TRUE) { return wxWindow::Enable(enable); }
     virtual void SetLabel(const wxString& s) { wxWindow::SetLabel(s); }
     virtual wxString GetLabel() const { return wxWindow::GetLabel(); }
 
 
     // need to override these ones to avoid virtual function hiding
     virtual bool Enable(bool enable = TRUE) { return wxWindow::Enable(enable); }
     virtual void SetLabel(const wxString& s) { wxWindow::SetLabel(s); }
     virtual wxString GetLabel() const { return wxWindow::GetLabel(); }
 

+    // don't want menu bars to accept the focus by tabbing to them
+    virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
+

     // compatibility only: these functions are deprecated, use the new ones
     // instead
 #if WXWIN_COMPATIBILITY
     // compatibility only: these functions are deprecated, use the new ones
     // instead
 #if WXWIN_COMPATIBILITY

-    bool Enabled(int id) const { return IsEnabled(id); }
-    bool Checked(int id) const { return IsChecked(id); }
+    bool Enabled(int itemid) const { return IsEnabled(itemid); }
+    bool Checked(int itemid) const { return IsChecked(itemid); }

 
 

-    wxMenuItem* FindMenuItemById(int id) const
-        { return FindItem(id); }
-    wxMenuItem* FindItemForId(int id, wxMenu **menu = NULL) const
-        { return FindItem(id, menu); }
+    wxMenuItem* FindMenuItemById(int itemid) const
+        { return FindItem(itemid); }
+    wxMenuItem* FindItemForId(int itemid, wxMenu **menu = NULL) const
+        { return FindItem(itemid, menu); }

 #endif // WXWIN_COMPATIBILITY
 
 protected:
     // the list of all our menus
     wxMenuList m_menus;
 #endif // WXWIN_COMPATIBILITY
 
 protected:
     // the list of all our menus
     wxMenuList m_menus;

+
+    // the frame we are attached to (may be NULL)
+    wxFrame *m_menuBarFrame;
+
+    DECLARE_NO_COPY_CLASS(wxMenuBarBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -349,22 +529,24 @@ protected:
 #ifdef wxUSE_BASE_CLASSES_ONLY
     #define wxMenuItem wxMenuItemBase
 #else // !wxUSE_BASE_CLASSES_ONLY
 #ifdef wxUSE_BASE_CLASSES_ONLY
     #define wxMenuItem wxMenuItemBase
 #else // !wxUSE_BASE_CLASSES_ONLY

-#if defined(__WXMSW__)
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/menu.h"
+#elif defined(__WXMSW__)

     #include "wx/msw/menu.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/menu.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/menu.h"
     #include "wx/msw/menu.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/menu.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/menu.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/menu.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/menu.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/menu.h"

+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/menu.h"

 #elif defined(__WXPM__)
     #include "wx/os2/menu.h"
 #elif defined(__WXPM__)
     #include "wx/os2/menu.h"

-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/menu.h"

 #endif
 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
 
 #endif
 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
 

+#endif // wxUSE_MENUS
+

 #endif
     // _WX_MENU_H_BASE_
 #endif
     // _WX_MENU_H_BASE_