]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/_menu.i
update from herbert breunung
[wxWidgets.git] / wxPython / src / _menu.i
index 56f68e44aa555b2615f5b19f41a83d991d51c3ed..59fb4736457184d2c9e5535c082504139f3e5b9e 100644 (file)
 %newgroup
 
 
+MustHaveApp(wxMenu);
+
 class wxMenu : public wxEvtHandler
 {
 public:
-    %addtofunc wxMenu         "self._setOORInfo(self)"
+    %pythonAppend wxMenu         "self._setOORInfo(self)"
     wxMenu(const wxString& title = wxPyEmptyString, long style = 0);
 
 
     // append any kind of item (normal/check/radio/separator)
-    void Append(int itemid,
-                const wxString& text,
-                const wxString& help = wxPyEmptyString,
-                wxItemKind kind = wxITEM_NORMAL);
+    wxMenuItem* Append(int id,
+                       const wxString& text,
+                       const wxString& help = wxPyEmptyString,
+                       wxItemKind kind = wxITEM_NORMAL);
 
     // append a separator to the menu
-    void AppendSeparator();
+    wxMenuItem* AppendSeparator();
 
     // append a check item
-    void AppendCheckItem(int itemid,
-                         const wxString& text,
-                         const wxString& help = wxPyEmptyString);
+    wxMenuItem* AppendCheckItem(int id,
+                                const wxString& text,
+                                const wxString& help = wxPyEmptyString);
 
     // append a radio item
-    void AppendRadioItem(int itemid,
-                         const wxString& text,
-                         const wxString& help = wxPyEmptyString);
+    wxMenuItem* AppendRadioItem(int id,
+                                const wxString& text,
+                                const wxString& help = wxPyEmptyString);
     // append a submenu
-    %name(AppendMenu)void Append(int itemid,
-                                 const wxString& text,
-                                 wxMenu *submenu,
-                                 const wxString& help = wxPyEmptyString);
+    %name(AppendMenu) wxMenuItem* Append(int id,
+                                         const wxString& text,
+                                         wxMenu *submenu,
+                                         const wxString& help = wxPyEmptyString);
 
     // the most generic form of Append() - append anything
-    %name(AppendItem) void Append(wxMenuItem *item);
+    %name(AppendItem) wxMenuItem* Append(wxMenuItem *item);
 
     // insert a break in the menu (only works when appending the items, not
     // inserting them)
     virtual void Break();
 
     // insert an item before given position
-    %name(InsertItem) bool Insert(size_t pos, wxMenuItem *item);
+    %name(InsertItem) wxMenuItem* 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 = wxPyEmptyString,
-                wxItemKind kind = wxITEM_NORMAL);
+    wxMenuItem* Insert(size_t pos,
+                       int id,
+                       const wxString& text,
+                       const wxString& help = wxPyEmptyString,
+                       wxItemKind kind = wxITEM_NORMAL);
 
     // insert a separator
-    void InsertSeparator(size_t pos);
+    wxMenuItem* InsertSeparator(size_t pos);
 
     // insert a check item
-    void InsertCheckItem(size_t pos,
-                         int itemid,
-                         const wxString& text,
-                         const wxString& help = wxPyEmptyString);
+    wxMenuItem* InsertCheckItem(size_t pos,
+                                int id,
+                                const wxString& text,
+                                const wxString& help = wxPyEmptyString);
 
     // insert a radio item
-    void InsertRadioItem(size_t pos,
-                         int itemid,
-                         const wxString& text,
-                         const wxString& help = wxPyEmptyString);
+    wxMenuItem* InsertRadioItem(size_t pos,
+                                int id,
+                                const wxString& text,
+                                const wxString& help = wxPyEmptyString);
 
     // insert a submenu
-    %name(InsertMenu) void Insert(size_t pos,
-                                  int itemid,
-                                  const wxString& text,
-                                  wxMenu *submenu,
-                                  const wxString& help = wxPyEmptyString);
+    %name(InsertMenu) wxMenuItem* Insert(size_t pos,
+                                         int id,
+                                         const wxString& text,
+                                         wxMenu *submenu,
+                                         const wxString& help = wxPyEmptyString);
 
     // prepend an item to the menu
-    %name(PrependItem)void Prepend(wxMenuItem *item);
+    %name(PrependItem) wxMenuItem* Prepend(wxMenuItem *item);
 
     // prepend any item to the menu
-    void Prepend(int itemid,
-                 const wxString& text,
-                 const wxString& help = wxPyEmptyString,
-                 wxItemKind kind = wxITEM_NORMAL);
+    wxMenuItem* Prepend(int id,
+                        const wxString& text,
+                        const wxString& help = wxPyEmptyString,
+                        wxItemKind kind = wxITEM_NORMAL);
 
     // prepend a separator
-    void PrependSeparator();
+    wxMenuItem*  PrependSeparator();
 
     // prepend a check item
-    void PrependCheckItem(int itemid,
-                          const wxString& text,
-                          const wxString& help = wxPyEmptyString);
+    wxMenuItem* PrependCheckItem(int id,
+                                 const wxString& text,
+                                 const wxString& help = wxPyEmptyString);
 
     // prepend a radio item
