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

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
interface/radiobox.h
View File

@@ -9,11 +9,11 @@
/**
@class wxRadioBox
@wxheader{radiobox.h}
A radio box item is used to select one of number of mutually exclusive
choices. It is displayed as a vertical column or horizontal row of
labelled buttons.
@beginStyleTable
@style{wxRA_SPECIFY_ROWS}:
The major dimension parameter refers to the maximum number of rows.
@@ -24,17 +24,17 @@
Use of the checkbox controls instead of radio buttons (currently
supported only on PalmOS)
@endStyleTable
@beginEventTable
@event{EVT_RADIOBOX(id\, func)}:
Process a wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
is clicked.
@endEventTable
@library{wxcore}
@category{ctrl}
@appearance{radiobox.png}
@seealso
@ref overview_eventhandlingoverview "Event handling overview", wxRadioButton,
wxCheckBox
@@ -46,65 +46,65 @@ public:
/**
Constructor, creating and showing a radiobox.
@param parent
@param parent
Parent window. Must not be @NULL.
@param id
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param label
@param label
Label for the static box surrounding the radio buttons.
@param pos
@param pos
Window position. If wxDefaultPosition is specified then a default position
is chosen.
@param size
@param size
Window size. If wxDefaultSize is specified then a default size is
chosen.
@param n
@param n
Number of choices with which to initialize the radiobox.
@param choices
@param choices
An array of choices with which to initialize the radiobox.
@param majorDimension
@param majorDimension
Specifies the maximum number of rows (if style contains wxRA_SPECIFY_ROWS) or
columns (if style contains wxRA_SPECIFY_COLS) for a two-dimensional
radiobox.
@param style
@param style
Window style. See wxRadioBox.
@param validator
@param validator
Window validator.
@param name
@param name
Window name.
@sa Create(), wxValidator
*/
wxRadioBox();
wxRadioBox(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& point = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int n = 0,
const wxString choices[] = @NULL,
int majorDimension = 0,
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
wxRadioBox(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& point,
const wxSize& size,
const wxArrayString& choices,
int majorDimension = 0,
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
wxRadioBox(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& point = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int n = 0,
const wxString choices[] = @NULL,
int majorDimension = 0,
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
wxRadioBox(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& point,
const wxSize& size,
const wxArrayString& choices,
int majorDimension = 0,
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
//@}
/**
@@ -127,38 +127,38 @@ public:
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
bool Create(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& point,
const wxSize& size,
const wxArrayString& choices,
int majorDimension = 0,
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
bool Create(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& point,
const wxSize& size,
const wxArrayString& choices,
int majorDimension = 0,
long style = wxRA_SPECIFY_COLS,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioBox");
//@}
//@{
/**
Enables or disables an individual button in the radiobox.
@param enable
@param enable
@true to enable, @false to disable.
@param n
@param n
The zero-based button to enable or disable.
@sa wxWindow::Enable
*/
virtual bool Enable(bool enable = @true);
virtual bool Enable(unsigned int n, bool enable = @true);
virtual bool Enable(unsigned int n, bool enable = @true);
//@}
/**
Finds a button matching the given string, returning the position if found, or
-1 if not found.
@param string
@param string
The string to find.
*/
int FindString(const wxString& string);
@@ -172,7 +172,7 @@ public:
Returns a radio box item under the point, a zero-based item index, or @c
wxNOT_FOUND if no item is under the point.
@param pt
@param pt
Point in client coordinates.
*/
int GetItemFromPoint(const wxPoint pt);
@@ -181,7 +181,7 @@ public:
Returns the helptext associated with the specified @e item if any or @c
wxEmptyString.
@param item
@param item
The zero-based item index.
@sa SetItemHelpText()
@@ -198,7 +198,7 @@ public:
/**
Returns the radiobox label.
@param n
@param n
The zero-based button index.
@sa SetLabel()
@@ -218,7 +218,7 @@ public:
/**
Returns the label for the button at the given position.
@param n
@param n
The zero-based button position.
*/
wxString GetString(unsigned int n);
@@ -235,7 +235,7 @@ public:
@b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
and always returns @true in the other ports.
@param n
@param n
The zero-based button position.
*/
bool IsItemEnabled(unsigned int n);
@@ -252,7 +252,7 @@ public:
@b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
and always returns @true in the other ports.
@param n
@param n
The zero-based button position.
*/
bool IsItemShown(unsigned int n);
@@ -260,10 +260,10 @@ public:
/**
Sets the helptext for an item. Empty string erases any existing helptext.
@param item
@param item
The zero-based item index.
@param helptext
@param helptext
The help text to set for the item.
@sa GetItemHelpText()
@@ -276,10 +276,10 @@ public:
@b Platform note: Currently only implemented in wxMSW and wxGTK2 and does
nothing in the other ports.
@param item
@param item
Index of the item the tooltip will be shown for.
@param text
@param text
Tooltip text for the item, the tooltip is removed if empty.
@sa GetItemToolTip(), wxWindow::SetToolTip
@@ -289,10 +289,10 @@ public:
/**
Sets the radiobox label.
@param label
@param label
The label to set.
@param n
@param n
The zero-based button index.
*/
void SetLabel(const wxString& label);
@@ -301,7 +301,7 @@ public:
Sets a button by passing the desired string position. This does not cause
a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
@param n
@param n
The zero-based button position.
*/
void SetSelection(int n);
@@ -311,7 +311,7 @@ public:
cause
a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
@param string
@param string
The label of the button to select.
*/
void SetStringSelection(const wxString& string);