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

removed trailing whitespace in Doxygen files

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52634 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2008-03-20 13:45:17 +00:00
parent 7df4c51f60
commit 3c4f71cc3d
184 changed files with 4902 additions and 4902 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
interface/menu.h
View File

@@ -23,7 +23,7 @@ public:
//@{
/**
Construct a menu bar from arrays of menus and titles.
@param n
The number of menus.
@param menus
@@ -48,26 +48,26 @@ public:
/**
Adds the item to the end of the menu bar.
@param menu
The menu to add. Do not deallocate this menu after calling Append.
@param title
The title of the menu.
@returns @true on success, @false if an error occurred.
@see Insert()
*/
bool Append(wxMenu* menu, const wxString& title);
/**
Checks or unchecks a menu item.
@param id
The menu item identifier.
@param check
If @true, checks the menu item, otherwise the item is unchecked.
@remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call.
*/
@@ -75,12 +75,12 @@ public:
/**
Enables or disables (greys out) a menu item.
@param id
The menu item identifier.
@param enable
@true to enable the item, @false to disable it.
@remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call.
*/
@@ -88,24 +88,24 @@ public:
/**
Enables or disables a whole menu.
@param pos
The position of the menu, starting from zero.
@param enable
@true to enable the menu, @false to disable it.
@remarks Only use this when the menu bar has been associated with a frame.
*/
void EnableTop(int pos, const bool enable);
/**
Finds the menu item object associated with the given menu item identifier.
@param id
Menu item identifier.
@param menu
If not @NULL, menu will get set to the associated menu.
@returns The found menu item object, or @NULL if one was not found.
*/
wxMenuItem* FindItem(int id, wxMenu menu = NULL) const;
@@ -120,14 +120,14 @@ public:
/**
Finds the menu item id for a menu name/menu item string pair.
@param menuString
Menu title to find.
@param itemString
Item to find.
@returns The menu item identifier, or wxNOT_FOUND if none was found.
@remarks Any special menu codes are stripped out of source and target
strings before matching.
*/
@@ -136,26 +136,26 @@ public:
/**
Gets the help string associated with the menu item identifier.
@param id
The menu item identifier.
@returns The help string, or the empty string if there was no help string
or the menu item was not found.
@see SetHelpString()
*/
wxString GetHelpString(int id) const;
/**
Gets the label associated with a menu item.
@param id
The menu item identifier.
@returns The menu item label, or the empty string if the item was not
found.
@remarks Use only after the menubar has been associated with a frame.
*/
wxString GetLabel(int id) const;
@@ -164,14 +164,14 @@ public:
Returns the label of a top-level menu. Note that the returned string does not
include the accelerator characters which could have been specified in the menu
title string during its construction.
@param pos
Position of the menu on the menu bar, starting from zero.
@returns The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@see SetLabelTop()
*/
wxString GetLabelTop(int pos) const;
@@ -190,14 +190,14 @@ public:
Returns the label of a top-level menu. Note that the returned string
includes the accelerator characters that have been specified in the menu
title string during its construction.
@param pos
Position of the menu on the menu bar, starting from zero.
@returns The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@see GetMenuLabelText(), SetMenuLabel()
*/
wxString GetMenuLabel(int pos) const;
@@ -206,14 +206,14 @@ public:
Returns the label of a top-level menu. Note that the returned string does not
include any accelerator characters that may have been specified in the menu
title string during its construction.
@param pos
Position of the menu on the menu bar, starting from zero.
@returns The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@see GetMenuLabel(), SetMenuLabel()
*/
wxString GetMenuLabelText(int pos) const;
@@ -223,36 +223,36 @@ public:
position 0 will insert it in the very beginning of it, inserting at position
GetMenuCount() is the same as calling
Append().
@param pos
The position of the new menu in the menu bar
@param menu
The menu to add. wxMenuBar owns the menu and will free it.
@param title
The title of the menu.
@returns @true on success, @false if an error occurred.
@see Append()
*/
bool Insert(size_t pos, wxMenu* menu, const wxString& title);
/**
Determines whether an item is checked.
@param id
The menu item identifier.
@returns @true if the item was found and is checked, @false otherwise.
*/
bool IsChecked(int id) const;
/**
Determines whether an item is enabled.
@param id
The menu item identifier.
@returns @true if the item was found and is enabled, @false otherwise.
*/
bool IsEnabled(int id) const;
@@ -267,76 +267,76 @@ public:
responsible for deleting it. This function may be used together with
Insert() to change the menubar
dynamically.
@see Replace()
*/
wxMenu* Remove(size_t pos);
/**
Replaces the menu at the given position with another one.
@param pos
The position of the new menu in the menu bar
@param menu
The menu to add.
@param title
The title of the menu.
@returns The menu which was previously at position pos. The caller is
responsible for deleting it.
@see Insert(), Remove()
*/
wxMenu* Replace(size_t pos, wxMenu* menu, const wxString& title);
/**
Sets the help string associated with a menu item.
@param id
Menu item identifier.
@param helpString
Help string to associate with the menu item.
@see GetHelpString()
*/
void SetHelpString(int id, const wxString& helpString);
/**
Sets the label of a menu item.
@param id
Menu item identifier.
@param label
Menu item label.
@remarks Use only after the menubar has been associated with a frame.
@see GetLabel()
*/
void SetLabel(int id, const wxString& label);
/**
Sets the label of a top-level menu.
@param pos
The position of a menu on the menu bar, starting from zero.
@param label
The menu label.
@remarks Use only after the menubar has been associated with a frame.
@see GetLabelTop()
*/
void SetLabelTop(int pos, const wxString& label);
/**
Sets the label of a top-level menu.
@param pos
The position of a menu on the menu bar, starting from zero.
@param label
The menu label.
@remarks Use only after the menubar has been associated with a frame.
*/
void SetMenuLabel(int pos, const wxString& label);
@@ -394,7 +394,7 @@ public:
//@{
/**
Constructs a wxMenu object.
@param style
If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
*/
@@ -419,7 +419,7 @@ public:
because it may be used for both items (including separators) and submenus and
because you can also specify various extra properties of a menu item this way,
such as bitmaps and fonts.
@param id
The menu command identifier.
@param item
@@ -436,10 +436,10 @@ public:
@param menuItem
A menuitem object. It will be owned by the wxMenu object after this function
is called, so do not delete it yourself.
@remarks This command can be used after the menu has been shown, as well
as on initial creation of a menu or menubar.
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
AppendSubMenu(), Insert(), SetLabel(),
GetHelpString(), SetHelpString(), wxMenuItem
@@ -455,7 +455,7 @@ public:
/**
Adds a checkable item to the end of the menu.
@see Append(), InsertCheckItem()
*/
wxMenuItem* AppendCheckItem(int id, const wxString& item,
@@ -465,7 +465,7 @@ public:
Adds a radio item to the end of the menu. All consequent radio items form a
group and when an item in the group is checked, all the others are
automatically unchecked.
@see Append(), InsertRadioItem()
*/
wxMenuItem* AppendRadioItem(int id, const wxString& item,
@@ -473,7 +473,7 @@ public:
/**
Adds a separator to the end of the menu.
@see Append(), InsertSeparator()
*/
wxMenuItem* AppendSeparator();
@@ -494,12 +494,12 @@ public:
/**
Checks or unchecks the menu item.
@param id
The menu item identifier.
@param check
If @true, the item will be checked, otherwise it will be unchecked.
@see IsChecked()
*/
void Check(int id, const bool check);
@@ -509,12 +509,12 @@ public:
Deletes the menu item from the menu. If the item is a submenu, it will
@b not be deleted. Use Destroy() if you want to
delete a submenu.
@param id
Id of the menu item to be deleted.
@param item
Menu item to be deleted.
@see FindItem(), Destroy(), Remove()
*/
void Delete(int id);
@@ -526,12 +526,12 @@ public:
Deletes the menu item from the menu. If the item is a submenu, it will
be deleted. Use Remove() if you want to keep the submenu
(for example, to reuse it later).
@param id
Id of the menu item to be deleted.
@param item
Menu item to be deleted.
@see FindItem(), Deletes(), Remove()
*/
void Destroy(int id);
@@ -540,12 +540,12 @@ public:
/**
Enables or disables (greys out) a menu item.
@param id
The menu item identifier.
@param enable
@true to enable the menu item, @false to disable it.
@see IsEnabled()
*/
void Enable(int id, const bool enable);
@@ -554,7 +554,7 @@ public:
/**
Finds the menu item object associated with the given menu item identifier and,
optionally, the (sub)menu it belongs to.
@param itemString
Menu item string to find.
@param id
@@ -562,10 +562,10 @@ public:
@param menu
If the pointer is not @NULL, it will be filled with the item's
parent menu (if the item was found)
@returns First form: menu item identifier, or wxNOT_FOUND if none is
found.
@remarks Any special menu codes are stripped out of source and target
strings before matching.
*/
@@ -580,25 +580,25 @@ public:
/**
Returns the help string associated with a menu item.
@param id
The menu item identifier.
@returns The help string, or the empty string if there is no help string
or the item was not found.
@see SetHelpString(), Append()
*/
wxString GetHelpString(int id) const;
/**
Returns a menu item label.
@param id
The menu item identifier.
@returns The item label, or the empty string if the item was not found.
@see GetLabelText(), SetLabel()
*/
wxString GetLabel(int id) const;
@@ -606,12 +606,12 @@ public:
/**
Returns a menu item label, without any of the original mnemonics and
accelerators.
@param id
The menu item identifier.
@returns The item label, or the empty string if the item was not found.
@see GetLabel(), SetLabel()
*/
wxString GetLabelText(int id) const;
@@ -629,10 +629,10 @@ public:
/**
Returns the title of the menu.
@remarks This is relevant only to popup menus, use
wxMenuBar::GetMenuLabel for the menus in the menubar.
@see SetTitle()
*/
wxString GetTitle() const;
@@ -642,7 +642,7 @@ public:
Inserts the given @a item before the position @e pos. Inserting the item
at position GetMenuItemCount() is the same
as appending it.
@see Append(), Prepend()
*/
wxMenuItem* Insert(size_t pos, wxMenuItem* item);
@@ -654,7 +654,7 @@ public:
/**
Inserts a checkable item at the given position.
@see Insert(), AppendCheckItem()
*/
wxMenuItem* InsertCheckItem(size_t pos, int id,
@@ -663,7 +663,7 @@ public:
/**
Inserts a radio item at the given position.
@see Insert(), AppendRadioItem()
*/
wxMenuItem* InsertRadioItem(size_t pos, int id,
@@ -672,31 +672,31 @@ public:
/**
Inserts a separator at the given position.
@see Insert(), AppendSeparator()
*/
wxMenuItem* InsertSeparator(size_t pos);
/**
Determines whether a menu item is checked.
@param id
The menu item identifier.
@returns @true if the menu item is checked, @false otherwise.
@see Check()
*/
bool IsChecked(int id) const;
/**
Determines whether a menu item is enabled.
@param id
The menu item identifier.
@returns @true if the menu item is enabled, @false otherwise.
@see Enable()
*/
bool IsEnabled(int id) const;
@@ -705,7 +705,7 @@ public:
/**
Inserts the given @a item at position 0, i.e. before all the other
existing items.
@see Append(), Insert()
*/
wxMenuItem* Prepend(wxMenuItem* item);
@@ -716,7 +716,7 @@ public:
/**
Inserts a checkable item at position 0.
@see Prepend(), AppendCheckItem()
*/
wxMenuItem* PrependCheckItem(int id, const wxString& item,
@@ -724,7 +724,7 @@ public:
/**
Inserts a radio item at position 0.
@see Prepend(), AppendRadioItem()
*/
wxMenuItem* PrependRadioItem(int id, const wxString& item,
@@ -732,7 +732,7 @@ public:
/**
Inserts a separator at position 0.
@see Prepend(), AppendSeparator()
*/
wxMenuItem* PrependSeparator();
@@ -742,12 +742,12 @@ public:
Removes the menu item from the menu but doesn't delete the associated C++
object. This allows to reuse the same item later by adding it back to the menu
(especially useful with submenus).
@param id
The identifier of the menu item to remove.
@param item
The menu item to remove.
@returns The item which was detached from the menu.
*/
wxMenuItem* Remove(int id);
@@ -756,37 +756,37 @@ public:
/**
Sets an item's help string.
@param id
The menu item identifier.
@param helpString
The help string to set.
@see GetHelpString()
*/
void SetHelpString(int id, const wxString& helpString);
/**
Sets the label of a menu item.
@param id
The menu item identifier.
@param label
The menu item label to set.
@see Append(), GetLabel()
*/
void SetLabel(int id, const wxString& label);
/**
Sets the title of the menu.
@param title
The title to set.
@remarks This is relevant only to popup menus, use
wxMenuBar::SetLabelTop for the menus in the menubar.
@see GetTitle()
*/
void SetTitle(const wxString& title);