added wxBitmapToHICON/CURSOR helper functions

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

diff --git a/include/wx/menu.h b/include/wx/menu.h
index 54d5dca36fd27294d744acd9f627fd1ef46e512f..12ed13942567a88abd5b63260071171b4b5d6872 100644 (file)
--- a/include/wx/menu.h
+++ b/include/wx/menu.h
@@ -6,13 +6,13 @@
 // 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
 


@@ -75,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


@@ -105,13 +122,15 @@ 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,
     void Insert(size_t pos,

-                int id,
+                int itemid,

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

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

     {
     {

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

     }
 
     // insert a separator
     }
 
     // insert a separator


@@ -120,14 +139,33 @@ public:
         Insert(pos, wxMenuItem::New((wxMenu *)this));
     }
 
         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,
     // insert a submenu
     void Insert(size_t pos,

-                int id,
+                int itemid,

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

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

     }
 
     // prepend an item to the menu
     }
 
     // prepend an item to the menu


@@ -136,42 +174,59 @@ public:
         Insert(0u, item);
     }
 
         Insert(0u, item);
     }
 

-    void Prepend(int id,
+    // prepend any item to the menu
+    void Prepend(int itemid,

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

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

     {
     {

-        Insert(0u, id, text, help, isCheckable);
+        Insert(0u, itemid, text, help, kind);

     }
 
     }
 

-    // insert a separator
+    // prepend a separator

     void PrependSeparator()
     {
         InsertSeparator(0u);
     }
 
     void PrependSeparator()
     {
         InsertSeparator(0u);
     }
 

-    // insert a submenu
-    void Prepend(int id,
+    // 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)
     {
                  const wxString& text,
                  wxMenu *submenu,
                  const wxString& help = wxEmptyString)
     {

-        Insert(0u, id, text, submenu, help);
+        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


@@ -185,20 +240,20 @@ public:
 
     // search
     virtual int FindItem(const wxString& item) const;
 
     // search
     virtual int FindItem(const wxString& item) const;

-    wxMenuItem* FindItem(int id, wxMenu **menu = NULL) 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
     // --------------


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


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


@@ -264,17 +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;
-
-    // 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);
-

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


@@ -302,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)

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


@@ -369,7 +453,7 @@ public:
     // 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;
+    virtual wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const;

 
     // find menu by its caption, return wxNOT_FOUND on failure
     int FindMenu(const wxString& title) const;
 
     // find menu by its caption, return wxNOT_FOUND on failure
     int FindMenu(const wxString& title) const;


@@ -383,16 +467,16 @@ 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 id, const wxString &label);
-    wxString GetLabel(int id) const;
+    void SetLabel(int itemid, const wxString &label);
+    wxString GetLabel(int itemid) const;

 
 

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

 
     // implementation helpers
 
 
     // implementation helpers
 


@@ -419,13 +503,13 @@ public:
     // 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:
 #endif // WXWIN_COMPATIBILITY
 
 protected:


@@ -434,6 +518,8 @@ protected:
 
     // the frame we are attached to (may be NULL)
     wxFrame *m_menuBarFrame;
 
     // the frame we are attached to (may be NULL)
     wxFrame *m_menuBarFrame;

+
+    DECLARE_NO_COPY_CLASS(wxMenuBarBase)

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


@@ -453,10 +539,10 @@ protected:
     #include "wx/gtk/menu.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/menu.h"
     #include "wx/gtk/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