wxPython/src/_menu.i

/////////////////////////////////////////////////////////////////////////////
// Name:        _menu.i
// Purpose:     SWIG interface defs for wxMenuBar, wxMenu and wxMenuItem
//
// Author:      Robin Dunn
//
// Created:     24-June-1997
// RCS-ID:      $Id$
// Copyright:   (c) 2003 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

// Not a %module


//---------------------------------------------------------------------------
%newgroup


MustHaveApp(wxMenu);

class wxMenu : public wxEvtHandler
{
public:
    %pythonAppend wxMenu         "self._setOORInfo(self)"
    %typemap(out) wxMenu*;    // turn off this typemap

    wxMenu(const wxString& title = wxPyEmptyString, long style = 0);

    // Turn it back on again
    %typemap(out) wxMenu* { $result = wxPyMake_wxObject($1, $owner); }


    // append any kind of item (normal/check/radio/separator)
    wxMenuItem* Append(int id,
                       const wxString& text = wxPyEmptyString,
                       const wxString& help = wxPyEmptyString,
                       wxItemKind kind = wxITEM_NORMAL);

    // append a separator to the menu
    wxMenuItem* AppendSeparator();

    // append a check item
    wxMenuItem* AppendCheckItem(int id,
                                const wxString& text,
                                const wxString& help = wxPyEmptyString);

    // append a radio item
    wxMenuItem* AppendRadioItem(int id,
                                const wxString& text,
                                const wxString& help = wxPyEmptyString);
    // append a submenu
    %Rename(AppendMenu, wxMenuItem*, Append(int id,
                                           const wxString& text,
                                           wxMenu *submenu,
                                           const wxString& help = wxPyEmptyString));

    wxMenuItem* AppendSubMenu(wxMenu *submenu,
                              const wxString& text,
                              const wxString& help = wxPyEmptyString);

    %disownarg(wxMenuItem*);
    // the most generic form of Append() - append anything
    %Rename(AppendItem, wxMenuItem*, Append(wxMenuItem *item));
    // insert an item before given position
    %Rename(InsertItem, wxMenuItem*, Insert(size_t pos, wxMenuItem *item));
    // prepend an item to the menu
    %Rename(PrependItem,  wxMenuItem*, Prepend(wxMenuItem *item));
    %cleardisown(wxMenuItem*);


    // insert a break in the menu (only works when appending the items, not
    // inserting them)
    virtual void Break();

    // insert an item before given position
    wxMenuItem* Insert(size_t pos,
                       int id,
                       const wxString& text = wxPyEmptyString,
                       const wxString& help = wxPyEmptyString,
                       wxItemKind kind = wxITEM_NORMAL);

    // insert a separator
    wxMenuItem* InsertSeparator(size_t pos);

    // insert a check item
    wxMenuItem* InsertCheckItem(size_t pos,
                                int id,
                                const wxString& text,
                                const wxString& help = wxPyEmptyString);

    // insert a radio item
    wxMenuItem* InsertRadioItem(size_t pos,
                                int id,
                                const wxString& text,
                                const wxString& help = wxPyEmptyString);

    // insert a submenu
    %Rename(InsertMenu, wxMenuItem*, Insert(size_t pos,
                                         int id,
                                         const wxString& text,
                                         wxMenu *submenu,
                                         const wxString& help = wxPyEmptyString));

    // prepend any item to the menu
    wxMenuItem* Prepend(int id,
                        const wxString& text = wxPyEmptyString,
                        const wxString& help = wxPyEmptyString,
                        wxItemKind kind = wxITEM_NORMAL);

    // prepend a separator
    wxMenuItem*  PrependSeparator();

    // prepend a check item
    wxMenuItem* PrependCheckItem(int id,
                                 const wxString& text,
                                 const wxString& help = wxPyEmptyString);

    // prepend a radio item
    wxMenuItem*  PrependRadioItem(int id,
                                  const wxString& text,
                                  const wxString& help = wxPyEmptyString);

