initial commit
Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>
This commit is contained in:
636
libs/wxWidgets-3.3.1/interface/wx/menuitem.h
Normal file
636
libs/wxWidgets-3.3.1/interface/wx/menuitem.h
Normal file
@@ -0,0 +1,636 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: menuitem.h
|
||||
// Purpose: interface of wxMenu, wxMenuItem
|
||||
// Author: wxWidgets team
|
||||
// Licence: wxWindows licence
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxMenuItem
|
||||
|
||||
A menu item represents an item in a menu.
|
||||
|
||||
Note that you usually don't have to deal with it directly as wxMenu methods
|
||||
usually construct an object of this class for you.
|
||||
|
||||
@beginEventEmissionTable{wxCommandEvent,wxMenuEvent}
|
||||
@event{EVT_MENU(id, func)}
|
||||
Process a @c wxEVT_MENU command, which is generated by a menu item.
|
||||
This type of event is sent as wxCommandEvent.
|
||||
@event{EVT_MENU_RANGE(id1, id2, func)}
|
||||
Process a @c wxEVT_MENU command, which is generated by a range of menu items.
|
||||
This type of event is sent as wxCommandEvent.
|
||||
@event{EVT_MENU_OPEN(func)}
|
||||
A menu is about to be opened. On Windows, this is only sent once for each
|
||||
navigation of the menubar (up until all menus have closed).
|
||||
This type of event is sent as wxMenuEvent.
|
||||
@event{EVT_MENU_CLOSE(func)}
|
||||
A menu has been just closed.
|
||||
This type of event is sent as wxMenuEvent.
|
||||
@event{EVT_MENU_HIGHLIGHT(id, func)}
|
||||
The menu item with the specified id has been highlighted. If the id is
|
||||
::wxID_NONE, highlighting has been removed from the previously
|
||||
highlighted menu item and there is no highlighted item any more.
|
||||
This is used by wxFrame to show help prompts in the status bar.
|
||||
This type of event is sent as wxMenuEvent.
|
||||
@event{EVT_MENU_HIGHLIGHT_ALL(func)}
|
||||
A menu item has been highlighted, i.e. the currently selected menu item has changed.
|
||||
This type of event is sent as wxMenuEvent.
|
||||
@endEventTable
|
||||
|
||||
@section menuitem_ownerdrawn Customizing Menu Items Appearance
|
||||
|
||||
This class provides several functions for customizing the menu items
|
||||
appearance that are available only in wxMSW port. These functions should
|
||||
not be used in portable programs and, moreover, have some known limitations
|
||||
even in wxMSW: using them switches the menu item in an "owner drawn" mode,
|
||||
where it is painted by wxWidgets itself and not the system, which may
|
||||
result in a slightly different appearance for it. Owner drawn items are
|
||||
also incompatible with dark mode support and using them makes the entire
|
||||
menu containing them to use standard light mode colours even in dark mode.
|
||||
|
||||
@library{wxcore}
|
||||
@category{menus}
|
||||
|
||||
@see wxMenuBar, wxMenu
|
||||
*/
|
||||
class wxMenuItem : public wxObject
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Constructs a wxMenuItem object.
|
||||
|
||||
Menu items can be standard, or "stock menu items", or custom.
|
||||
For the standard menu items (such as commands to open a file, exit the
|
||||
program and so on, see @ref page_stockitems for the full list) it is enough
|
||||
to specify just the stock ID and leave @a text and @a helpString empty.
|
||||
Some platforms (currently wxGTK only, and see the remark in SetBitmap()
|
||||
documentation) will also show standard bitmaps for stock menu items.
|
||||
|
||||
Leaving at least @a text empty for the stock menu items is actually strongly
|
||||
recommended as they will have appearance and keyboard interface (including
|
||||
standard accelerators) familiar to the user.
|
||||
|
||||
For the custom (non-stock) menu items, @a text must be specified and while
|
||||
@a helpString may be left empty, it's recommended to pass the item
|
||||
description (which is automatically shown by the library in the status bar
|
||||
when the menu item is selected) in this parameter.
|
||||
|
||||
Finally note that you can e.g. use a stock menu label without using its stock
|
||||
help string:
|
||||
|
||||
@code
|
||||
// use all stock properties:
|
||||
helpMenu->Append(wxID_ABOUT);
|
||||
|
||||
// use the stock label and the stock accelerator but not the stock help string:
|
||||
helpMenu->Append(wxID_ABOUT, "", "My custom help string");
|
||||
|
||||
// use all stock properties except for the bitmap:
|
||||
wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);
|
||||
mymenu->SetBitmap(wxArtProvider::GetBitmap(wxART_WARNING));
|
||||
helpMenu->Append(mymenu);
|
||||
@endcode
|
||||
|
||||
that is, stock properties are set independently one from the other.
|
||||
|
||||
@param parentMenu
|
||||
Menu that the menu item belongs to. Can be @NULL if the item is
|
||||
going to be added to the menu later.
|
||||
@param id
|
||||
Identifier for this menu item. May be @c wxID_SEPARATOR, in which
|
||||
case the given kind is ignored and taken to be @c wxITEM_SEPARATOR
|
||||
instead.
|
||||
@param text
|
||||
Text for the menu item, as shown on the menu.
|
||||
See SetItemLabel() for more info.
|
||||
@param helpString
|
||||
Optional help string that will be shown on the status bar.
|
||||
@param kind
|
||||
May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or
|
||||
@c wxITEM_RADIO.
|
||||
@param subMenu
|
||||
If non-null, indicates that the menu item is a submenu.
|
||||
*/
|
||||
wxMenuItem(wxMenu* parentMenu = nullptr, int id = wxID_SEPARATOR,
|
||||
const wxString& text = wxEmptyString,
|
||||
const wxString& helpString = wxEmptyString,
|
||||
wxItemKind kind = wxITEM_NORMAL,
|
||||
wxMenu* subMenu = nullptr);
|
||||
|
||||
/**
|
||||
Destructor.
|
||||
*/
|
||||
virtual ~wxMenuItem();
|
||||
|
||||
/**
|
||||
Checks or unchecks the menu item.
|
||||
Note that this only works when the item is already appended to a menu.
|
||||
*/
|
||||
virtual void Check(bool check = true);
|
||||
|
||||
/**
|
||||
Enables or disables the menu item.
|
||||
*/
|
||||
virtual void Enable(bool enable = true);
|
||||
|
||||
/**
|
||||
@deprecated This function is deprecated; please use GetLabelText() instead.
|
||||
|
||||
@see GetLabelText()
|
||||
*/
|
||||
static wxString GetLabelFromText(const wxString& text);
|
||||
|
||||
/**
|
||||
Strips all accelerator characters and mnemonics from the given @a text.
|
||||
For example:
|
||||
|
||||
@code
|
||||
wxMenuItem::GetLabelText("&Hello\tCtrl-h");
|
||||
@endcode
|
||||
|
||||
will return just @c "Hello".
|
||||
|
||||
@see GetItemLabelText(), GetItemLabel()
|
||||
*/
|
||||
static wxString GetLabelText(const wxString& text);
|
||||
|
||||
|
||||
/**
|
||||
@name Getters
|
||||
*/
|
||||
///@{
|
||||
|
||||
/**
|
||||
Returns the background colour associated with the menu item.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
wxColour& GetBackgroundColour() const;
|
||||
|
||||
/**
|
||||
Returns the item bitmap.
|
||||
|
||||
This method exists only for compatibility, please use GetBitmapBundle()
|
||||
in the new code.
|
||||
*/
|
||||
wxBitmap GetBitmap() const;
|
||||
|
||||
/**
|
||||
Returns the checked or unchecked bitmap.
|
||||
|
||||
This overload only exists in wxMSW, avoid using it in portable code.
|
||||
*/
|
||||
wxBitmap GetBitmap(bool checked) const;
|
||||
|
||||
/**
|
||||
Returns the bitmap bundle containing the bitmap used for this item.
|
||||
|
||||
The returned bundle is invalid, i.e. empty, if no bitmap is associated
|
||||
with the item.
|
||||
|
||||
@see SetBitmap()
|
||||
|
||||
@since 3.2.0
|
||||
*/
|
||||
wxBitmapBundle GetBitmapBundle() const;
|
||||
|
||||
/**
|
||||
Returns the bitmap used for disabled items.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
virtual wxBitmap GetDisabledBitmap() const;
|
||||
|
||||
/**
|
||||
Returns the font associated with the menu item.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
wxFont& GetFont() const;
|
||||
|
||||
/**
|
||||
Returns the help string associated with the menu item.
|
||||
*/
|
||||
const wxString& GetHelp() const;
|
||||
|
||||
/**
|
||||
Returns the menu item identifier.
|
||||
*/
|
||||
int GetId() const;
|
||||
|
||||
/**
|
||||
Returns the text associated with the menu item including any accelerator
|
||||
characters that were passed to the constructor or SetItemLabel().
|
||||
|
||||
@see GetItemLabelText(), GetLabelText()
|
||||
*/
|
||||
virtual wxString GetItemLabel() const;
|
||||
|
||||
/**
|
||||
Returns the text associated with the menu item, without any accelerator
|
||||
characters.
|
||||
|
||||
@see GetItemLabel(), GetLabelText()
|
||||
*/
|
||||
virtual wxString GetItemLabelText() const;
|
||||
|
||||
/**
|
||||
Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL,
|
||||
@c wxITEM_CHECK or @c wxITEM_RADIO.
|
||||
*/
|
||||
wxItemKind GetKind() const;
|
||||
|
||||
/**
|
||||
Returns the text associated with the menu item without any accelerator
|
||||
characters it might contain.
|
||||
|
||||
@deprecated This function is deprecated in favour of GetItemLabelText().
|
||||
|
||||
@see GetItemLabelText()
|
||||
*/
|
||||
wxString GetLabel() const;
|
||||
|
||||
/**
|
||||
Gets the width of the menu item checkmark bitmap.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
int GetMarginWidth() const;
|
||||
|
||||
/**
|
||||
Returns the menu this menu item is in, or @NULL if this menu item is not
|
||||
attached.
|
||||
*/
|
||||
wxMenu* GetMenu() const;
|
||||
|
||||
/**
|
||||
Returns the text associated with the menu item.
|
||||
|
||||
@deprecated This function is deprecated. Please use GetItemLabel() or GetItemLabelText() instead.
|
||||
|
||||
@see GetItemLabel(), GetItemLabelText()
|
||||
*/
|
||||
wxString GetName() const;
|
||||
|
||||
/**
|
||||
Returns the submenu associated with the menu item, or @NULL if there isn't one.
|
||||
*/
|
||||
wxMenu* GetSubMenu() const;
|
||||
|
||||
/**
|
||||
Returns the text associated with the menu item, such as it was passed to the
|
||||
wxMenuItem constructor, i.e.\ with any accelerator characters it may contain.
|
||||
|
||||
@deprecated This function is deprecated in favour of GetItemLabel().
|
||||
|
||||
@see GetItemLabel()
|
||||
*/
|
||||
const wxString& GetText() const;
|
||||
|
||||
/**
|
||||
Returns the text colour associated with the menu item.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
wxColour& GetTextColour() const;
|
||||
|
||||
/**
|
||||
Extract the accelerator from the given menu string, return @NULL if none
|
||||
found.
|
||||
*/
|
||||
static wxAcceleratorEntry *GetAccelFromString(const wxString& label);
|
||||
|
||||
/**
|
||||
Get our accelerator or @NULL (caller must delete the pointer)
|
||||
*/
|
||||
virtual wxAcceleratorEntry *GetAccel() const;
|
||||
|
||||
///@}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@name Checkers
|
||||
*/
|
||||
///@{
|
||||
|
||||
/**
|
||||
Returns @true if the item is a check item.
|
||||
|
||||
Unlike IsCheckable() this doesn't return @true for the radio buttons.
|
||||
|
||||
@since 2.9.5
|
||||
*/
|
||||
bool IsCheck() const;
|
||||
|
||||
/**
|
||||
Returns @true if the item is checkable.
|
||||
|
||||
Notice that the radio buttons are considered to be checkable as well,
|
||||
so this method returns @true for them too. Use IsCheck() if you want to
|
||||
test for the check items only.
|
||||
*/
|
||||
bool IsCheckable() const;
|
||||
|
||||
/**
|
||||
Returns @true if the item is checked.
|
||||
*/
|
||||
virtual bool IsChecked() const;
|
||||
|
||||
/**
|
||||
Returns @true if the item is enabled.
|
||||
*/
|
||||
virtual bool IsEnabled() const;
|
||||
|
||||
/**
|
||||
Returns @true if the item is a radio button.
|
||||
|
||||
@since 2.9.5
|
||||
*/
|
||||
bool IsRadio() const;
|
||||
|
||||
/**
|
||||
Returns @true if the item is a separator.
|
||||
*/
|
||||
bool IsSeparator() const;
|
||||
|
||||
/**
|
||||
Returns @true if the item is a submenu.
|
||||
*/
|
||||
bool IsSubMenu() const;
|
||||
|
||||
///@}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@name Setters
|
||||
*/
|
||||
///@{
|
||||
|
||||
/**
|
||||
Sets the background colour associated with the menu item.
|
||||
|
||||
Please note that this function only exists in wxMSW and works by making
|
||||
the menu item "owner-drawn" there, please see the note about such items
|
||||
in this class description.
|
||||
*/
|
||||
void SetBackgroundColour(const wxColour& colour);
|
||||
|
||||
/**
|
||||
Sets the bitmap for the menu item.
|
||||
|
||||
Notice that GTK+ uses a global setting called @c gtk-menu-images to
|
||||
determine if the images should be shown in the menus at all. If it is
|
||||
off (which is the case in e.g. Gnome 2.28 by default), no images will
|
||||
be shown, consistently with the native behaviour.
|
||||
*/
|
||||
void SetBitmap(const wxBitmapBundle& bmp);
|
||||
|
||||
/**
|
||||
Sets the checked or unchecked bitmap for the menu item.
|
||||
|
||||
It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap) if
|
||||
@a checked is @true or SetBitmaps(wxNullBitmap, bmp) otherwise.
|
||||
|
||||
Note that different bitmaps for checked and unchecked item states are
|
||||
not supported in most ports, while setting just a single bitmap using
|
||||
the overload above is supported in all of them.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
void SetBitmap(const wxBitmapBundle& bmp, bool checked);
|
||||
|
||||
/**
|
||||
Sets the checked/unchecked bitmaps for the menu item.
|
||||
The first bitmap is also used as the single bitmap for uncheckable menu items.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
void SetBitmaps(const wxBitmapBundle& checked,
|
||||
const wxBitmapBundle& unchecked = wxNullBitmap);
|
||||
|
||||
/**
|
||||
Sets the to be used for disabled menu items.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
void SetDisabledBitmap(const wxBitmapBundle& disabled);
|
||||
|
||||
|
||||
/**
|
||||
Sets the font associated with the menu item.
|
||||
|
||||
Please note that this function only exists in wxMSW and works by making
|
||||
the menu item "owner-drawn" there, please see the note about such items
|
||||
in this class description.
|
||||
*/
|
||||
void SetFont(const wxFont& font);
|
||||
|
||||
/**
|
||||
Sets the help string.
|
||||
*/
|
||||
void SetHelp(const wxString& helpString);
|
||||
|
||||
/**
|
||||
Sets the label associated with the menu item.
|
||||
|
||||
Note that if the ID of this menu item corresponds to a stock ID, then it is
|
||||
not necessary to specify a label: wxWidgets will automatically use the stock
|
||||
item label associated with that ID. See the @ref wxMenuItem::wxMenuItem "constructor"
|
||||
for more info.
|
||||
|
||||
The label string for the normal menu items (not separators) may include the
|
||||
accelerator which can be used to activate the menu item from keyboard.
|
||||
An accelerator key can be specified using the ampersand <tt>&</tt> character.
|
||||
In order to embed an ampersand character in the menu item text, the ampersand
|
||||
must be doubled.
|
||||
|
||||
Optionally you can specify also an accelerator string appending a tab character
|
||||
<tt>\\t</tt> followed by a valid key combination (e.g. <tt>CTRL+V</tt>).
|
||||
Its general syntax is any combination of @c "CTRL", @c "RAWCTRL", @c
|
||||
"ALT" and @c "SHIFT" strings (case doesn't matter) separated by either
|
||||
@c '-' or @c '+' characters and followed by the accelerator itself. Note that
|
||||
the displayed accelerator can differ from the string specified here though,
|
||||
e.g. <tt>Ctrl+X</tt> could be actually shown on the screen when <tt>Ctrl-X</tt>
|
||||
is used.
|
||||
Notice that @c CTRL corresponds to the "Ctrl" key on most platforms but
|
||||
not under macOS where it is mapped to "Cmd" key on Mac keyboard.
|
||||
Usually this is exactly what you want in portable code but if you
|
||||
really need to use the (rarely used for this purpose) "Ctrl" key even
|
||||
under Mac, you may use @c RAWCTRL to prevent this mapping. Under the
|
||||
other platforms @c RAWCTRL is the same as plain @c CTRL.
|
||||
|
||||
The accelerator may be any alphanumeric character, any function key
|
||||
(from @c F1 to @c F12), any numpad digit key using @c KP_ prefix (i.e.
|
||||
from @c KP_0 to @c KP_9) or one of the special strings listed below
|
||||
(again, case doesn't matter) corresponding to the specified key code:
|
||||
- @c Del or @c Delete: WXK_DELETE
|
||||
- @c Back: WXK_BACK
|
||||
- @c Ins or @c Insert: WXK_INSERT
|
||||
- @c Enter or @c Return: WXK_RETURN
|
||||
- @c PgUp or @c PageUp: WXK_PAGEUP
|
||||
- @c PgDn or @c PageDown: WXK_PAGEDOWN
|
||||
- @c Left: WXK_LEFT
|
||||
- @c Right: WXK_RIGHT
|
||||
- @c Up: WXK_UP
|
||||
- @c Down: WXK_DOWN
|
||||
- @c Home: WXK_HOME
|
||||
- @c End: WXK_END
|
||||
- @c Space: WXK_SPACE
|
||||
- @c Tab: WXK_TAB
|
||||
- @c Esc or @c Escape: WXK_ESCAPE
|
||||
- @c Cancel: WXK_CANCEL
|
||||
- @c Clear: WXK_CLEAR
|
||||
- @c Menu: WXK_MENU
|
||||
- @c Pause: WXK_PAUSE
|
||||
- @c Capital: WXK_CAPITAL
|
||||
- @c Select: WXK_SELECT
|
||||
- @c Print: WXK_PRINT
|
||||
- @c Execute: WXK_EXECUTE
|
||||
- @c Snapshot: WXK_SNAPSHOT
|
||||
- @c Help: WXK_HELP
|
||||
- @c Add: WXK_ADD
|
||||
- @c Separator: WXK_SEPARATOR
|
||||
- @c Subtract: WXK_SUBTRACT
|
||||
- @c Decimal: WXK_DECIMAL
|
||||
- @c Divide: WXK_DIVIDE
|
||||
- @c Num_lock: WXK_NUMLOCK
|
||||
- @c Scroll_lock: WXK_SCROLL
|
||||
- @c KP_Space: WXK_NUMPAD_SPACE
|
||||
- @c KP_Tab: WXK_NUMPAD_TAB
|
||||
- @c KP_Enter: WXK_NUMPAD_ENTER
|
||||
- @c KP_Home: WXK_NUMPAD_HOME
|
||||
- @c KP_Left: WXK_NUMPAD_LEFT
|
||||
- @c KP_Up: WXK_NUMPAD_UP
|
||||
- @c KP_Right: WXK_NUMPAD_RIGHT
|
||||
- @c KP_Down: WXK_NUMPAD_DOWN
|
||||
- @c KP_PageUp: WXK_NUMPAD_PAGEUP
|
||||
- @c KP_PageDown: WXK_NUMPAD_PAGEDOWN
|
||||
- @c KP_Prior: WXK_NUMPAD_PAGEUP
|
||||
- @c KP_Next: WXK_NUMPAD_PAGEDOWN
|
||||
- @c KP_End: WXK_NUMPAD_END
|
||||
- @c KP_Begin: WXK_NUMPAD_BEGIN
|
||||
- @c KP_Insert: WXK_NUMPAD_INSERT
|
||||
- @c KP_Delete: WXK_NUMPAD_DELETE
|
||||
- @c KP_Equal: WXK_NUMPAD_EQUAL
|
||||
- @c KP_Multiply: WXK_NUMPAD_MULTIPLY
|
||||
- @c KP_Add: WXK_NUMPAD_ADD
|
||||
- @c KP_Separator: WXK_NUMPAD_SEPARATOR
|
||||
- @c KP_Subtract: WXK_NUMPAD_SUBTRACT
|
||||
- @c KP_Decimal: WXK_NUMPAD_DECIMAL
|
||||
- @c KP_Divide: WXK_NUMPAD_DIVIDE
|
||||
- @c Windows_Left: WXK_WINDOWS_LEFT
|
||||
- @c Windows_Right: WXK_WINDOWS_RIGHT
|
||||
- @c Windows_Menu: WXK_WINDOWS_MENU
|
||||
- @c Command: WXK_COMMAND
|
||||
|
||||
Examples:
|
||||
|
||||
@code
|
||||
m_pMyMenuItem->SetItemLabel("My &item\tCTRL+I");
|
||||
m_pMyMenuItem2->SetItemLabel("Clean && build\tF7");
|
||||
m_pMyMenuItem3->SetItemLabel("Simple item");
|
||||
m_pMyMenuItem4->SetItemLabel("Item with &accelerator");
|
||||
@endcode
|
||||
|
||||
@note In wxGTK using @c "SHIFT" with non-alphabetic characters
|
||||
currently doesn't work, even in combination with other modifiers, due
|
||||
to GTK+ limitation. E.g. @c Shift+Ctrl+A works but @c Shift+Ctrl+1 or
|
||||
@c Shift+/ do not, so avoid using accelerators of this form in portable
|
||||
code.
|
||||
|
||||
@note In wxGTk, the left/right/up/down arrow keys do not work as
|
||||
accelerator keys for a menu item unless a modifier key is used.
|
||||
Additionally, the following keycodes are not supported as menu
|
||||
accelerator keys:
|
||||
- WXK_COMMAND/WXK_CONTROL
|
||||
- WXK_SHIFT
|
||||
- WXK_ALT
|
||||
- WXK_SCROLL
|
||||
- WXK_CAPITAL
|
||||
- WXK_NUMLOCK
|
||||
- WXK_NUMPAD_TAB
|
||||
- WXK_TAB
|
||||
- WXK_WINDOWS_LEFT
|
||||
- WXK_WINDOWS_RIGHT
|
||||
- WXK_ADD
|
||||
- WXK_SEPARATOR
|
||||
- WXK_SUBTRACT
|
||||
- WXK_DECIMAL
|
||||
- WXK_DIVIDE
|
||||
- WXK_SNAPSHOT
|
||||
|
||||
@see GetItemLabel(), GetItemLabelText()
|
||||
*/
|
||||
virtual void SetItemLabel(const wxString& label);
|
||||
|
||||
/**
|
||||
Sets the width of the menu item checkmark bitmap.
|
||||
|
||||
@onlyfor{wxmsw}
|
||||
*/
|
||||
void SetMarginWidth(int width);
|
||||
|
||||
/**
|
||||
Sets the parent menu which will contain this menu item.
|
||||
*/
|
||||
void SetMenu(wxMenu* menu);
|
||||
|
||||
/**
|
||||
Sets the submenu of this menu item.
|
||||
*/
|
||||
void SetSubMenu(wxMenu* menu);
|
||||
|
||||
/**
|
||||
Sets the text associated with the menu item.
|
||||
|
||||
@deprecated This function is deprecated in favour of SetItemLabel().
|
||||
|
||||
@see SetItemLabel().
|
||||
*/
|
||||
virtual void SetText(const wxString& text);
|
||||
|
||||
/**
|
||||
Sets the text colour associated with the menu item.
|
||||
|
||||
Please note that this function only exists in wxMSW and works by making
|
||||
the menu item "owner-drawn" there, please see the note about such items
|
||||
in this class description.
|
||||
*/
|
||||
void SetTextColour(const wxColour& colour);
|
||||
|
||||
/**
|
||||
Set the accel for this item - this may also be done indirectly with
|
||||
SetText()
|
||||
*/
|
||||
virtual void SetAccel(wxAcceleratorEntry *accel);
|
||||
|
||||
/**
|
||||
Add an extra accelerator for this menu item.
|
||||
|
||||
Additional accelerators are not shown in the item's label,
|
||||
but still will trigger the menu command when pressed.
|
||||
|
||||
They can be useful to let multiple keys be used as accelerators
|
||||
for the same command, e.g. @c WXK_ADD and @c WXK_NUMPAD_ADD.
|
||||
|
||||
@onlyfor{wxmsw,wxgtk}
|
||||
|
||||
@since 3.1.6
|
||||
*/
|
||||
virtual void AddExtraAccel(const wxAcceleratorEntry& accel);
|
||||
|
||||
/**
|
||||
Clear the extra accelerators list.
|
||||
|
||||
This doesn't affect the main item accelerator (if any).
|
||||
|
||||
@since 3.1.6
|
||||
*/
|
||||
void ClearExtraAccels();
|
||||
|
||||
///@}
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user