X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e91ce12d7332ae28eed94418dd4745282cdfcc6f..4e621d24713f971d1a2d440f79ccc4593aede4b6:/interface/wx/menuitem.h diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h index 824287400d..83b96c7c77 100644 --- a/interface/wx/menuitem.h +++ b/interface/wx/menuitem.h @@ -3,7 +3,7 @@ // Purpose: interface of wxMenu, wxMenuItem // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -157,7 +157,7 @@ public: @onlyfor{wxmsw} */ - wxColour GetBackgroundColour() const; + wxColour& GetBackgroundColour() const; /** Returns the checked or unchecked bitmap. @@ -171,7 +171,7 @@ public: @onlyfor{wxmsw} */ - wxFont GetFont() const; + wxFont& GetFont() const; /** Returns the help string associated with the menu item. @@ -257,7 +257,7 @@ public: @onlyfor{wxmsw} */ - wxColour GetTextColour() const; + wxColour& GetTextColour() const; //@} @@ -307,7 +307,7 @@ public: @onlyfor{wxmsw} */ - void SetBackgroundColour(const wxColour& colour) const; + void SetBackgroundColour(const wxColour& colour); /** Sets the bitmap for the menu item. @@ -349,7 +349,7 @@ public: /** Sets the label associated with the menu item. - Note that if the ID of this menu item corrisponds to a stock ID, then it is + 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. @@ -362,13 +362,21 @@ public: Optionally you can specify also an accelerator string appending a tab character \\t followed by a valid key combination (e.g. CTRL+V). - Its general syntax is any combination of @c "CTRL", @c "ALT" and @c "SHIFT" strings - (case doesn't matter) separated by either @c '-' or @c '+' characters and followed - by the accelerator itself. + 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. + Notice that @c CTRL corresponds to the "Ctrl" key on most platforms but + not under Mac OS 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 F1 to F12) or one of the special characters listed in the table below (again, case doesn't matter): - @c DEL or @c DELETE: Delete key + - @c BACK : Backspace key - @c INS or @c INSERT: Insert key - @c ENTER or @c RETURN: Enter key - @c PGUP: PageUp key @@ -401,7 +409,7 @@ public: @onlyfor{wxmsw} */ - void SetMarginWidth(int width) const; + void SetMarginWidth(int width); /** Sets the parent menu which will contain this menu item.