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

Better documentation for the default parameters values.

Browse Source 
Use symbolic names for them and document them separately.

Closes #14051.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70791 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-03-04 00:29:07 +00:00
parent 3285e9a347
commit 0b59366faa
6 changed files with 104 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
interface/wx/choicdlg.h
View File

@@ -6,6 +6,24 @@
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Default width of the choice dialog.
*/
#define wxCHOICE_WIDTH 150
/**
Default height of the choice dialog.
*/
#define wxCHOICE_HEIGHT 200
/**
Default style of the choice dialog.
@remarks wxRESIZE_BORDER is not used under WinCE.
*/
#define wxCHOICEDLG_STYLE (wxDEFAULT_DIALOG_STYLE | wxOK | wxCANCEL | wxCENTRE | wxRESIZE_BORDER)
/**
@class wxMultiChoiceDialog
@@ -314,11 +332,11 @@ int wxGetSingleChoiceIndex(const wxString& message,
const wxString& caption,
const wxArrayString& aChoices,
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200,
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT,
int initialSelection = 0);
int wxGetSingleChoiceIndex(const wxString& message,
@@ -326,11 +344,11 @@ int wxGetSingleChoiceIndex(const wxString& message,
int n,
const wxString& choices[],
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200,
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT,
int initialSelection = 0);
@@ -374,22 +392,22 @@ wxString wxGetSingleChoice(const wxString& message,
const wxString& caption,
const wxArrayString& aChoices,
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT,
int initialSelection = 0);
wxString wxGetSingleChoice(const wxString& message,
const wxString& caption,
int n,
const wxString& choices[],
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT,
int initialSelection = 0);
@@ -427,11 +445,11 @@ wxString wxGetSingleChoiceData(const wxString& message,
const wxArrayString& aChoices,
const wxString& client_data[],
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT,
int initialSelection = 0);
wxString wxGetSingleChoiceData(const wxString& message,
@@ -440,11 +458,11 @@ wxString wxGetSingleChoiceData(const wxString& message,
const wxString& choices[],
const wxString& client_data[],
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT,
int initialSelection = 0);
void* wxGetSingleChoiceData(const wxString& message,
@@ -494,11 +512,11 @@ int wxGetSelectedChoices(wxArrayInt& selections,
const wxString& caption,
const wxArrayString& aChoices,
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200);
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT);
int wxGetSelectedChoices(wxArrayInt& selections,
const wxString& message,
@@ -506,11 +524,11 @@ int wxGetSelectedChoices(wxArrayInt& selections,
int n,
const wxString& choices[],
wxWindow* parent = NULL,
int x = -1,
int y = -1,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = true,
int width = 150,
int height = 200);
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT);
//@}