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

more Doxygen warnings corrections from Tim S

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-08-30 12:44:43 +00:00
parent dbeddfb93d
commit 792255cc6d
9 changed files with 193 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
interface/wx/calctrl.h
View File

@@ -493,7 +493,7 @@ public:
@param lowerdate
The low limit for the dates shown by the control or
@c wxDefaultDateTime.
@param highlighting
@param upperdate
The high limit for the dates shown by the control or
@c wxDefaultDateTime.
@return

4
interface/wx/checkbox.h
View File

@@ -90,7 +90,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "checkBox");
/**
@@ -107,7 +107,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "checkBox");
/**

23
interface/wx/checklst.h
View File

@@ -67,11 +67,32 @@ public:
wxCheckListBox(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int n,
int n = 0,
const wxString choices[] = NULL,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "listBox");
/**
Constructor, creating and showing a list box.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position.
@param size
Window size. If wxDefaultSize is specified then the window is sized
appropriately.
@param choices
An array of strings with which to initialise the control.
@param style
Window style. See wxCheckListBox.
@param validator
Window validator.
@param name
Window name.
*/
wxCheckListBox(wxWindow* parent, wxWindowID id,
const wxPoint& pos,
const wxSize& size,

80
interface/wx/choicdlg.h
View File

@@ -66,6 +66,44 @@ public:
int n, const wxString* choices,
long style = wxCHOICEDLG_STYLE,
const wxPoint& pos = wxDefaultPosition);
/**
Constructor taking an array of wxString choices.
@param parent
Parent window.
@param message
Message to show on the dialog.
@param caption
The dialog caption.
@param choices
An array of strings, or a string list, containing the choices.
@param style
A dialog style (bitlist) containing flags chosen from standard
dialog style and the ones listed below. The default value is
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
wxCANCEL | wxCENTRE.
@param pos
Dialog position. Not Windows.
@beginStyleTable
@style{wxOK}
Show an OK button.
@style{wxCANCEL}
Show a Cancel button.
@style{wxCENTRE}
Centre the message. Not Windows.
@endStyleTable
@remarks Use ShowModal() to show the dialog.
@beginWxPythonOnly
For Python the two parameters @a n and @a choices are collapsed into a
multi parameter @a choices which is expected to be a Python list of
strings.
@endWxPythonOnly
*/
wxMultiChoiceDialog(wxWindow* parent,
const wxString& message,
const wxString& caption,
@@ -158,6 +196,48 @@ public:
void** clientData = NULL,
long style = wxCHOICEDLG_STYLE,
const wxPoint& pos = wxDefaultPosition);
/**
Constructor, taking an array of wxString choices and optional client
data.
@param parent
Parent window.
@param message
Message to show on the dialog.
@param caption
The dialog caption.
@param choices
An array of strings, or a string list, containing the choices.
@param clientData
An array of client data to be associated with the items. See
GetSelectionClientData().
@param style
A dialog style (bitlist) containing flags chosen from standard
dialog styles and the ones listed below. The default value is
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
wxCANCEL | wxCENTRE.
@param pos
Dialog position. Not Windows.
@beginStyleTable
@style{wxOK}
Show an OK button.
@style{wxCANCEL}
Show a Cancel button.
@style{wxCENTRE}
Centre the message. Not Windows.
@endStyleTable
@remarks Use ShowModal() to show the dialog.
@beginWxPythonOnly
For Python the two parameters @a n and @a choices are collapsed into a
multi parameter @a choices which is expected to be a Python list of
strings.
@endWxPythonOnly
*/
wxSingleChoiceDialog(wxWindow* parent,
const wxString& message,
const wxString& caption,

31
interface/wx/choice.h
View File

@@ -80,6 +80,37 @@ public:
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "choice");
/**
Constructor, creating and showing a choice.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position.
@param size
Window size. If wxDefaultSize is specified then the choice is sized
appropriately.
@param choices
An array of strings with which to initialise the choice control.
@param style
Window style. See wxChoice.
@param validator
Window validator.
@param name
Window name.
@see Create(), wxValidator
@beginWxPythonOnly
The wxChoice constructor in wxPython reduces the @a n and @a choices
arguments to a single argument, which is a list of strings.
@endWxPythonOnly
*/
wxChoice(wxWindow* parent, wxWindowID id,
const wxPoint& pos,
const wxSize& size,

30
interface/wx/combobox.h
View File

@@ -107,6 +107,36 @@ public:
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "comboBox");
/**
Constructor, creating and showing a combobox.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param value
Initial selection string. An empty string indicates no selection.
@param pos
Window position.
@param size
Window size. If wxDefaultSize is specified then the window is sized
appropriately.
@param choices
An array of strings with which to initialise the control.
@param style
Window style. See wxComboBox.
@param validator
Window validator.
@param name
Window name.
@beginWxPythonOnly
The wxComboBox constructor in wxPython reduces the @a n and @a choices
arguments are to a single argument, which is a list of strings.
@endWxPythonOnly
@see Create(), wxValidator
*/
wxComboBox(wxWindow* parent, wxWindowID id,
const wxString& value,
const wxPoint& pos,

2
interface/wx/listctrl.h
View File

@@ -1211,7 +1211,7 @@ public:
@see wxListCtrl::SetItemState
*/
void Select(bool on = true);
void Select(long n, bool on = true);
/**
Sets the column image for the specified column. To use the column images, the

25
interface/wx/odcombo.h
View File

@@ -105,6 +105,31 @@ public:
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "comboBox");
/**
Constructor, creating and showing a owner-drawn combobox.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value @c wxID_ANY indicates a default value.
@param value
Initial selection string. An empty string indicates no selection.
@param pos
Window position.
@param size
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param choices
An array of strings with which to initialise the control.
@param style
Window style. See wxOwnerDrawnComboBox.
@param validator
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,
const wxString& value,
const wxPoint& pos,

2
interface/wx/tls.h
View File

@@ -46,7 +46,7 @@
type emulating @c T @c *, i.e. a pointer to this type otherwise. This macro
always returns an expression of type @c T itself.
As shown in wxTLS_TYPE() example, you may want to @c #define a symbol
As shown in wxTLS_TYPE() example, you may want to @c \#define a symbol
wrapping a thread-specific variable with this macro. And, as also explained
in wxTLS_TYPE() documentation, you may avoid using it entirely if you
target only recent compilers.