    // prepend a submenu
    %Rename(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!)
    %newobject Remove;
    wxMenuItem *Remove(int id);
    %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));

    %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)
    %pythonPrepend Destroy "";
    DocDeclStrName(
        bool , Destroy(int id),
        "", "",
        DestroyId);

    DocDeclStrName(
        bool , Destroy(wxMenuItem *item),
        "", "",
        DestroyItem);


    // get the items
    size_t GetMenuItemCount() const;
    %extend {
        PyObject* GetMenuItems() {
            wxMenuItemList& list = self->GetMenuItems();
            return wxPy_ConvertList(&list);
        }
    }

    // search
    int FindItem(const wxString& item) const;
    %Rename(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 id, bool enable);
    bool IsEnabled(int id) const;

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

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

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


    // the title
    virtual void SetTitle(const wxString& title);
    const wxString GetTitle() const;

    // event handler
    void SetEventHandler(wxEvtHandler *handler);
    wxEvtHandler *GetEventHandler() const;

    // invoking window
    void SetInvokingWindow(wxWindow *win);
    wxWindow *GetInvokingWindow() const;

    // style
    long GetStyle() const { return m_style; }


    // Updates the UI for a menu and all submenus recursively. source is the
    // object that has the update event handlers defined for it. If NULL, the
    // menu or associated window will be used.
    void UpdateUI(wxEvtHandler* source = NULL);

    // get the menu bar this menu is attached to (may be NULL, always NULL for
    // popup menus)
    wxMenuBar *GetMenuBar() const;

// TODO:  Should these be exposed?
    // 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;

    // 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`");

};

//---------------------------------------------------------------------------
%newgroup

MustHaveApp(wxMenuBar);

class wxMenuBar : public wxWindow
{
public:
    %pythonAppend wxMenuBar         "self._setOORInfo(self)"
    %typemap(out) wxMenuBar*;    // turn off this typemap

    wxMenuBar(long style = 0);

    // Turn it back on again
    %typemap(out) wxMenuBar* { $result = wxPyMake_wxObject($1, $owner); }

    // append a menu to the end of menubar, return True if ok
    virtual bool Append(wxMenu *menu, const wxString& title);

    // insert a menu before the given position into the menubar, return True
    // if inserted ok
    virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);


    // get the number of menus in the menu bar
    size_t GetMenuCount() const;

    // get the menu at given position
    wxMenu *GetMenu(size_t pos) const;

    // replace the menu at given position with another one, returns the
    // previous menu (which should be deleted by the caller)
    virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);

    // delete the menu at given position from the menu bar, return the pointer
    // to the menu (which should be  deleted by the caller)
    virtual wxMenu *Remove(size_t pos);

    // enable or disable a submenu
    virtual void EnableTop(size_t pos, bool enable);

    // is the menu enabled?
    virtual bool IsEnabledTop(size_t pos) const;

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


    // by menu and item names, returns wxNOT_FOUND if not found or id of the
    // found item
    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
    %Rename(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);


    // all these functions just use FindItem() and then call an appropriate
    // method on it
    //
    // 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;
    // TODO: bool IsEnabled() const;

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

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


    // get the frame we are attached to (may return NULL)
    wxFrame *GetFrame() const;

    // returns True if we're attached to a frame
    bool IsAttached() const;

    // associate the menubar with the frame
    virtual void Attach(wxFrame *frame);

    // called before deleting the menubar normally
    virtual void Detach();

    // update all menu item states in all menus
    virtual void UpdateMenus();

#ifdef __WXMAC__
    static void SetAutoWindowMenu( bool enable );
    static bool GetAutoWindowMenu();
