Adding overview docs and a couple tweaks to the demo.

[wxWidgets.git] / wxPython / src / _menu.i

diff --git a/wxPython/src/_menu.i b/wxPython/src/_menu.i
index 3db6b187862d2cb582ff79d6704dea5cc62bd0a5..c19a3048623ca14d70272eba224649db959ac912 100644 (file)
--- a/wxPython/src/_menu.i
+++ b/wxPython/src/_menu.i
@@ -33,7 +33,7 @@ public:
     
     // append any kind of item (normal/check/radio/separator)
     wxMenuItem* Append(int id,
-                       const wxString& text,
+                       const wxString& text = wxPyEmptyString,
                        const wxString& help = wxPyEmptyString,
                        wxItemKind kind = wxITEM_NORMAL);
 
@@ -76,7 +76,7 @@ public:
     // insert an item before given position
     wxMenuItem* Insert(size_t pos,
                        int id,
-                       const wxString& text,
+                       const wxString& text = wxPyEmptyString,
                        const wxString& help = wxPyEmptyString,
                        wxItemKind kind = wxITEM_NORMAL);
 
@@ -104,7 +104,7 @@ public:
 
     // prepend any item to the menu
     wxMenuItem* Prepend(int id,
-                        const wxString& text,
+                        const wxString& text = wxPyEmptyString,
                         const wxString& help = wxPyEmptyString,
                         wxItemKind kind = wxITEM_NORMAL);
 
@@ -133,19 +133,38 @@ public:
     // deleting it!)
     %newobject Remove;
     wxMenuItem *Remove(int id);
-    %Rename(RemoveItem,  wxMenuItem*, Remove(wxMenuItem *item));
 
+    %feature("shadow") Remove(wxMenuItem *item) %{
+        def RemoveItem(self, item):
+            """RemoveItem(self, MenuItem item) -> MenuItem"""
+            #// The return object is always the parameter, so return that 
+            #// proxy instead of the new one
+            val = _core_.Menu_RemoveItem(self, item)
+            item.this.own(val.this.own())
+            val.this.disown()
+            return item
+    %}
+    %Rename(RemoveItem,  wxMenuItem*, Remove(wxMenuItem *item));
+    
     // delete an item from the menu (submenus are not destroyed by this
     // function, see Destroy)
     bool Delete(int id);
     %Rename(DeleteItem,  bool, Delete(wxMenuItem *item));
 
-    %pythonAppend Destroy "args[0].thisown = 0"
+    %pythonPrepend Destroy "args[0].this.own(False)"
     %extend { void Destroy() { delete self; } }
     
     // delete the item from menu and destroy it (if it's a submenu)
-    %Rename(DestroyId,  bool, Destroy(int id));
-    %Rename(DestroyItem,  bool, Destroy(wxMenuItem *item));
+    %pythonPrepend Destroy "";
+    DocDeclStrName(
+        bool , Destroy(int id),
+        "", "",
+        DestroyId);
+    
+    DocDeclStrName(
+        bool , Destroy(wxMenuItem *item),
+        "", "",
+        DestroyItem);
 
 
     // get the items
@@ -214,6 +233,17 @@ public:
     // set/get the parent of this menu
     void SetParent(wxMenu *parent);
     wxMenu *GetParent() const;
+
+    %property(EventHandler, GetEventHandler, SetEventHandler, doc="See `GetEventHandler` and `SetEventHandler`");
+    %property(HelpString, GetHelpString, SetHelpString, doc="See `GetHelpString` and `SetHelpString`");
+    %property(InvokingWindow, GetInvokingWindow, SetInvokingWindow, doc="See `GetInvokingWindow` and `SetInvokingWindow`");
+    %property(MenuBar, GetMenuBar, doc="See `GetMenuBar`");
+    %property(MenuItemCount, GetMenuItemCount, doc="See `GetMenuItemCount`");
+    %property(MenuItems, GetMenuItems, doc="See `GetMenuItems`");
+    %property(Parent, GetParent, SetParent, doc="See `GetParent` and `SetParent`");
+    %property(Style, GetStyle, doc="See `GetStyle`");
+    %property(Title, GetTitle, SetTitle, doc="See `GetTitle` and `SetTitle`");
+    
 };
 
 //---------------------------------------------------------------------------
@@ -321,6 +351,25 @@ public:
         static bool GetAutoWindowMenu() { return false; }
     }
 #endif
+
+    %pythoncode {
+        def GetMenus(self):
+            """Return a list of (menu, label) items for the menus in the MenuBar. """
+            return [(self.GetMenu(i), self.GetLabelTop(i)) 
+                    for i in range(self.GetMenuCount())]
+            
+        def SetMenus(self, items):
+            """Clear and add new menus to the MenuBar from a list of (menu, label) items. """
+            for i in range(self.GetMenuCount()-1, -1, -1):
+                self.Remove(i)
+            for m, l in items:
+                self.Append(m, l)
+    }
+    
+    %property(Frame, GetFrame, doc="See `GetFrame`");
+    %property(Menu, GetMenu, doc="See `GetMenu`");
+    %property(MenuCount, GetMenuCount, doc="See `GetMenuCount`");
+    %property(Menus, GetMenus, SetMenus, doc="See `GetMenus` and `SetMenus`");
 };
 
 //---------------------------------------------------------------------------
@@ -328,13 +377,23 @@ public:
 
 class wxMenuItem : public wxObject {
 public:
-    wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY,
+    // turn off this typemap
+    %typemap(out) wxMenuItem*;    
+
+    wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
                const wxString& text = wxPyEmptyString,
                const wxString& help = wxPyEmptyString,
                wxItemKind kind = wxITEM_NORMAL,
                wxMenu* subMenu = NULL);
     ~wxMenuItem();
 
+    // Turn it back on again
+    %typemap(out) wxMenuItem* { $result = wxPyMake_wxObject($1, $owner); }
+
+    // Make Destroy a NOP.  The destruction will be handled by SWIG.
+    %pythoncode { def Destroy(self): pass }
+
+    
     // the menu we're in
     wxMenu *GetMenu() const;
     void SetMenu(wxMenu* menu);
@@ -436,6 +495,22 @@ public:
         void ResetOwnerDrawn() {}
     }
 #endif
+
+    %property(Accel, GetAccel, SetAccel, doc="See `GetAccel` and `SetAccel`");
+    %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
+    %property(Bitmap, GetBitmap, SetBitmap, doc="See `GetBitmap` and `SetBitmap`");
+    %property(DisabledBitmap, GetDisabledBitmap, SetDisabledBitmap, doc="See `GetDisabledBitmap` and `SetDisabledBitmap`");
+    %property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
+    %property(Help, GetHelp, SetHelp, doc="See `GetHelp` and `SetHelp`");
+    %property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
+    %property(Kind, GetKind, SetKind, doc="See `GetKind` and `SetKind`");
+    %property(Label, GetLabel, doc="See `GetLabel`");
+    %property(MarginWidth, GetMarginWidth, SetMarginWidth, doc="See `GetMarginWidth` and `SetMarginWidth`");
+    %property(Menu, GetMenu, SetMenu, doc="See `GetMenu` and `SetMenu`");
+    %property(SubMenu, GetSubMenu, SetSubMenu, doc="See `GetSubMenu` and `SetSubMenu`");
+    %property(Text, GetText, SetText, doc="See `GetText` and `SetText`");
+    %property(TextColour, GetTextColour, SetTextColour, doc="See `GetTextColour` and `SetTextColour`");
+    
 };
 
 //---------------------------------------------------------------------------