Added wxRadioButton::MSWWindowProc to reset m_focusJustSet -- otherwise,

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

diff --git a/include/wx/menu.h b/include/wx/menu.h
index 440747fe17c1126339abbf460b272dae872776cf..181781b0a59c2586bcf4bc9c3aa9ace86b1e929b 100644 (file)
--- a/include/wx/menu.h
+++ b/include/wx/menu.h
@@ -16,6 +16,8 @@
     #pragma interface "menubase.h"
 #endif
 
     #pragma interface "menubase.h"
 #endif
 

+#if wxUSE_MENUS
+

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


@@ -28,12 +30,28 @@
 #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
+// ----------------------------------------------------------------------------
+
+// having callbacks in menus is a wxWin 1.6x feature which should be replaced
+// with event tables in wxWin 2.xx code - however provide it because many
+// people like it a lot by default
+#ifndef wxUSE_MENU_CALLBACK
+    #if WXWIN_COMPATIBILITY_2
+        #define wxUSE_MENU_CALLBACK 1
+    #else
+        #define wxUSE_MENU_CALLBACK 0
+    #endif // WXWIN_COMPATIBILITY_2
+#endif // !defined(wxUSE_MENU_CALLBACK)

 
 // ----------------------------------------------------------------------------
 // wxMenu
 
 // ----------------------------------------------------------------------------
 // wxMenu


@@ -57,16 +75,32 @@ public:
     // menu construction
     // -----------------
 
     // menu construction
     // -----------------
 

-    // append a separator to the menu
-    void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
-
-    // append a normal item to the menu
+    // append any kind of item (normal/check/radio/separator)

     void Append(int id,
                 const wxString& text,
                 const wxString& help = wxEmptyString,
     void Append(int id,
                 const wxString& text,
                 const wxString& help = wxEmptyString,

-                bool isCheckable = FALSE)
+                wxItemKind kind = wxITEM_NORMAL)
+    {
+        DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, kind));
+    }
+
+    // append a separator to the menu
+    void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
+
+    // append a check item
+    void AppendCheckItem(int id,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Append(id, text, help, wxITEM_CHECK);
+    }
+
+    // append a radio item
+    void AppendRadioItem(int id,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)

     {
     {

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

     }
 
     // append a submenu
     }
 
     // append a submenu


@@ -75,7 +109,8 @@ public:
                 wxMenu *submenu,
                 const wxString& help = wxEmptyString)
     {
                 wxMenu *submenu,
                 const wxString& help = wxEmptyString)
     {

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

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


@@ -88,6 +123,97 @@ 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 id,
+                const wxString& text,
+                const wxString& help = wxEmptyString,
+                wxItemKind kind = wxITEM_NORMAL)
+    {
+        Insert(pos, wxMenuItem::New((wxMenu *)this, id, 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 id,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Insert(pos, id, text, help, wxITEM_CHECK);
+    }
+
+    // insert a radio item
+    void InsertRadioItem(size_t pos,
+                         int id,
+                         const wxString& text,
+                         const wxString& help = wxEmptyString)
+    {
+        Insert(pos, id, text, help, wxITEM_RADIO);
+    }
+
+    // insert a submenu
+    void Insert(size_t pos,
+                int id,
+                const wxString& text,
+                wxMenu *submenu,
+                const wxString& help = wxEmptyString)
+    {
+        Insert(pos, wxMenuItem::New((wxMenu *)this, id, 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 id,
+                 const wxString& text,
+                 const wxString& help = wxEmptyString,
+                 wxItemKind kind = wxITEM_NORMAL)
+    {
+        Insert(0u, id, text, help, kind);
+    }
+
+    // prepend a separator
+    void PrependSeparator()
+    {
+        InsertSeparator(0u);
+    }
+
+    // prepend a check item
+    void PrependCheckItem(int id,
+                          const wxString& text,
+                          const wxString& help = wxEmptyString)
+    {
+        InsertCheckItem(0u, id, text, help);
+    }
+
+    // prepend a radio item
+    void PrependRadioItem(int id,
+                          const wxString& text,
+                          const wxString& help = wxEmptyString)
+    {
+        InsertRadioItem(0u, id, text, help);
+    }
+
+    // prepend a submenu
+    void Prepend(int id,
+                 const wxString& text,
+                 wxMenu *submenu,
+                 const wxString& help = wxEmptyString)
+    {
+        Insert(0u, id, 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!)


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

-    virtual int FindItem(const wxString& itemString) const;
+    virtual int FindItem(const wxString& item) const;

     wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const;
 
     // get/set items attributes
     wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const;
 
     // get/set items attributes


@@ -136,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; }


@@ -159,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; }
 


@@ -166,8 +296,51 @@ 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 id, 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 id, int checked = -1);
+

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

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

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


@@ -175,12 +348,15 @@ public:
         { return FindItem(itemId, itemMenu); }
 
     wxList& GetItems() const { return (wxList &)m_items; }
         { return FindItem(itemId, itemMenu); }
 
     wxList& GetItems() const { return (wxList &)m_items; }

+#endif // WXWIN_COMPATIBILITY

 
 

+#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; }

+

     wxFunction m_callback;
     wxFunction m_callback;

-#endif // WXWIN_COMPATIBILITY
+#endif // wxUSE_MENU_CALLBACK

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


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

-    // 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;
+    // associate the submenu with this menu
+    void AddSubMenu(wxMenu *submenu);

 
 

-protected:

     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
 


@@ -212,7 +385,6 @@ 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
 
 
     long           m_style;             // combination of wxMENU_XXX flags
 


@@ -262,6 +434,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;


@@ -271,13 +446,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 id, wxMenu **menu = NULL) const;
+
+    // find menu by its caption, return wxNOT_FOUND on failure
+    int FindMenu(const wxString& title) const;

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


@@ -299,11 +476,28 @@ public:
     void SetHelpString(int id, const wxString& helpString);
     wxString GetHelpString(int id) const;
 
     void SetHelpString(int id, const wxString& helpString);
     wxString GetHelpString(int id) const;
 

+    // implementation helpers
+
+    // get the frame we are attached to (may return NULL)
+    wxFrame *GetFrame() const { return m_menuBarFrame; }
+
+    // returns TRUE if we're attached to a frame
+    bool IsAttached() const { return GetFrame() != NULL; }
+
+    // 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


@@ -319,6 +513,9 @@ public:
 protected:
     // the list of all our menus
     wxMenuList m_menus;
 protected:
     // the list of all our menus
     wxMenuList m_menus;

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

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


@@ -328,14 +525,14 @@ 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(__WXPM__)
 #elif defined(__WXMAC__)
     #include "wx/mac/menu.h"
 #elif defined(__WXPM__)


@@ -345,5 +542,7 @@ protected:
 #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_