-    void PrependRadioItem(int itemid,
-                          const wxString& text,
-                          const wxString& help = wxPyEmptyString);
+    wxMenuItem*  PrependRadioItem(int id,
+                                  const wxString& text,
+                                  const wxString& help = wxPyEmptyString);
 
     // prepend a submenu
-    %name(PrependMenu)void Prepend(int itemid,
-                                   const wxString& text,
-                                   wxMenu *submenu,
-                                   const wxString& help = wxPyEmptyString);
+    %name(PrependMenu) wxMenuItem* Prepend(int id,
+                                           const wxString& text,
+                                           wxMenu *submenu,
+                                           const wxString& help = wxPyEmptyString);
 
     // 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 itemid);
+    wxMenuItem *Remove(int id);
     %name(RemoveItem) wxMenuItem *Remove(wxMenuItem *item);
 
     // delete an item from the menu (submenus are not destroyed by this
     // function, see Destroy)
-    bool Delete(int itemid);
+    bool Delete(int id);
     %name(DeleteItem) bool Delete(wxMenuItem *item);
 
     // delete the item from menu and destroy it (if it's a submenu)
     %extend { void Destroy() { delete self; } }
-    %name(DestroyId) bool Destroy(int itemid);
+    %name(DestroyId) bool Destroy(int id);
     %name(DestroyItem) bool Destroy(wxMenuItem *item);
 
 
@@ -143,23 +145,23 @@ public:
 
     // search
     int FindItem(const wxString& item) const;
-    %name(FindItemById) wxMenuItem* FindItem(int itemid /*, wxMenu **menu = NULL*/) const;
+    %name(FindItemById) wxMenuItem* FindItem(int id /*, wxMenu **menu = NULL*/) const;
 
     // find by position
     wxMenuItem* FindItemByPosition(size_t position) const;
 
     // get/set items attributes
-    void Enable(int itemid, bool enable);
-    bool IsEnabled(int itemid) const;
+    void Enable(int id, bool enable);
+    bool IsEnabled(int id) const;
 
-    void Check(int itemid, bool check);
-    bool IsChecked(int itemid) const;
+    void Check(int id, bool check);
+    bool IsChecked(int id) const;
 
-    void SetLabel(int itemid, const wxString& label);
-    wxString GetLabel(int itemid) const;
+    void SetLabel(int id, const wxString& label);
+    wxString GetLabel(int id) const;
 
-    virtual void SetHelpString(int itemid, const wxString& helpString);
-    virtual wxString GetHelpString(int itemid) const;
+    virtual void SetHelpString(int id, const wxString& helpString);
+    virtual wxString GetHelpString(int id) const;
 
 
     // the title
@@ -203,10 +205,12 @@ public:
 //---------------------------------------------------------------------------
 %newgroup
 
+MustHaveApp(wxMenuBar);
+
 class wxMenuBar : public wxWindow
 {
 public:
-    %addtofunc wxMenuBar         "self._setOORInfo(self)"
+    %pythonAppend wxMenuBar         "self._setOORInfo(self)"
     wxMenuBar(long style = 0);
 
 
@@ -250,7 +254,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
-    %name(FindItemById) virtual wxMenuItem* FindItem(int itemid /*, wxMenu **menu = NULL*/) const;
+    %name(FindItemById) 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;
@@ -262,16 +266,16 @@ public:
     // NB: under MSW, these methods can only be used after the menubar had
     //     been attached to the frame
 
-    void Enable(int itemid, bool enable);
-    void Check(int itemid, bool check);
-    bool IsChecked(int itemid) const;
-    bool IsEnabled(int itemid) const;
+    void Enable(int id, bool enable);
+    void Check(int id, bool check);
+    bool IsChecked(int id) const;
+    bool IsEnabled(int id) const;
 
-    void SetLabel(int itemid, const wxString &label);
-    wxString GetLabel(int itemid) const;
+    void SetLabel(int id, const wxString &label);
+    wxString GetLabel(int id) const;
 
-    void SetHelpString(int itemid, const wxString& helpString);
-    wxString GetHelpString(int itemid) const;
+    void SetHelpString(int id, const wxString& helpString);
+    wxString GetHelpString(int id) const;
 
  
     // get the frame we are attached to (may return NULL)
@@ -292,7 +296,7 @@ public:
 
 class wxMenuItem : public wxObject {
 public:
-    wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
+    wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY,
                const wxString& text = wxPyEmptyString,
                const wxString& help = wxPyEmptyString,
                wxItemKind kind = wxITEM_NORMAL,
@@ -303,7 +307,7 @@ public:
     void SetMenu(wxMenu* menu);
 
     // get/set id
-    void SetId(int itemid);
+    void SetId(int id);
     int  GetId() const;
     bool IsSeparator() const;
 
@@ -322,6 +326,7 @@ public:
 
     // what kind of menu item we are
     wxItemKind GetKind() const;
+    void SetKind(wxItemKind kind);
 
     virtual void SetCheckable(bool checkable);
     bool IsCheckable() const;