#else
    %extend {
        static void SetAutoWindowMenu( bool enable ) {}
        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`");
};

//---------------------------------------------------------------------------
%newgroup

class wxMenuItem : public wxObject {
public:
    wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY,
               const wxString& text = wxPyEmptyString,
               const wxString& help = wxPyEmptyString,
               wxItemKind kind = wxITEM_NORMAL,
               wxMenu* subMenu = NULL);
    ~wxMenuItem();

    // the menu we're in
    wxMenu *GetMenu() const;
    void SetMenu(wxMenu* menu);

    // get/set id
    void SetId(int id);
    int  GetId() const;
    bool IsSeparator() const;

    // the item's text (or name)
    //
    // NB: the item's text includes the accelerators and mnemonics info (if
    //     any), i.e. it may contain '&' or '_' or "\t..." and thus is
    //     different from the item's label which only contains the text shown
    //     in the menu
    virtual void SetText(const wxString& str);
    wxString GetLabel() const;
    const wxString& GetText() const;

    // get the label from text
    static wxString GetLabelFromText(const wxString& text);

    // what kind of menu item we are
    wxItemKind GetKind() const;
    void SetKind(wxItemKind kind);

    virtual void SetCheckable(bool checkable);
    bool IsCheckable() const;

    bool IsSubMenu() const;
    void SetSubMenu(wxMenu *menu);
    wxMenu *GetSubMenu() const;

    // state
    virtual void Enable(bool enable = true);
    virtual bool IsEnabled() const;

    virtual void Check(bool check = true);
    virtual bool IsChecked() const;
    void Toggle();

    // help string (displayed in the status bar by default)
    void SetHelp(const wxString& str);
    const wxString& GetHelp() const;

    // get our accelerator or NULL (caller must delete the pointer)
    virtual wxAcceleratorEntry *GetAccel() const;

    // set the accel for this item - this may also be done indirectly with
    // SetText()
    virtual void SetAccel(wxAcceleratorEntry *accel);

    void SetBitmap(const wxBitmap& bitmap);
    const wxBitmap& GetBitmap();

    // wxOwnerDrawn methods
#ifdef __WXMSW__
    void SetFont(const wxFont& font);
    wxFont GetFont();
    void SetTextColour(const wxColour& colText);
    wxColour GetTextColour();
    void SetBackgroundColour(const wxColour& colBack);
    wxColour GetBackgroundColour();
    void SetBitmaps(const wxBitmap& bmpChecked,
                    const wxBitmap& bmpUnchecked = wxNullBitmap);

    void SetDisabledBitmap( const wxBitmap& bmpDisabled );
    const wxBitmap& GetDisabledBitmap() const;

    void SetMarginWidth(int nWidth);
    int GetMarginWidth();
    static int GetDefaultMarginWidth();
    bool IsOwnerDrawn();

    // switch on/off owner-drawing the item
    void SetOwnerDrawn(bool ownerDrawn = true);
    void ResetOwnerDrawn();
#else
    %extend {
        void SetFont(const wxFont& font) {}
        wxFont GetFont() { return wxNullFont; }
        void SetTextColour(const wxColour& colText) {}
        wxColour GetTextColour() { return wxNullColour; }
        void SetBackgroundColour(const wxColour& colBack) {}
        wxColour GetBackgroundColour() { return wxNullColour; }

        void SetBitmaps(const wxBitmap& bmpChecked,
                        const wxBitmap& bmpUnchecked = wxNullBitmap)
            { self->SetBitmap( bmpChecked ); }

        void SetDisabledBitmap( const wxBitmap& bmpDisabled ) {}
        const wxBitmap& GetDisabledBitmap() const { return wxNullBitmap; }

        void SetMarginWidth(int nWidth) {}
        int GetMarginWidth() { return 0; }
        static int GetDefaultMarginWidth() { return 0; }
        bool IsOwnerDrawn() { return false; }
        void SetOwnerDrawn(bool ownerDrawn = true) {}
        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`");

};

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: _menu.i
	3	// Purpose: SWIG interface defs for wxMenuBar, wxMenu and wxMenuItem
	4	//
	5	// Author: Robin Dunn
	6	//
	7	// Created: 24-June-1997
	8	// RCS-ID: $Id$
	9	// Copyright: (c) 2003 by Total Control Software
	10	// Licence: wxWindows license
	11	/////////////////////////////////////////////////////////////////////////////
	12
	13	// Not a %module
	14
	15
	16	//---------------------------------------------------------------------------
	17	%newgroup
	18
	19
	20	MustHaveApp(wxMenu);
	21
	22	class wxMenu : public wxEvtHandler
	23	{
	24	public:
	25	%pythonAppend wxMenu "self._setOORInfo(self)"
	26	%typemap(out) wxMenu*; // turn off this typemap
	27
	28	wxMenu(const wxString& title = wxPyEmptyString, long style = 0);
	29
	30	// Turn it back on again
	31	%typemap(out) wxMenu* { $result = wxPyMake_wxObject($1, $owner); }
	32
	33
	34	// append any kind of item (normal/check/radio/separator)
	35	wxMenuItem* Append(int id,
	36	const wxString& text = wxPyEmptyString,
	37	const wxString& help = wxPyEmptyString,
	38	wxItemKind kind = wxITEM_NORMAL);
	39
	40	// append a separator to the menu
	41	wxMenuItem* AppendSeparator();
	42
	43	// append a check item
	44	wxMenuItem* AppendCheckItem(int id,
	45	const wxString& text,
	46	const wxString& help = wxPyEmptyString);
	47
	48	// append a radio item
	49	wxMenuItem* AppendRadioItem(int id,
	50	const wxString& text,
	51	const wxString& help = wxPyEmptyString);
	52	// append a submenu
	53	%Rename(AppendMenu, wxMenuItem*, Append(int id,
	54	const wxString& text,
	55	wxMenu *submenu,
	56	const wxString& help = wxPyEmptyString));
	57
	58	wxMenuItem* AppendSubMenu(wxMenu *submenu,
	59	const wxString& text,
	60	const wxString& help = wxPyEmptyString);
	61
	62	%disownarg(wxMenuItem*);
	63	// the most generic form of Append() - append anything
	64	%Rename(AppendItem, wxMenuItem, Append(wxMenuItem item));
	65	// insert an item before given position
	66	%Rename(InsertItem, wxMenuItem, Insert(size_t pos, wxMenuItem item));
	67	// prepend an item to the menu
	68	%Rename(PrependItem, wxMenuItem, Prepend(wxMenuItem item));
	69	%cleardisown(wxMenuItem*);
	70
	71
	72	// insert a break in the menu (only works when appending the items, not
	73	// inserting them)
	74	virtual void Break();
	75
	76	// insert an item before given position
	77	wxMenuItem* Insert(size_t pos,
	78	int id,
	79	const wxString& text = wxPyEmptyString,
	80	const wxString& help = wxPyEmptyString,
	81	wxItemKind kind = wxITEM_NORMAL);
	82
	83	// insert a separator
	84	wxMenuItem* InsertSeparator(size_t pos);
	85
	86	// insert a check item
	87	wxMenuItem* InsertCheckItem(size_t pos,
	88	int id,
	89	const wxString& text,
	90	const wxString& help = wxPyEmptyString);
	91
	92	// insert a radio item
	93	wxMenuItem* InsertRadioItem(size_t pos,
	94	int id,
	95	const wxString& text,
	96	const wxString& help = wxPyEmptyString);
	97
	98	// insert a submenu
	99	%Rename(InsertMenu, wxMenuItem*, Insert(size_t pos,
	100	int id,
	101	const wxString& text,
	102	wxMenu *submenu,
	103	const wxString& help = wxPyEmptyString));
	104
	105	// prepend any item to the menu
	106	wxMenuItem* Prepend(int id,
	107	const wxString& text = wxPyEmptyString,
	108	const wxString& help = wxPyEmptyString,
	109	wxItemKind kind = wxITEM_NORMAL);
	110
	111	// prepend a separator
	112	wxMenuItem* PrependSeparator();
	113
	114	// prepend a check item
	115	wxMenuItem* PrependCheckItem(int id,
	116	const wxString& text,
	117	const wxString& help = wxPyEmptyString);
	118
	119	// prepend a radio item
	120	wxMenuItem* PrependRadioItem(int id,
	121	const wxString& text,
	122	const wxString& help = wxPyEmptyString);
	123
	124	// prepend a submenu
	125	%Rename(PrependMenu, wxMenuItem*, Prepend(int id,
	126	const wxString& text,
	127	wxMenu *submenu,
	128	const wxString& help = wxPyEmptyString));
	129
	130
	131	// detach an item from the menu, but don't delete it so that it can be
	132	// added back later (but if it's not, the caller is responsible for
	133	// deleting it!)
	134	%newobject Remove;
	135	wxMenuItem *Remove(int id);
	136	%Rename(RemoveItem, wxMenuItem, Remove(wxMenuItem item));
	137
	138	// delete an item from the menu (submenus are not destroyed by this
	139	// function, see Destroy)
	140	bool Delete(int id);
	141	%Rename(DeleteItem, bool, Delete(wxMenuItem *item));
	142
	143	%pythonPrepend Destroy "args[0].this.own(False)"
	144	%extend { void Destroy() { delete self; } }
	145
	146	// delete the item from menu and destroy it (if it's a submenu)
	147	%pythonPrepend Destroy "";
	148	DocDeclStrName(
	149	bool , Destroy(int id),
	150	"", "",
	151	DestroyId);
	152
	153	DocDeclStrName(
	154	bool , Destroy(wxMenuItem *item),
	155	"", "",
	156	DestroyItem);
	157
	158
	159	// get the items
	160	size_t GetMenuItemCount() const;
	161	%extend {
	162	PyObject* GetMenuItems() {
	163	wxMenuItemList& list = self->GetMenuItems();
	164	return wxPy_ConvertList(&list);
	165	}
	166	}
	167
	168	// search
	169	int FindItem(const wxString& item) const;
	170	%Rename(FindItemById, wxMenuItem, FindItem(int id /, wxMenu *menu = NULL/) const);
	171
	172	// find by position
	173	wxMenuItem* FindItemByPosition(size_t position) const;
	174
	175	// get/set items attributes
	176	void Enable(int id, bool enable);
	177	bool IsEnabled(int id) const;
	178
	179	void Check(int id, bool check);
	180	bool IsChecked(int id) const;
	181
	182	void SetLabel(int id, const wxString& label);
	183	wxString GetLabel(int id) const;
	184
	185	virtual void SetHelpString(int id, const wxString& helpString);
	186	virtual wxString GetHelpString(int id) const;
	187
	188
	189	// the title
	190	virtual void SetTitle(const wxString& title);
	191	const wxString GetTitle() const;
	192
	193	// event handler
	194	void SetEventHandler(wxEvtHandler *handler);
	195	wxEvtHandler *GetEventHandler() const;
	196
	197	// invoking window
	198	void SetInvokingWindow(wxWindow *win);
	199	wxWindow *GetInvokingWindow() const;
	200
	201	// style
	202	long GetStyle() const { return m_style; }
	203
	204
	205	// Updates the UI for a menu and all submenus recursively. source is the
	206	// object that has the update event handlers defined for it. If NULL, the
	207	// menu or associated window will be used.
	208	void UpdateUI(wxEvtHandler* source = NULL);
	209
	210	// get the menu bar this menu is attached to (may be NULL, always NULL for
	211	// popup menus)
	212	wxMenuBar *GetMenuBar() const;
	213
	214	// TODO: Should these be exposed?
	215	// called when the menu is attached/detached to/from a menu bar
	216	virtual void Attach(wxMenuBarBase *menubar);
	217	virtual void Detach();
	218
	219	// is the menu attached to a menu bar (or is it a popup one)?
	220	bool IsAttached() const;
	221
	222	// set/get the parent of this menu
	223	void SetParent(wxMenu *parent);
	224	wxMenu *GetParent() const;
	225
	226	%property(EventHandler, GetEventHandler, SetEventHandler, doc="See `GetEventHandler` and `SetEventHandler`");
	227	%property(HelpString, GetHelpString, SetHelpString, doc="See `GetHelpString` and `SetHelpString`");
	228	%property(InvokingWindow, GetInvokingWindow, SetInvokingWindow, doc="See `GetInvokingWindow` and `SetInvokingWindow`");
	229	%property(MenuBar, GetMenuBar, doc="See `GetMenuBar`");
	230	%property(MenuItemCount, GetMenuItemCount, doc="See `GetMenuItemCount`");
	231	%property(MenuItems, GetMenuItems, doc="See `GetMenuItems`");
	232	%property(Parent, GetParent, SetParent, doc="See `GetParent` and `SetParent`");
	233	%property(Style, GetStyle, doc="See `GetStyle`");
	234	%property(Title, GetTitle, SetTitle, doc="See `GetTitle` and `SetTitle`");
	235
	236	};
	237
	238	//---------------------------------------------------------------------------
	239	%newgroup
	240
	241	MustHaveApp(wxMenuBar);
	242
	243	class wxMenuBar : public wxWindow
	244	{
	245	public:
	246	%pythonAppend wxMenuBar "self._setOORInfo(self)"
	247	%typemap(out) wxMenuBar*; // turn off this typemap
	248
	249	wxMenuBar(long style = 0);
	250
	251	// Turn it back on again
	252	%typemap(out) wxMenuBar* { $result = wxPyMake_wxObject($1, $owner); }
	253
	254	// append a menu to the end of menubar, return True if ok
	255	virtual bool Append(wxMenu *menu, const wxString& title);
	256
	257	// insert a menu before the given position into the menubar, return True
	258	// if inserted ok
	259	virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
	260
	261
	262	// get the number of menus in the menu bar
	263	size_t GetMenuCount() const;
	264
	265	// get the menu at given position
	266	wxMenu *GetMenu(size_t pos) const;
	267
	268	// replace the menu at given position with another one, returns the
	269	// previous menu (which should be deleted by the caller)
	270	virtual wxMenu Replace(size_t pos, wxMenu menu, const wxString& title);
	271
	272	// delete the menu at given position from the menu bar, return the pointer
	273	// to the menu (which should be deleted by the caller)
	274	virtual wxMenu *Remove(size_t pos);
	275
	276	// enable or disable a submenu
	277	virtual void EnableTop(size_t pos, bool enable);
	278
	279	// is the menu enabled?
	280	virtual bool IsEnabledTop(size_t pos) const;
	281
	282	// get or change the label of the menu at given position
	283	virtual void SetLabelTop(size_t pos, const wxString& label);
	284	virtual wxString GetLabelTop(size_t pos) const;
	285
	286
	287	// by menu and item names, returns wxNOT_FOUND if not found or id of the
	288	// found item
	289	virtual int FindMenuItem(const wxString& menu, const wxString& item) const;
	290
	291	// find item by id (in any menu), returns NULL if not found
	292	//
	293	// if menu is !NULL, it will be filled with wxMenu this item belongs to
	294	%Rename(FindItemById, virtual wxMenuItem, FindItem(int id /, wxMenu *menu = NULL/) const);
	295
	296	// find menu by its caption, return wxNOT_FOUND on failure
	297	int FindMenu(const wxString& title);
	298
	299
	300	// all these functions just use FindItem() and then call an appropriate
	301	// method on it
	302	//
	303	// NB: under MSW, these methods can only be used after the menubar had
	304	// been attached to the frame
	305
	306	void Enable(int id, bool enable);
	307	void Check(int id, bool check);
	308	bool IsChecked(int id) const;
	309	bool IsEnabled(int id) const;
	310	// TODO: bool IsEnabled() const;
	311
	312	void SetLabel(int id, const wxString &label);
	313	wxString GetLabel(int id) const;
	314
	315	void SetHelpString(int id, const wxString& helpString);
	316	wxString GetHelpString(int id) const;
	317
	318
	319	// get the frame we are attached to (may return NULL)
	320	wxFrame *GetFrame() const;
	321
	322	// returns True if we're attached to a frame
	323	bool IsAttached() const;
	324
	325	// associate the menubar with the frame
	326	virtual void Attach(wxFrame *frame);
	327
	328	// called before deleting the menubar normally
	329	virtual void Detach();
	330
	331	// update all menu item states in all menus
	332	virtual void UpdateMenus();
	333
	334	#ifdef __WXMAC__
	335	static void SetAutoWindowMenu( bool enable );
	336	static bool GetAutoWindowMenu();
	337	#else
	338	%extend {
	339	static void SetAutoWindowMenu( bool enable ) {}
	340	static bool GetAutoWindowMenu() { return false; }
	341	}
	342	#endif
	343
	344	%pythoncode {
	345	def GetMenus(self):
	346	"""Return a list of (menu, label) items for the menus in the MenuBar. """
	347	return [(self.GetMenu(i), self.GetLabelTop(i))
	348	for i in range(self.GetMenuCount())]
	349
	350	def SetMenus(self, items):
	351	"""Clear and add new menus to the MenuBar from a list of (menu, label) items. """
	352	for i in range(self.GetMenuCount()-1, -1, -1):
	353	self.Remove(i)
	354	for m, l in items:
	355	self.Append(m, l)
	356	}
	357
	358	%property(Frame, GetFrame, doc="See `GetFrame`");
	359	%property(Menu, GetMenu, doc="See `GetMenu`");
	360	%property(MenuCount, GetMenuCount, doc="See `GetMenuCount`");
	361	%property(Menus, GetMenus, SetMenus, doc="See `GetMenus` and `SetMenus`");
	362	};
	363
	364	//---------------------------------------------------------------------------
	365	%newgroup
	366
	367	class wxMenuItem : public wxObject {
	368	public:
	369	wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY,
	370	const wxString& text = wxPyEmptyString,
	371	const wxString& help = wxPyEmptyString,
	372	wxItemKind kind = wxITEM_NORMAL,
	373	wxMenu* subMenu = NULL);
	374	~wxMenuItem();
	375
	376	// the menu we're in
	377	wxMenu *GetMenu() const;
	378	void SetMenu(wxMenu* menu);
	379
	380	// get/set id
	381	void SetId(int id);
	382	int GetId() const;
	383	bool IsSeparator() const;
	384
	385	// the item's text (or name)
	386	//
	387	// NB: the item's text includes the accelerators and mnemonics info (if
	388	// any), i.e. it may contain '&' or '_' or "\t..." and thus is
	389	// different from the item's label which only contains the text shown
	390	// in the menu
	391	virtual void SetText(const wxString& str);
	392	wxString GetLabel() const;
	393	const wxString& GetText() const;
	394
	395	// get the label from text
	396	static wxString GetLabelFromText(const wxString& text);
	397
	398	// what kind of menu item we are
	399	wxItemKind GetKind() const;
	400	void SetKind(wxItemKind kind);
	401
	402	virtual void SetCheckable(bool checkable);
	403	bool IsCheckable() const;
	404
	405	bool IsSubMenu() const;
	406	void SetSubMenu(wxMenu *menu);
	407	wxMenu *GetSubMenu() const;
	408
	409	// state
	410	virtual void Enable(bool enable = true);
	411	virtual bool IsEnabled() const;
	412
	413	virtual void Check(bool check = true);
	414	virtual bool IsChecked() const;
	415	void Toggle();
	416
	417	// help string (displayed in the status bar by default)
	418	void SetHelp(const wxString& str);
	419	const wxString& GetHelp() const;
	420
	421	// get our accelerator or NULL (caller must delete the pointer)
	422	virtual wxAcceleratorEntry *GetAccel() const;
	423
	424	// set the accel for this item - this may also be done indirectly with
	425	// SetText()
	426	virtual void SetAccel(wxAcceleratorEntry *accel);
	427
	428	void SetBitmap(const wxBitmap& bitmap);
	429	const wxBitmap& GetBitmap();
	430
	431	// wxOwnerDrawn methods
	432	#ifdef __WXMSW__
	433	void SetFont(const wxFont& font);
	434	wxFont GetFont();
	435	void SetTextColour(const wxColour& colText);
	436	wxColour GetTextColour();
	437	void SetBackgroundColour(const wxColour& colBack);
	438	wxColour GetBackgroundColour();
	439	void SetBitmaps(const wxBitmap& bmpChecked,
	440	const wxBitmap& bmpUnchecked = wxNullBitmap);
	441
	442	void SetDisabledBitmap( const wxBitmap& bmpDisabled );
	443	const wxBitmap& GetDisabledBitmap() const;
	444
	445	void SetMarginWidth(int nWidth);
	446	int GetMarginWidth();
	447	static int GetDefaultMarginWidth();
	448	bool IsOwnerDrawn();
	449
	450	// switch on/off owner-drawing the item
	451	void SetOwnerDrawn(bool ownerDrawn = true);
	452	void ResetOwnerDrawn();
	453	#else
	454	%extend {
	455	void SetFont(const wxFont& font) {}
	456	wxFont GetFont() { return wxNullFont; }
	457	void SetTextColour(const wxColour& colText) {}
	458	wxColour GetTextColour() { return wxNullColour; }
	459	void SetBackgroundColour(const wxColour& colBack) {}
	460	wxColour GetBackgroundColour() { return wxNullColour; }
	461
	462	void SetBitmaps(const wxBitmap& bmpChecked,
	463	const wxBitmap& bmpUnchecked = wxNullBitmap)
	464	{ self->SetBitmap( bmpChecked ); }
	465
	466	void SetDisabledBitmap( const wxBitmap& bmpDisabled ) {}
	467	const wxBitmap& GetDisabledBitmap() const { return wxNullBitmap; }
	468
	469	void SetMarginWidth(int nWidth) {}
	470	int GetMarginWidth() { return 0; }
	471	static int GetDefaultMarginWidth() { return 0; }
	472	bool IsOwnerDrawn() { return false; }
	473	void SetOwnerDrawn(bool ownerDrawn = true) {}
	474	void ResetOwnerDrawn() {}
	475	}
	476	#endif
	477
	478	%property(Accel, GetAccel, SetAccel, doc="See `GetAccel` and `SetAccel`");
	479	%property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
	480	%property(Bitmap, GetBitmap, SetBitmap, doc="See `GetBitmap` and `SetBitmap`");
	481	%property(DisabledBitmap, GetDisabledBitmap, SetDisabledBitmap, doc="See `GetDisabledBitmap` and `SetDisabledBitmap`");
	482	%property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
	483	%property(Help, GetHelp, SetHelp, doc="See `GetHelp` and `SetHelp`");
	484	%property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
	485	%property(Kind, GetKind, SetKind, doc="See `GetKind` and `SetKind`");
	486	%property(Label, GetLabel, doc="See `GetLabel`");
	487	%property(MarginWidth, GetMarginWidth, SetMarginWidth, doc="See `GetMarginWidth` and `SetMarginWidth`");
	488	%property(Menu, GetMenu, SetMenu, doc="See `GetMenu` and `SetMenu`");
	489	%property(SubMenu, GetSubMenu, SetSubMenu, doc="See `GetSubMenu` and `SetSubMenu`");
	490	%property(Text, GetText, SetText, doc="See `GetText` and `SetText`");
	491	%property(TextColour, GetTextColour, SetTextColour, doc="See `GetTextColour` and `SetTextColour`");
	492
	493	};
	494
	495	//---------------------------------------------------------------------------
	496	//---------------------------------------------------------------------------