[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


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

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