Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

revised m*h headers

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56227 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-11 13:10:48 +00:00
parent bd412bc6b6
commit ba1d7a6cec
13 changed files with 727 additions and 448 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
interface/wx/menuitem.h
View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: menuitem.h
// Purpose: interface of wxMenuItem
// Purpose: interface of wxMenu, wxMenuItem
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -9,9 +9,10 @@
/**
@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.
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.
Also please note that the methods related to fonts and bitmaps are currently
only implemented for Windows and GTK+.
@@ -26,19 +27,38 @@ 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 "Stock Items" for the full list) it is enough
to specify just the stock ID and leave @a text and @a helpString empty. In
fact, leaving at least @a text empty for the stock menu items is strongly
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.
In fact, leaving at least @a text empty for the stock menu items is 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.
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; that is, stock properties are set independently one from the other.
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, wxEmptyString, wxT("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
@@ -48,14 +68,14 @@ public:
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. An accelerator
key can be specified using the ampersand " character. In order to embed an
Text for the menu item, as shown on the menu. An accelerator key can
be specified using the ampersand " character. In order to embed an
ampersand character in the menu item text, the ampersand must be doubled.
@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
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.
*/
@@ -108,7 +128,7 @@ public:
/**
Returns the text associated with the menu item including any accelerator
characters that were passed to the constructor or SetItemLabel.
characters that were passed to the constructor or SetItemLabel().
@see GetItemLabelText(), GetLabelText()
*/
@@ -131,23 +151,26 @@ public:
/**
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 GetText(), GetLabelFromText()
*/
wxString GetLabel() const;
/**
@deprecated This function is deprecated; please use GetLabelText() instead.
@see GetText(), GetLabel()
*/
static wxString GetLabelFromText(const wxString& text);
/**
Strips all accelerator characters and mnemonics from the given @e text.
Strips all accelerator characters and mnemonics from the given @a text.
For example:
@code
wxMenuItem::GetLabelfromText( "&Hello\tCtrl-h");
wxMenuItem::GetLabelfromText("&Hello\tCtrl-h");
@endcode
will return just @c "Hello".
@@ -169,7 +192,9 @@ public:
/**
Returns the text associated with the menu item.
@deprecated This function is deprecated. Please use
GetItemLabel() or GetItemLabelText() instead.
*/
wxString GetName() const;
@@ -182,7 +207,9 @@ public:
/**
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 GetLabel(), GetLabelFromText()
*/
wxString GetText() const;
@@ -223,15 +250,14 @@ public:
void SetBackgroundColour(const wxColour& colour) const;
/**
Sets the bitmap for the menu item (Windows and GTK+ only). It is
equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).
Sets the bitmap for the menu item (Windows and GTK+ only).
It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).
*/
virtual void SetBitmap(const wxBitmap& bmp);
/**
Sets the checked/unchecked bitmaps for the menu item (Windows only). The first
bitmap
is also used as the single bitmap for uncheckable menu items.
Sets the checked/unchecked bitmaps for the menu item (Windows only).
The first bitmap is also used as the single bitmap for uncheckable menu items.
*/
void SetBitmaps(const wxBitmap& checked,
const wxBitmap& unchecked = wxNullBitmap);
@@ -268,6 +294,7 @@ public:
/**
Sets the text associated with the menu item.
@deprecated This function is deprecated in favour of SetItemLabel().
*/
virtual void SetText(const wxString& text);