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,
                       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));

    // the most generic form of Append() - append anything
    %Rename(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
    %Rename(InsertItem, wxMenuItem*, Insert(size_t pos, wxMenuItem *item));

    // insert an item before given position
    wxMenuItem* Insert(size_t pos,
                       int id,
                       const wxString& text,
                       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 an item to the menu
    %Rename(PrependItem,  wxMenuItem*, Prepend(wxMenuItem *item));

    // prepend any item to the menu
    wxMenuItem* Prepend(int id,
                        const wxString& text,
                        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!)
    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));

    // delete the item from menu and destroy it (if it's a submenu)
    %extend { void Destroy() { delete self; } }
    %Rename(DestroyId,  bool, Destroy(int id));
    %Rename(DestroyItem,  bool, Destroy(wxMenuItem *item));


    // 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;
};

//---------------------------------------------------------------------------
%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 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);
    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) const;


    // 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();
};

//---------------------------------------------------------------------------
%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);

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


    // 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) {}

        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

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

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
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,
	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	// the most generic form of Append() - append anything
	59	%Rename(AppendItem, wxMenuItem, Append(wxMenuItem item));
	60
	61	// insert a break in the menu (only works when appending the items, not
	62	// inserting them)
	63	virtual void Break();
	64
	65	// insert an item before given position
	66	%Rename(InsertItem, wxMenuItem, Insert(size_t pos, wxMenuItem item));
	67
	68	// insert an item before given position
	69	wxMenuItem* Insert(size_t pos,
	70	int id,
	71	const wxString& text,
	72	const wxString& help = wxPyEmptyString,
	73	wxItemKind kind = wxITEM_NORMAL);
	74
	75	// insert a separator
	76	wxMenuItem* InsertSeparator(size_t pos);
	77
	78	// insert a check item
	79	wxMenuItem* InsertCheckItem(size_t pos,
	80	int id,
	81	const wxString& text,
	82	const wxString& help = wxPyEmptyString);
	83
	84	// insert a radio item
	85	wxMenuItem* InsertRadioItem(size_t pos,
	86	int id,
	87	const wxString& text,
	88	const wxString& help = wxPyEmptyString);
	89
	90	// insert a submenu
	91	%Rename(InsertMenu, wxMenuItem*, Insert(size_t pos,
	92	int id,
	93	const wxString& text,
	94	wxMenu *submenu,
	95	const wxString& help = wxPyEmptyString));
	96
	97	// prepend an item to the menu
	98	%Rename(PrependItem, wxMenuItem, Prepend(wxMenuItem item));
	99
	100	// prepend any item to the menu
	101	wxMenuItem* Prepend(int id,
	102	const wxString& text,
	103	const wxString& help = wxPyEmptyString,
	104	wxItemKind kind = wxITEM_NORMAL);
	105
	106	// prepend a separator
	107	wxMenuItem* PrependSeparator();
	108
	109	// prepend a check item
	110	wxMenuItem* PrependCheckItem(int id,
	111	const wxString& text,
	112	const wxString& help = wxPyEmptyString);
	113
	114	// prepend a radio item
	115	wxMenuItem* PrependRadioItem(int id,
	116	const wxString& text,
	117	const wxString& help = wxPyEmptyString);
	118
	119	// prepend a submenu
	120	%Rename(PrependMenu, wxMenuItem*, Prepend(int id,
	121	const wxString& text,
	122	wxMenu *submenu,
	123	const wxString& help = wxPyEmptyString));
	124
	125	// detach an item from the menu, but don't delete it so that it can be
	126	// added back later (but if it's not, the caller is responsible for
	127	// deleting it!)
	128	wxMenuItem *Remove(int id);
	129	%Rename(RemoveItem, wxMenuItem, Remove(wxMenuItem item));
	130
	131	// delete an item from the menu (submenus are not destroyed by this
	132	// function, see Destroy)
	133	bool Delete(int id);
	134	%Rename(DeleteItem, bool, Delete(wxMenuItem *item));
	135
	136	// delete the item from menu and destroy it (if it's a submenu)
	137	%extend { void Destroy() { delete self; } }
	138	%Rename(DestroyId, bool, Destroy(int id));
	139	%Rename(DestroyItem, bool, Destroy(wxMenuItem *item));
	140
	141
	142	// get the items
	143	size_t GetMenuItemCount() const;
	144	%extend {
	145	PyObject* GetMenuItems() {
	146	wxMenuItemList& list = self->GetMenuItems();
	147	return wxPy_ConvertList(&list);
	148	}
	149	}
	150
	151	// search
	152	int FindItem(const wxString& item) const;
	153	%Rename(FindItemById, wxMenuItem, FindItem(int id /, wxMenu *menu = NULL/) const);
	154
	155	// find by position
	156	wxMenuItem* FindItemByPosition(size_t position) const;
	157
	158	// get/set items attributes
	159	void Enable(int id, bool enable);
	160	bool IsEnabled(int id) const;
	161
	162	void Check(int id, bool check);
	163	bool IsChecked(int id) const;
	164
	165	void SetLabel(int id, const wxString& label);
	166	wxString GetLabel(int id) const;
	167
	168	virtual void SetHelpString(int id, const wxString& helpString);
	169	virtual wxString GetHelpString(int id) const;
	170
	171
	172	// the title
	173	virtual void SetTitle(const wxString& title);
	174	const wxString GetTitle() const;
	175
	176	// event handler
	177	void SetEventHandler(wxEvtHandler *handler);
	178	wxEvtHandler *GetEventHandler() const;
	179
	180	// invoking window
	181	void SetInvokingWindow(wxWindow *win);
	182	wxWindow *GetInvokingWindow() const;
	183
	184	// style
	185	long GetStyle() const { return m_style; }
	186
	187
	188	// Updates the UI for a menu and all submenus recursively. source is the
	189	// object that has the update event handlers defined for it. If NULL, the
	190	// menu or associated window will be used.
	191	void UpdateUI(wxEvtHandler* source = NULL);
	192
	193	// get the menu bar this menu is attached to (may be NULL, always NULL for
	194	// popup menus)
	195	wxMenuBar *GetMenuBar() const;
	196
	197	// TODO: Should these be exposed?
	198	// called when the menu is attached/detached to/from a menu bar
	199	virtual void Attach(wxMenuBarBase *menubar);
	200	virtual void Detach();
	201
	202	// is the menu attached to a menu bar (or is it a popup one)?
	203	bool IsAttached() const;
	204
	205	// set/get the parent of this menu
	206	void SetParent(wxMenu *parent);
	207	wxMenu *GetParent() const;
	208	};
	209
	210	//---------------------------------------------------------------------------
	211	%newgroup
	212
	213	MustHaveApp(wxMenuBar);
	214
	215	class wxMenuBar : public wxWindow
	216	{
	217	public:
	218	%pythonAppend wxMenuBar "self._setOORInfo(self)"
	219	%typemap(out) wxMenuBar*; // turn off this typemap
	220
	221	wxMenuBar(long style = 0);
	222
	223	// Turn it back on again
	224	%typemap(out) wxMenuBar* { $result = wxPyMake_wxObject($1, $owner); }
	225
	226	// append a menu to the end of menubar, return True if ok
	227	virtual bool Append(wxMenu *menu, const wxString& title);
	228
	229	// insert a menu before the given position into the menubar, return True
	230	// if inserted ok
	231	virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
	232
	233
	234	// get the number of menus in the menu bar
	235	size_t GetMenuCount() const;
	236
	237	// get the menu at given position
	238	wxMenu *GetMenu(size_t pos) const;
	239
	240	// replace the menu at given position with another one, returns the
	241	// previous menu (which should be deleted by the caller)
	242	virtual wxMenu Replace(size_t pos, wxMenu menu, const wxString& title);
	243
	244	// delete the menu at given position from the menu bar, return the pointer
	245	// to the menu (which should be deleted by the caller)
	246	virtual wxMenu *Remove(size_t pos);
	247
	248	// enable or disable a submenu
	249	virtual void EnableTop(size_t pos, bool enable);
	250
	251	// is the menu enabled?
	252	virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return true; }
	253
	254	// get or change the label of the menu at given position
	255	virtual void SetLabelTop(size_t pos, const wxString& label);
	256	virtual wxString GetLabelTop(size_t pos) const;
	257
	258
	259	// by menu and item names, returns wxNOT_FOUND if not found or id of the
	260	// found item
	261	virtual int FindMenuItem(const wxString& menu, const wxString& item) const;
	262
	263	// find item by id (in any menu), returns NULL if not found
	264	//
	265	// if menu is !NULL, it will be filled with wxMenu this item belongs to
	266	%Rename(FindItemById, virtual wxMenuItem, FindItem(int id /, wxMenu *menu = NULL/) const);
	267
	268	// find menu by its caption, return wxNOT_FOUND on failure
	269	int FindMenu(const wxString& title) const;
	270
	271
	272	// all these functions just use FindItem() and then call an appropriate
	273	// method on it
	274	//
	275	// NB: under MSW, these methods can only be used after the menubar had
	276	// been attached to the frame
	277
	278	void Enable(int id, bool enable);
	279	void Check(int id, bool check);
	280	bool IsChecked(int id) const;
	281	bool IsEnabled(int id) const;
	282	// TODO: bool IsEnabled() const;
	283
	284	void SetLabel(int id, const wxString &label);
	285	wxString GetLabel(int id) const;
	286
	287	void SetHelpString(int id, const wxString& helpString);
	288	wxString GetHelpString(int id) const;
	289
	290
	291	// get the frame we are attached to (may return NULL)
	292	wxFrame *GetFrame() const;
	293
	294	// returns True if we're attached to a frame
	295	bool IsAttached() const;
	296
	297	// associate the menubar with the frame
	298	virtual void Attach(wxFrame *frame);
	299
	300	// called before deleting the menubar normally
	301	virtual void Detach();
	302	};
	303
	304	//---------------------------------------------------------------------------
	305	%newgroup
	306
	307	class wxMenuItem : public wxObject {
	308	public:
	309	wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY,
	310	const wxString& text = wxPyEmptyString,
	311	const wxString& help = wxPyEmptyString,
	312	wxItemKind kind = wxITEM_NORMAL,
	313	wxMenu* subMenu = NULL);
	314
	315	// the menu we're in
	316	wxMenu *GetMenu() const;
	317	void SetMenu(wxMenu* menu);
	318
	319	// get/set id
	320	void SetId(int id);
	321	int GetId() const;
	322	bool IsSeparator() const;
	323
	324	// the item's text (or name)
	325	//
	326	// NB: the item's text includes the accelerators and mnemonics info (if
	327	// any), i.e. it may contain '&' or '_' or "\t..." and thus is
	328	// different from the item's label which only contains the text shown
	329	// in the menu
	330	virtual void SetText(const wxString& str);
	331	wxString GetLabel() const;
	332	const wxString& GetText() const;
	333
	334	// get the label from text
	335	static wxString GetLabelFromText(const wxString& text);
	336
	337	// what kind of menu item we are
	338	wxItemKind GetKind() const;
	339	void SetKind(wxItemKind kind);
	340
	341	virtual void SetCheckable(bool checkable);
	342	bool IsCheckable() const;
	343
	344	bool IsSubMenu() const;
	345	void SetSubMenu(wxMenu *menu);
	346	wxMenu *GetSubMenu() const;
	347
	348	// state
	349	virtual void Enable(bool enable = true);
	350	virtual bool IsEnabled() const;
	351
	352	virtual void Check(bool check = true);
	353	virtual bool IsChecked() const;
	354	void Toggle();
	355
	356	// help string (displayed in the status bar by default)
	357	void SetHelp(const wxString& str);
	358	const wxString& GetHelp() const;
	359
	360	// get our accelerator or NULL (caller must delete the pointer)
	361	virtual wxAcceleratorEntry *GetAccel() const;
	362
	363	// set the accel for this item - this may also be done indirectly with
	364	// SetText()
	365	virtual void SetAccel(wxAcceleratorEntry *accel);
	366
	367
	368	// wxOwnerDrawn methods
	369	#ifdef __WXMSW__
	370	void SetFont(const wxFont& font);
	371	wxFont GetFont();
	372	void SetTextColour(const wxColour& colText);
	373	wxColour GetTextColour();
	374	void SetBackgroundColour(const wxColour& colBack);
	375	wxColour GetBackgroundColour();
	376	void SetBitmaps(const wxBitmap& bmpChecked,
	377	const wxBitmap& bmpUnchecked = wxNullBitmap);
	378
	379	void SetDisabledBitmap( const wxBitmap& bmpDisabled );
	380	const wxBitmap& GetDisabledBitmap() const;
	381
	382	void SetMarginWidth(int nWidth);
	383	int GetMarginWidth();
	384	static int GetDefaultMarginWidth();
	385	bool IsOwnerDrawn();
	386
	387	// switch on/off owner-drawing the item
	388	void SetOwnerDrawn(bool ownerDrawn = true);
	389	void ResetOwnerDrawn();
	390	#else
	391	%extend {
	392	void SetFont(const wxFont& font) {}
	393	wxFont GetFont() { return wxNullFont; }
	394	void SetTextColour(const wxColour& colText) {}
	395	wxColour GetTextColour() { return wxNullColour; }
	396	void SetBackgroundColour(const wxColour& colBack) {}
	397	wxColour GetBackgroundColour() { return wxNullColour; }
	398	void SetBitmaps(const wxBitmap& bmpChecked,
	399	const wxBitmap& bmpUnchecked = wxNullBitmap) {}
	400
	401	void SetDisabledBitmap( const wxBitmap& bmpDisabled ) {}
	402	const wxBitmap& GetDisabledBitmap() const { return wxNullBitmap; }
	403
	404	void SetMarginWidth(int nWidth) {}
	405	int GetMarginWidth() { return 0; }
	406	static int GetDefaultMarginWidth() { return 0; }
	407	bool IsOwnerDrawn() { return false; }
	408	void SetOwnerDrawn(bool ownerDrawn = true) {}
	409	void ResetOwnerDrawn() {}
	410	}
	411	#endif
	412
	413	void SetBitmap(const wxBitmap& bitmap);
	414	const wxBitmap& GetBitmap();
	415	};
	416
	417	//---------------------------------------------------------------------------
	418	//---------------------------------------------------------------------------