[wxWidgets.git] / 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)"
    wxMenu(const wxString& title = wxPyEmptyString, long style = 0);


    // 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
    %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) 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) 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
    %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) 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
    %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 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 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 id);
    %name(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;
    %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 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)"
    wxMenuBar(long style = 0);


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

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

    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
    // just to keep the global  renamers in sync
    %extend {
        static int GetDefaultMarginWidth() { return 0; }
    }
#endif

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

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