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

Changed documentation const convention for non-objects; added some manual files

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@92 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1998-06-14 12:11:50 +00:00
parent 4efd74436a
commit eaaa6a06a2
53 changed files with 1882 additions and 1260 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/latex/wx/bbutton.tex
View File

@@ -42,9 +42,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxBitmapButton}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp \func{}{wxBitmapButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxBU\_AUTODRAW}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}} \param{long}{ style = wxBU\_AUTODRAW}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
Constructor, creating and showing a button. Constructor, creating and showing a button.
@@ -89,9 +89,9 @@ Destructor, destroying the button.
\membersection{wxBitmapButton::Create}\label{wxbitmapbuttoncreate} \membersection{wxBitmapButton::Create}\label{wxbitmapbuttoncreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
Button creation function for two-step creation. For more details, see \helpref{wxBitmapButton::wxBitmapButton}{wxbitmapbuttonconstr}. Button creation function for two-step creation. For more details, see \helpref{wxBitmapButton::wxBitmapButton}{wxbitmapbuttonconstr}.

20
docs/latex/wx/bitmap.tex
View File

@@ -28,16 +28,16 @@ Default constructor.
Copy constructors. Copy constructors.
\func{}{wxBitmap}{\param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{}{wxBitmap}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a bitmap from the given data, which can be of arbitrary type. Creates a bitmap from the given data, which can be of arbitrary type.
\func{}{wxBitmap}{\param{const char}{ bits[]}, \param{const int}{ width}, \param{const int}{ height}\\ \func{}{wxBitmap}{\param{const char}{ bits[]}, \param{int}{ width}, \param{int}{ height}\\
\param{const int}{ depth = 1}} \param{int}{ depth = 1}}
Creates a bitmap from an array of bits. Creates a bitmap from an array of bits.
\func{}{wxBitmap}{\param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{}{wxBitmap}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a new bitmap. Creates a new bitmap.
@@ -45,7 +45,7 @@ Creates a new bitmap.
Creates a bitmap from XPM data. Creates a bitmap from XPM data.
\func{}{wxBitmap}{\param{const wxString\& }{name}, \param{const long}{ type}} \func{}{wxBitmap}{\param{const wxString\& }{name}, \param{long}{ type}}
Loads a bitmap from a file or resource. Loads a bitmap from a file or resource.
@@ -158,12 +158,12 @@ This function is called by wxWindows on exit.
\membersection{wxBitmap::Create} \membersection{wxBitmap::Create}
\func{virtual bool}{Create}{\param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a fresh bitmap. If the final argument is omitted, the display depth of Creates a fresh bitmap. If the final argument is omitted, the display depth of
the screen is used. the screen is used.
\func{virtual bool}{Create}{\param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a bitmap from the given data, which can be of arbitrary type. Creates a bitmap from the given data, which can be of arbitrary type.
@@ -304,7 +304,7 @@ of a given handler class in an application session.}
\membersection{wxBitmap::LoadFile}\label{wxbitmaploadfile} \membersection{wxBitmap::LoadFile}\label{wxbitmaploadfile}
\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const long}{ type}} \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
Loads a bitmap from a file or resource. Loads a bitmap from a file or resource.
@@ -556,7 +556,7 @@ Destroys the wxBitmapHandler object.
\membersection{wxBitmapHandler::Create} \membersection{wxBitmapHandler::Create}
\func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a bitmap from the given data, which can be of arbitrary type. The wxBitmap object {\it bitmap} is Creates a bitmap from the given data, which can be of arbitrary type. The wxBitmap object {\it bitmap} is
manipulated by this function. manipulated by this function.
@@ -600,7 +600,7 @@ Gets the bitmap type associated with this handler.
\membersection{wxBitmapHandler::LoadFile}\label{wxbitmaphandlerloadfile} \membersection{wxBitmapHandler::LoadFile}\label{wxbitmaphandlerloadfile}
\func{bool}{LoadFile}{\param{wxBitmap* }{bitmap}, \param{const wxString\&}{ name}, \param{const long}{ type}} \func{bool}{LoadFile}{\param{wxBitmap* }{bitmap}, \param{const wxString\&}{ name}, \param{long}{ type}}
Loads a bitmap from a file or resource, putting the resulting data into {\it bitmap}. Loads a bitmap from a file or resource, putting the resulting data into {\it bitmap}.

10
docs/latex/wx/brush.tex
View File

@@ -47,11 +47,11 @@ TODO: an overview for wxBrush.
Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
return FALSE. return FALSE.
\func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{const int}{ style}} \func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{int}{ style}}
Constructs a brush from a colour object and style. Constructs a brush from a colour object and style.
\func{}{wxBrush}{\param{const wxString\& }{colourName}, \param{const int}{ style}} \func{}{wxBrush}{\param{const wxString\& }{colourName}, \param{int}{ style}}
Constructs a brush from a colour name and style. Constructs a brush from a colour name and style.
@@ -210,7 +210,7 @@ same for both platforms.
\membersection{wxBrush::SetStyle}\label{wxbrushsetstyle} \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle}
\func{void}{SetStyle}{\param{const int}{ style}} \func{void}{SetStyle}{\param{int}{ style}}
Sets the brush style. Sets the brush style.
@@ -314,12 +314,12 @@ Used internally by wxWindows to add a brush to the list.
\membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush} \membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush}
\func{wxBrush *}{FindOrCreateBrush}{\param{const wxColour\& }{colour}, \param{const int}{ style}} \func{wxBrush *}{FindOrCreateBrush}{\param{const wxColour\& }{colour}, \param{int}{ style}}
Finds a brush with the specified attributes and returns it, else creates a new brush, adds it Finds a brush with the specified attributes and returns it, else creates a new brush, adds it
to the brush list, and returns it. to the brush list, and returns it.
\func{wxBrush *}{FindOrCreateBrush}{\param{const wxString\& }{colourName}, \param{const int}{ style}} \func{wxBrush *}{FindOrCreateBrush}{\param{const wxString\& }{colourName}, \param{int}{ style}}
Finds a brush with the specified attributes and returns it, else creates a new brush, adds it Finds a brush with the specified attributes and returns it, else creates a new brush, adds it
to the brush list, and returns it. to the brush list, and returns it.

8
docs/latex/wx/button.tex
View File

@@ -30,9 +30,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxButton}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp \func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
Constructor, creating and showing a button. Constructor, creating and showing a button.
@@ -67,9 +67,9 @@ Destructor, destroying the button.
\membersection{wxButton::Create}\label{wxbuttoncreate} \membersection{wxButton::Create}\label{wxbuttoncreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
Button creation function for two-step creation. For more details, see \helpref{wxButton::wxButton}{wxbuttonconstr}. Button creation function for two-step creation. For more details, see \helpref{wxButton::wxButton}{wxbuttonconstr}.

4
docs/latex/wx/checkbox.tex
View File

@@ -28,7 +28,7 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxCheckBox}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxCheckBox}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
\param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
@@ -65,7 +65,7 @@ Destructor, destroying the checkbox.
\membersection{wxCheckBox::Create}\label{wxcheckboxcreate} \membersection{wxCheckBox::Create}\label{wxcheckboxcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
\param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}

18
docs/latex/wx/choice.tex
View File

@@ -29,10 +29,10 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
Constructor, creating and showing a choice. Constructor, creating and showing a choice.
@@ -85,10 +85,10 @@ Clears the strings from the choice item.
\membersection{wxChoice::Create}\label{wxchoicecreate} \membersection{wxChoice::Create}\label{wxchoicecreate}
\func{bool}{Create}{\param{wxWindow *}{parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``choice"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}
Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}. Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}.
@@ -124,7 +124,7 @@ Gets the id (position) of the selected string, or -1 if there is no selection.
\membersection{wxChoice::GetString}\label{wxchoicegetstring} \membersection{wxChoice::GetString}\label{wxchoicegetstring}
\constfunc{wxString}{GetString}{\param{const int}{ n}} \constfunc{wxString}{GetString}{\param{int}{ n}}
Returns the string at the given position. Returns the string at the given position.
@@ -150,7 +150,7 @@ Returns the number of strings in the choice control.
\membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns} \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
\func{void}{SetColumns}{\param{const int}{ n = 1}} \func{void}{SetColumns}{\param{int}{ n = 1}}
Sets the number of columns in this choice item. Sets the number of columns in this choice item.
@@ -164,7 +164,7 @@ This is implemented for Motif only.
\membersection{wxChoice::SetSelection}\label{wxchoicesetselection} \membersection{wxChoice::SetSelection}\label{wxchoicesetselection}
\func{void}{SetSelection}{\param{const int}{ n}} \func{void}{SetSelection}{\param{int}{ n}}
Sets the choice by passing the desired string position. Sets the choice by passing the desired string position.

6
docs/latex/wx/classes.tex
View File

@@ -45,6 +45,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
\input command.tex \input command.tex
\input cmdevent.tex \input cmdevent.tex
\input cmdproc.tex \input cmdproc.tex
\input conditn.tex
\input control.tex \input control.tex
\input cursor.tex \input cursor.tex
\input database.tex \input database.tex
@@ -103,6 +104,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
\input mouseevt.tex \input mouseevt.tex
\input moveevt.tex \input moveevt.tex
\input mltchdlg.tex \input mltchdlg.tex
\input mutex.tex
\input node.tex \input node.tex
\input object.tex \input object.tex
\input pagedlg.tex \input pagedlg.tex
@@ -143,10 +145,13 @@ $$\image{14cm;0cm}{wxclass.ps}$$
\input sysclevt.tex \input sysclevt.tex
\input settings.tex \input settings.tex
\input tab.tex \input tab.tex
\input tabctrl.tex
\input tabevent.tex
\input taskbar.tex \input taskbar.tex
\input text.tex \input text.tex
\input textdlg.tex \input textdlg.tex
\input valtext.tex \input valtext.tex
\input thread.tex
\input time.tex \input time.tex
\input timer.tex \input timer.tex
\input toolbar.tex \input toolbar.tex
@@ -156,6 +161,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
\input upduievt.tex \input upduievt.tex
\input validatr.tex \input validatr.tex
\input view.tex \input view.tex
\input wave.tex
\input window.tex \input window.tex
\input windowdc.tex \input windowdc.tex

4
docs/latex/wx/colour.tex
View File

@@ -164,7 +164,7 @@ The default colour is black.
\membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour} \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour}
\constfunc{wxColour\&}{GetCustomColour}{\param{const int}{ i}} \constfunc{wxColour\&}{GetCustomColour}{\param{int}{ i}}
Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should
be an integer between 0 and 15. be an integer between 0 and 15.
@@ -190,7 +190,7 @@ The default colour is black.
\membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour} \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
\func{void}{SetColour}{\param{const int}{ i}, \param{const wxColour\&}{ colour}} \func{void}{SetColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}}
Sets the {\it i}th custom colour for the colour dialog. {\it i} should Sets the {\it i}th custom colour for the colour dialog. {\it i} should
be an integer between 0 and 15. be an integer between 0 and 15.

28
docs/latex/wx/combobox.tex
View File

@@ -38,10 +38,10 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}}
Constructor, creating and showing a combobox. Constructor, creating and showing a combobox.
@@ -101,10 +101,10 @@ Clears all strings from the combobox.
\membersection{wxComboBox::Create}\label{wxcomboboxcreate} \membersection{wxComboBox::Create}\label{wxcomboboxcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}}
Creates the combobox for two-step construction. Derived classes Creates the combobox for two-step construction. Derived classes
should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxconstr}\rtfsp should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxconstr}\rtfsp
@@ -124,7 +124,7 @@ Copies the selected text to the clipboard and removes the selection.
\membersection{wxComboBox::Delete}\label{wxcomboboxdelete} \membersection{wxComboBox::Delete}\label{wxcomboboxdelete}
\func{void}{Delete}{\param{const int}{ n}} \func{void}{Delete}{\param{int}{ n}}
Deletes an item from the combobox. Deletes an item from the combobox.
@@ -148,7 +148,7 @@ The position if found, or -1 if not found.
\membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata} \membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata}
\constfunc{char*}{GetClientData}{\param{const int}{ n}} \constfunc{char*}{GetClientData}{\param{int}{ n}}
Returns a pointer to the client data associated with the given item (if any). Returns a pointer to the client data associated with the given item (if any).
@@ -220,7 +220,7 @@ Pastes text from the clipboard to the text field.
\membersection{wxComboBox::Replace}\label{wxcomboboxreplace} \membersection{wxComboBox::Replace}\label{wxcomboboxreplace}
\func{void}{Replace}{\param{const long}{ from}, \param{const long}{ to}, \param{const wxString\& }{text}} \func{void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{text}}
Replaces the text between two positions with the given text, in the combobox text field. Replaces the text between two positions with the given text, in the combobox text field.
@@ -234,7 +234,7 @@ Replaces the text between two positions with the given text, in the combobox tex
\membersection{wxComboBox::Remove}\label{wxcomboboxremove} \membersection{wxComboBox::Remove}\label{wxcomboboxremove}
\func{void}{Remove}{\param{const long}{ from}, \param{const long}{ to}} \func{void}{Remove}{\param{long}{ from}, \param{long}{ to}}
Removes the text between the two positions in the combobox text field. Removes the text between the two positions in the combobox text field.
@@ -246,7 +246,7 @@ Removes the text between the two positions in the combobox text field.
\membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata} \membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata}
\func{void}{SetClientData}{\param{const int}{ n}, \param{char* }{data}} \func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}}
Associates the given client data pointer with the given item. Associates the given client data pointer with the given item.
@@ -258,7 +258,7 @@ Associates the given client data pointer with the given item.
\membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint} \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint}
\func{void}{SetInsertionPoint}{\param{const long}{ pos}} \func{void}{SetInsertionPoint}{\param{long}{ pos}}
Sets the insertion point in the combobox text field. Sets the insertion point in the combobox text field.
@@ -274,11 +274,11 @@ Sets the insertion point at the end of the combobox text field.
\membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection} \membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection}
\func{void}{SetSelection}{\param{const int}{ n}} \func{void}{SetSelection}{\param{int}{ n}}
Selects the given item in the combobox list. Selects the given item in the combobox list.
\func{void}{SetSelection}{\param{const long}{ from}, \param{const long}{ to}} \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
Selects the text between the two positions, in the combobox text field. Selects the text between the two positions, in the combobox text field.

61
docs/latex/wx/conditn.tex Normal file
View File

@@ -0,0 +1,61 @@
\section{\class{wxCondition}}\label{wxcondition}
TODO
\wxheading{Derived from}
None.
\wxheading{See also}
\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxCondition::wxCondition}\label{wxconditionconstr}
\func{}{wxCondition}{\void}
Default constructor.
\membersection{wxCondition::\destruct{wxCondition}}
\func{}{\destruct{wxCondition}}{\void}
Destroys the wxCondition object.
\membersection{wxCondition::Broadcast}\label{wxconditionbroadcast}
\func{void}{Broadcast}{\void}
Broadcasts to all waiting objects.
\membersection{wxCondition::Signal}\label{wxconditionsignal}
\func{void}{Signal}{\void}
Signals the object.
\membersection{wxCondition::Wait}\label{wxconditionwait}
\func{void}{Wait}{\param{wxMutex\&}{ mutex}}
Waits indefinitely.
\func{bool}{Wait}{\param{wxMutex\&}{ mutex}, \param{unsigned long}{ sec}, \param{unsigned long}{ nsec}}
Waits until a signal is raised or the timeout has elapsed.
\wxheading{Parameters}
\docparam{mutex}{wxMutex object.}
\docparam{sec}{Timeout in seconds}
\docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).}
\wxheading{Return value}
The second form returns if the signal was raised, or FALSE if there was a timeout.

8
docs/latex/wx/cursor.tex
View File

@@ -33,21 +33,21 @@ global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use
Default constructor. Default constructor.
\func{}{wxCursor}{\param{const char}{ bits[]}, \param{const int }{width}, \func{}{wxCursor}{\param{const char}{ bits[]}, \param{int }{width},
\param{const int }{ height}, \param{const int }{hotSpotX=-1}, \param{const int }{hotSpotY=-1}, \param{const char }{maskBits[]=NULL}} \param{int }{ height}, \param{int }{hotSpotX=-1}, \param{int }{hotSpotY=-1}, \param{const char }{maskBits[]=NULL}}
Constructs a cursor by passing an array of bits (Motif and Xt only). {\it maskBits} is used only under Motif. Constructs a cursor by passing an array of bits (Motif and Xt only). {\it maskBits} is used only under Motif.
If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only). If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only).
\func{}{wxCursor}{\param{const wxString\& }{cursorName}, \param{const long }{type}, \param{const int }{hotSpotX=0}, \param{const int }{hotSpotY=0}} \func{}{wxCursor}{\param{const wxString\& }{cursorName}, \param{long }{type}, \param{int }{hotSpotX=0}, \param{int }{hotSpotY=0}}
Constructs a cursor by passing a string resource name or filename. Constructs a cursor by passing a string resource name or filename.
{\it hotSpotX} and {\it hotSpotY} are currently only used under Windows when loading from an {\it hotSpotX} and {\it hotSpotY} are currently only used under Windows when loading from an
icon file, to specify the cursor hotspot relative to the top left of the image. icon file, to specify the cursor hotspot relative to the top left of the image.
\func{}{wxCursor}{\param{const int}{ cursorId}} \func{}{wxCursor}{\param{int}{ cursorId}}
Constructs a cursor using a cursor identifier. Constructs a cursor using a cursor identifier.

32
docs/latex/wx/date.tex
View File

@@ -22,11 +22,11 @@ Default constructor.
Copy constructor. Copy constructor.
\func{}{wxDate}{\param{const int}{ month}, \param{const int}{ day}, \param{const int}{ year}} \func{}{wxDate}{\param{int}{ month}, \param{int}{ day}, \param{int}{ year}}
Constructor taking month, day and year. Constructor taking month, day and year.
\func{}{wxDate}{\param{const long}{ julian}} \func{}{wxDate}{\param{long}{ julian}}
Constructor taking an integer representing the Julian date. This is the number of days since Constructor taking an integer representing the Julian date. This is the number of days since
1st January 4713 B.C., so to convert from the number of days since 1st January 1901, 1st January 4713 B.C., so to convert from the number of days since 1st January 1901,
@@ -59,25 +59,25 @@ Destructor.
\membersection{wxDate::AddMonths}\label{wxdateaddmonths} \membersection{wxDate::AddMonths}\label{wxdateaddmonths}
\func{wxDate\&}{AddMonths}{\param{const int}{ months=1}} \func{wxDate\&}{AddMonths}{\param{int}{ months=1}}
Adds the given number of months to the date, returning a reference to `this'. Adds the given number of months to the date, returning a reference to `this'.
\membersection{wxDate::AddWeeks}\label{wxdateaddweeks} \membersection{wxDate::AddWeeks}\label{wxdateaddweeks}
\func{wxDate\&}{AddWeeks}{\param{const int}{ weeks=1}} \func{wxDate\&}{AddWeeks}{\param{int}{ weeks=1}}
Adds the given number of weeks to the date, returning a reference to `this'. Adds the given number of weeks to the date, returning a reference to `this'.
\membersection{wxDate::AddYears}\label{wxdateaddyears} \membersection{wxDate::AddYears}\label{wxdateaddyears}
\func{wxDate\&}{AddYears}{\param{const int}{ years=1}} \func{wxDate\&}{AddYears}{\param{int}{ years=1}}
Adds the given number of months to the date, returning a reference to `this'. Adds the given number of months to the date, returning a reference to `this'.
\membersection{wxDate::FormatDate}\label{wxdateformatdate} \membersection{wxDate::FormatDate}\label{wxdateformatdate}
\constfunc{wxString}{FormatDate}{\param{const int}{ type=-1}} \constfunc{wxString}{FormatDate}{\param{int}{ type=-1}}
Formats the date according to {\it type} if not -1, or according Formats the date according to {\it type} if not -1, or according
to the current display type if -1. to the current display type if -1.
@@ -202,11 +202,11 @@ Returns TRUE if the year of this date is a leap year.
Sets the date to current system date, returning a reference to `this'. Sets the date to current system date, returning a reference to `this'.
\func{wxDate\&}{Set}{\param{const long}{ julian}} \func{wxDate\&}{Set}{\param{long}{ julian}}
Sets the date to the given Julian date, returning a reference to `this'. Sets the date to the given Julian date, returning a reference to `this'.
\func{wxDate\&}{Set}{\param{const int}{ month}, \param{const int}{ day}, \param{const int}{ year}} \func{wxDate\&}{Set}{\param{int}{ month}, \param{int}{ day}, \param{int}{ year}}
Sets the date to the given date, returning a reference to `this'. Sets the date to the given date, returning a reference to `this'.
@@ -218,7 +218,7 @@ Sets the date to the given date, returning a reference to `this'.
\membersection{wxDate::SetFormat}\label{wxdatesetformat} \membersection{wxDate::SetFormat}\label{wxdatesetformat}
\func{void}{SetFormat}{\param{const int}{ format}} \func{void}{SetFormat}{\param{int}{ format}}
Sets the current format type. Sets the current format type.
@@ -237,7 +237,7 @@ Sets the current format type.
\membersection{wxDate::SetOption}\label{wxdatesetoption} \membersection{wxDate::SetOption}\label{wxdatesetoption}
\func{int}{SetOption}{\param{const int}{ option}, \param{const bool}{ enable=TRUE}} \func{int}{SetOption}{\param{int}{ option}, \param{const bool}{ enable=TRUE}}
Enables or disables an option for formatting. Enables or disables an option for formatting.
@@ -259,17 +259,17 @@ Conversion operator, to convert wxDate to wxString by calling FormatDate.
\membersection{wxDate::operator $+$}\label{wxdateplus} \membersection{wxDate::operator $+$}\label{wxdateplus}
\func{wxDate}{operator $+$}{\param{const long}{ i}} \func{wxDate}{operator $+$}{\param{long}{ i}}
\func{wxDate}{operator $+$}{\param{const int}{ i}} \func{wxDate}{operator $+$}{\param{int}{ i}}
Adds an integer number of days to the date, returning a date. Adds an integer number of days to the date, returning a date.
\membersection{wxDate::operator $-$}\label{wxdateminus} \membersection{wxDate::operator $-$}\label{wxdateminus}
\func{wxDate}{operator $-$}{\param{const long}{ i}} \func{wxDate}{operator $-$}{\param{long}{ i}}
\func{wxDate}{operator $-$}{\param{const int}{ i}} \func{wxDate}{operator $-$}{\param{int}{ i}}
Subtracts an integer number of days from the date, returning a date. Subtracts an integer number of days from the date, returning a date.
@@ -279,14 +279,14 @@ Subtracts one date from another, return the number of intervening days.
\membersection{wxDate::operator $+=$}\label{wxdateplusequals} \membersection{wxDate::operator $+=$}\label{wxdateplusequals}
\func{wxDate\&}{operator $+=$}{\param{const long}{ i}} \func{wxDate\&}{operator $+=$}{\param{long}{ i}}
Postfix operator: adds an integer number of days to the date, returning Postfix operator: adds an integer number of days to the date, returning
a reference to `this' date. a reference to `this' date.
\membersection{wxDate::operator $-=$}\label{wxdateminusequals} \membersection{wxDate::operator $-=$}\label{wxdateminusequals}
\func{wxDate\&}{operator $-=$}{\param{const long}{ i}} \func{wxDate\&}{operator $-=$}{\param{long}{ i}}
Postfix operator: subtracts an integer number of days from the date, returning Postfix operator: subtracts an integer number of days from the date, returning
a reference to `this' date. a reference to `this' date.

10
docs/latex/wx/dialog.tex
View File

@@ -53,11 +53,11 @@ See also \helpref{Generic window styles}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxDialog}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxDialog}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title},\rtfsp \param{const wxString\& }{title},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp \param{long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp
\param{const wxString\& }{name = ``dialogBox"}} \param{const wxString\& }{name = ``dialogBox"}}
Constructor. Constructor.
@@ -94,7 +94,7 @@ Destructor. Deletes any child windows before deleting the physical window.
\membersection{wxDialog::Centre}\label{wxdialogcentre} \membersection{wxDialog::Centre}\label{wxdialogcentre}
\func{void}{Centre}{\param{const int}{ direction = wxBOTH}} \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
Centres the dialog box on the display. Centres the dialog box on the display.
@@ -104,11 +104,11 @@ Centres the dialog box on the display.
\membersection{wxDialog::Create}\label{wxdialogcreate} \membersection{wxDialog::Create}\label{wxdialogcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title},\rtfsp \param{const wxString\& }{title},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp \param{long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp
\param{const wxString\& }{name = ``dialogBox"}} \param{const wxString\& }{name = ``dialogBox"}}
Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogconstr}\rtfsp Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogconstr}\rtfsp

10
docs/latex/wx/font.tex
View File

@@ -23,7 +23,7 @@ a window's text.
Default constructor. Default constructor.
\func{}{wxFont}{\param{const int}{ pointSize}, \param{const int}{ family}, \param{const int}{ style}, \param{const int}{ weight}, \func{}{wxFont}{\param{int}{ pointSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight},
\param{const bool}{ underline = FALSE}, \param{const wxString\& }{faceName = ""}} \param{const bool}{ underline = FALSE}, \param{const wxString\& }{faceName = ""}}
Creates a font object. Creates a font object.
@@ -173,7 +173,7 @@ and then for a font belonging to the same family.
\membersection{wxFont::SetFamily}\label{wxfontsetfamily} \membersection{wxFont::SetFamily}\label{wxfontsetfamily}
\func{void}{SetFamily}{\param{const int}{ family}} \func{void}{SetFamily}{\param{int}{ family}}
Sets the font family. Sets the font family.
@@ -197,7 +197,7 @@ Sets the font family.
\membersection{wxFont::SetPointSize}\label{wxfontsetpointsize} \membersection{wxFont::SetPointSize}\label{wxfontsetpointsize}
\func{void}{SetPointSize}{\param{const int}{ pointSize}} \func{void}{SetPointSize}{\param{int}{ pointSize}}
Sets the point size. Sets the point size.
@@ -211,7 +211,7 @@ Sets the point size.
\membersection{wxFont::SetStyle}\label{wxfontsetstyle} \membersection{wxFont::SetStyle}\label{wxfontsetstyle}
\func{void}{SetStyle}{\param{const int}{ style}} \func{void}{SetStyle}{\param{int}{ style}}
Sets the font style. Sets the font style.
@@ -239,7 +239,7 @@ Sets underlining.
\membersection{wxFont::SetWeight}\label{wxfontsetweight} \membersection{wxFont::SetWeight}\label{wxfontsetweight}
\func{void}{SetWeight}{\param{const int}{ weight}} \func{void}{SetWeight}{\param{int}{ weight}}
Sets the font weight. Sets the font weight.

14
docs/latex/wx/frame.tex
View File

@@ -47,7 +47,7 @@ frame to respond to system close events, for example so that related data and su
Default constructor. Default constructor.
\func{}{wxFrame}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}
@@ -92,7 +92,7 @@ Destructor. Destroys all child windows and menu bar if present.
\membersection{wxFrame::Centre}\label{wxframecentre} \membersection{wxFrame::Centre}\label{wxframecentre}
\func{void}{Centre}{\param{const int}{ direction = wxBOTH}} \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
Centres the frame on the display. Centres the frame on the display.
@@ -112,7 +112,7 @@ Simulate a menu command.
\membersection{wxFrame::Create}\label{wxframecreate} \membersection{wxFrame::Create}\label{wxframecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}
@@ -122,7 +122,7 @@ for further details.
\membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar} \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
\func{virtual bool}{CreateStatusBar}{\param{const int}{ number = 1}} \func{virtual bool}{CreateStatusBar}{\param{int}{ number = 1}}
Creates a status bar at the bottom of the frame. Creates a status bar at the bottom of the frame.
@@ -269,7 +269,7 @@ If you call wxFrame::LoadAccelerators, you need to override this function e.g.
\membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar} \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
\func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{const int }{number}} \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number}}
Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}. Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}.
@@ -390,7 +390,7 @@ Note that it is not possible to call this function twice for the same frame obje
\membersection{wxFrame::SetStatusText}\label{wxframesetstatustext} \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
\func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{const int}{ number = 0}} \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}
Sets the status bar text and redraws the status bar. Sets the status bar text and redraws the status bar.
@@ -410,7 +410,7 @@ Use an empty string to clear the status bar.
\membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths} \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths}
\func{virtual void}{SetStatusWidths}{\param{const int}{ n}, \param{const int *}{widths}} \func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}
Sets the widths of the fields in the status bar. Sets the widths of the fields in the status bar.

20
docs/latex/wx/gauge.tex
View File

@@ -33,9 +33,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxGauge}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxGauge}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}} \param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
Constructor, creating and showing a gauge. Constructor, creating and showing a gauge.
@@ -72,9 +72,9 @@ Destructor, destroying the gauge.
\membersection{wxGauge::Create}\label{wxgaugecreate} \membersection{wxGauge::Create}\label{wxgaugecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}} \param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugeconstr}\rtfsp Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugeconstr}\rtfsp
for further details. for further details.
@@ -129,7 +129,7 @@ Returns the current position of the gauge.
\membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface} \membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}
\func{void}{SetBezelFace}{\param{const int }{width}} \func{void}{SetBezelFace}{\param{int }{width}}
Sets the 3D bezel face width. Sets the 3D bezel face width.
@@ -143,7 +143,7 @@ Windows only, not for {\bf wxGA\_PROGRESSBAR}.
\membersection{wxGauge::SetRange}\label{wxgaugesetrange} \membersection{wxGauge::SetRange}\label{wxgaugesetrange}
\func{void}{SetRange}{\param{const int }{range}} \func{void}{SetRange}{\param{int }{range}}
Sets the range (maximum value) of the gauge. Sets the range (maximum value) of the gauge.
@@ -153,7 +153,7 @@ Sets the range (maximum value) of the gauge.
\membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth} \membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
\func{void}{SetShadowWidth}{\param{const int }{width}} \func{void}{SetShadowWidth}{\param{int }{width}}
Sets the 3D shadow width. Sets the 3D shadow width.
@@ -163,7 +163,7 @@ Windows only, not for {\bf wxGA\_PROGRESSBAR}.
\membersection{wxGauge::SetValue}\label{wxgaugesetvalue} \membersection{wxGauge::SetValue}\label{wxgaugesetvalue}
\func{void}{SetValue}{\param{const int }{pos}} \func{void}{SetValue}{\param{int }{pos}}
Sets the position of the gauge. Sets the position of the gauge.

4
docs/latex/wx/grid.tex
View File

@@ -23,8 +23,8 @@ See also \helpref{window styles overview}{windowstyles}.
\membersection{wxGrid::wxGrid}\label{wxgridconstr} \membersection{wxGrid::wxGrid}\label{wxgridconstr}
\func{void}{wxGrid}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxPoint\&}{ pos}, \func{void}{wxGrid}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxPoint\&}{ pos},
\rtfsp\param{const wxSize\&}{ size}, \param{const long}{ style=0}, \param{const wxString\& }{name="grid"}} \rtfsp\param{const wxSize\&}{ size}, \param{long}{ style=0}, \param{const wxString\& }{name="grid"}}
Constructor. Before using a wxGrid object, you must call CreateGrid to set up the required rows and columns. Constructor. Before using a wxGrid object, you must call CreateGrid to set up the required rows and columns.

16
docs/latex/wx/icon.tex
View File

@@ -61,16 +61,16 @@ Default constructor.
Copy constructors. Copy constructors.
\func{}{wxIcon}{\param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{}{wxIcon}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates an icon from the given data, which can be of arbitrary type. Creates an icon from the given data, which can be of arbitrary type.
\func{}{wxIcon}{\param{const char}{ bits[]}, \param{const int}{ width}, \param{const int}{ height}\\ \func{}{wxIcon}{\param{const char}{ bits[]}, \param{int}{ width}, \param{int}{ height}\\
\param{const int}{ depth = 1}} \param{int}{ depth = 1}}
Creates an icon from an array of bits. Creates an icon from an array of bits.
\func{}{wxIcon}{\param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{}{wxIcon}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a new icon. Creates a new icon.
@@ -78,7 +78,7 @@ Creates a new icon.
Creates an icon from XPM data. Creates an icon from XPM data.
\func{}{wxIcon}{\param{const wxString\& }{name}, \param{const long}{ type}} \func{}{wxIcon}{\param{const wxString\& }{name}, \param{long}{ type}}
Loads an icon from a file or resource. Loads an icon from a file or resource.
@@ -171,12 +171,12 @@ Do not delete an icon that is selected into a memory device context.
\begin{comment} \begin{comment}
\membersection{wxIcon::Create}\label{wxiconcreate} \membersection{wxIcon::Create}\label{wxiconcreate}
\func{virtual bool}{Create}{\param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates a fresh icon. If the final argument is omitted, the display depth of Creates a fresh icon. If the final argument is omitted, the display depth of
the screen is used. the screen is used.
\func{virtual bool}{Create}{\param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}} \func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
Creates an icon from the given data, which can be of arbitrary type. Creates an icon from the given data, which can be of arbitrary type.
@@ -233,7 +233,7 @@ Gets the width of the icon in pixels.
\membersection{wxIcon::LoadFile}\label{wxiconloadfile} \membersection{wxIcon::LoadFile}\label{wxiconloadfile}
\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const long}{ type}} \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
Loads an icon from a file or resource. Loads an icon from a file or resource.

18
docs/latex/wx/imaglist.tex
View File

@@ -24,8 +24,8 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec
Default constructor. Default constructor.
\func{}{wxImageList}{\param{const int }{width}, \param{const int }{height}, \param{const bool }{mask = TRUE},\rtfsp \func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp
\param{const int }{initialCount = 1}} \param{int }{initialCount = 1}}
Constructor specifying the image size, whether image masks should be created, and the initial size of the list. Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
@@ -77,15 +77,15 @@ The original bitmap or icon is not affected by the {\bf Add} operation, and can
\membersection{wxImageList::Create}\label{wximagelistcreate} \membersection{wxImageList::Create}\label{wximagelistcreate}
\func{bool}{Create}{\param{const int }{width}, \param{const int }{height}, \param{const bool }{mask = TRUE},\rtfsp \func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp
\param{const int }{initialCount = 1}} \param{int }{initialCount = 1}}
Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details. Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details.
\membersection{wxImageList::Draw}\label{wximagelistdraw} \membersection{wxImageList::Draw}\label{wximagelistdraw}
\func{bool}{Draw}{\param{const int}{ index}, \param{wxDC\&}{ dc}, \param{const int }{x},\rtfsp \func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp
\param{const int }{x}, \param{const int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp \param{int }{x}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp
\param{const bool }{solidBackground = FALSE}} \param{const bool }{solidBackground = FALSE}}
Draws a specified image onto a device context. Draws a specified image onto a device context.
@@ -121,7 +121,7 @@ Returns the number of images in the list.
\membersection{wxImageList::Remove}\label{wximagelistremove} \membersection{wxImageList::Remove}\label{wximagelistremove}
\func{bool}{Remove}{\param{const int}{ index}} \func{bool}{Remove}{\param{int}{ index}}
Removes the image at the given position. Removes the image at the given position.
@@ -133,11 +133,11 @@ Removes all the images in the list.
\membersection{wxImageList::Replace}\label{wximagelistreplace} \membersection{wxImageList::Replace}\label{wximagelistreplace}
\func{bool}{Replace}{\param{const int}{ index}, \param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}} \func{bool}{Replace}{\param{int}{ index}, \param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}}
Replaces the existing image with the new image. Replaces the existing image with the new image.
\func{bool}{Replace}{\param{const int}{ index}, \param{const wxIcon\&}{ icon}} \func{bool}{Replace}{\param{int}{ index}, \param{const wxIcon\&}{ icon}}
Replaces the existing image with the new image. Replaces the existing image with the new image.

26
docs/latex/wx/listbox.tex
View File

@@ -49,10 +49,10 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxListBox}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
Constructor, creating and showing a list box. Constructor, creating and showing a list box.
@@ -112,10 +112,10 @@ Clears all strings from the list box.
\membersection{wxListBox::Create}\label{wxlistboxcreate} \membersection{wxListBox::Create}\label{wxlistboxcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
Creates the listbox for two-step construction. See \helpref{wxListBox::wxListBox}{wxlistboxconstr}\rtfsp Creates the listbox for two-step construction. See \helpref{wxListBox::wxListBox}{wxlistboxconstr}\rtfsp
for further details. for further details.
@@ -160,7 +160,7 @@ The zero-based position of the item, or -1 if the string was not found.
\membersection{wxListBox::GetClientData}\label{wxlistboxgetclientdata} \membersection{wxListBox::GetClientData}\label{wxlistboxgetclientdata}
\constfunc{char*}{GetClientData}{\param{const int}{ n}} \constfunc{char*}{GetClientData}{\param{int}{ n}}
Returns a pointer to the client data associated with the given item (if any). Returns a pointer to the client data associated with the given item (if any).
@@ -219,7 +219,7 @@ Use this with a multiple selection listbox.
\membersection{wxListBox::GetString}\label{wxlistboxgetstring} \membersection{wxListBox::GetString}\label{wxlistboxgetstring}
\constfunc{wxString}{GetString}{\param{const int}{ n}} \constfunc{wxString}{GetString}{\param{int}{ n}}
Returns the string at the given position. Returns the string at the given position.
@@ -253,7 +253,7 @@ Returns the number of items in the listbox.
\membersection{wxListBox::Selected}\label{wxlistboxselected} \membersection{wxListBox::Selected}\label{wxlistboxselected}
\constfunc{bool}{Selected}{\param{const int}{ n}} \constfunc{bool}{Selected}{\param{int}{ n}}
Determines whether an item is selected. Determines whether an item is selected.
@@ -267,7 +267,7 @@ TRUE if the given item is selected, FALSE otherwise.
\membersection{wxListBox::Set}\label{wxlistboxset} \membersection{wxListBox::Set}\label{wxlistboxset}
\func{void}{Set}{\param{const int}{ n}, \param{const wxString*}{ choices}} \func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}}
Clears the list box and adds the given strings. Clears the list box and adds the given strings.
@@ -284,7 +284,7 @@ after this function has been called.
\membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata} \membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata}
\func{void}{SetClientData}{\param{const int}{ n}, \param{char* }{data}} \func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}}
Associates the given client data pointer with the given item. Associates the given client data pointer with the given item.
@@ -310,7 +310,7 @@ Set the specified item to be the first visible item.
\membersection{wxListBox::SetSelection}\label{wxlistboxsetselection} \membersection{wxListBox::SetSelection}\label{wxlistboxsetselection}
\func{void}{SetSelection}{\param{const int}{ n}, \param{const bool }{select = TRUE}} \func{void}{SetSelection}{\param{int}{ n}, \param{const bool }{select = TRUE}}
Selects or deselects the given item. Selects or deselects the given item.
@@ -322,7 +322,7 @@ Selects or deselects the given item.
\membersection{wxListBox::SetString}\label{wxlistboxsetstring} \membersection{wxListBox::SetString}\label{wxlistboxsetstring}
\func{void}{SetString}{\param{const int}{ n}, \param{const wxString\& }{ string}} \func{void}{SetString}{\param{int}{ n}, \param{const wxString\& }{ string}}
Sets the string value of an item. Sets the string value of an item.

78
docs/latex/wx/listctrl.tex
View File

@@ -48,9 +48,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxListCtrl}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxListCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}} \param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
Constructor, creating and showing a list control. Constructor, creating and showing a list control.
@@ -83,7 +83,7 @@ Destructor, destroying the list control.
\membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange} \membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange}
\func{bool}{Arrange}{\param{const int }{flag = wxLIST\_ALIGN\_DEFAULT}} \func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}}
Arranges the items in icon or small icon view. {\it flag} is one of: Arranges the items in icon or small icon view. {\it flag} is one of:
@@ -97,15 +97,15 @@ Arranges the items in icon or small icon view. {\it flag} is one of:
\membersection{wxListCtrl::Create}\label{wxlistctrlcreate} \membersection{wxListCtrl::Create}\label{wxlistctrlcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}} \param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details. Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
\membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem} \membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem}
\func{bool}{DeleteItem}{\param{const long }{item}} \func{bool}{DeleteItem}{\param{long }{item}}
Deletes the specified item. Deletes the specified item.
@@ -117,49 +117,49 @@ Deletes all the items in the list control.
\membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn} \membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
\func{bool}{DeleteColumn}{\param{const int }{col}} \func{bool}{DeleteColumn}{\param{int }{col}}
Deletes a column. Deletes a column.
\membersection{wxListCtrl::Edit}\label{wxlistctrledit} \membersection{wxListCtrl::Edit}\label{wxlistctrledit}
\func{wxTextCtrl\&}{Edit}{\param{const long }{item}} \func{wxTextCtrl\&}{Edit}{\param{long }{item}}
Starts editing a label. Starts editing a label.
\membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible} \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible}
\func{bool}{EnsureVisible}{\param{const long }{item}} \func{bool}{EnsureVisible}{\param{long }{item}}
Ensures this item is visible. Ensures this item is visible.
\membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem} \membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem}
\func{long}{FindItem}{\param{const long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = FALSE}} \func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = FALSE}}
Find an item whose label matches this string, starting from the item after {\it start} or Find an item whose label matches this string, starting from the item after {\it start} or
the beginning if {\it start} is -1. the beginning if {\it start} is -1.
\func{long}{FindItem}{\param{const long }{start}, \param{const long }{data}} \func{long}{FindItem}{\param{long }{start}, \param{long }{data}}
Find an item whose data matches this data, starting from the item after {\it start} or Find an item whose data matches this data, starting from the item after {\it start} or
the beginning if 'start' is -1. the beginning if 'start' is -1.
\func{long}{FindItem}{\param{const long }{start}, \param{const wxPoint\& }{pt}, \param{const int }{direction}} \func{long}{FindItem}{\param{long }{start}, \param{const wxPoint\& }{pt}, \param{int }{direction}}
Find an item nearest this position in the specified direction, starting from Find an item nearest this position in the specified direction, starting from
the item after {\it start} or the beginning if {\it start} is -1. the item after {\it start} or the beginning if {\it start} is -1.
\membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn} \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
\constfunc{bool}{GetColumn}{\param{const int }{col}, \param{wxListItem\& }{item}} \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
Gets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more Gets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
information. information.
\membersection{wxListCtrl::GetColumnWidth}\label{wxlistctrlgetcolumnwidth} \membersection{wxListCtrl::GetColumnWidth}\label{wxlistctrlgetcolumnwidth}
\constfunc{int}{GetColumnWidth}{\param{const int }{col}} \constfunc{int}{GetColumnWidth}{\param{int }{col}}
Gets the column width (report view only). Gets the column width (report view only).
@@ -180,7 +180,7 @@ Gets the edit control for editing labels.
\membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist} \membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist}
\constfunc{wxImageList*}{GetImageList}{\param{const int }{which}} \constfunc{wxImageList*}{GetImageList}{\param{int }{which}}
Returns the specified image list. {\it which} may be one of: Returns the specified image list. {\it which} may be one of:
@@ -200,19 +200,19 @@ information.
\membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata} \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}
\constfunc{long}{GetItemData}{\param{const long }{item}} \constfunc{long}{GetItemData}{\param{long }{item}}
Gets the application-defined data associated with this item. Gets the application-defined data associated with this item.
\membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition} \membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition}
\constfunc{bool}{GetItemPosition}{\param{const long }{item}, \param{wxPoint\& }{pos}} \constfunc{bool}{GetItemPosition}{\param{long }{item}, \param{wxPoint\& }{pos}}
Returns the position of the item, in icon or small icon view. Returns the position of the item, in icon or small icon view.
\membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect} \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
\constfunc{bool}{GetItemRect}{\param{const long }{item}, \param{wxRect\& }{rect}, \param{const int }{code = wxLIST\_RECT\_BOUNDS}} \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
Returns the rectangle representing the item's size and position, in client coordinates. Returns the rectangle representing the item's size and position, in client coordinates.
@@ -220,7 +220,7 @@ Returns the rectangle representing the item's size and position, in client coord
\membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
\constfunc{int}{GetItemState}{\param{const long }{item}, \param{const long }{stateMask}} \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
@@ -242,13 +242,13 @@ view, otherwise the large icon view.
\membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext} \membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext}
\constfunc{wxString}{GetItemText}{\param{const long }{item}} \constfunc{wxString}{GetItemText}{\param{long }{item}}
Gets the item text for this item. Gets the item text for this item.
\membersection{wxListCtrl::GetNextItem}\label{wxlistctrlgetnextitem} \membersection{wxListCtrl::GetNextItem}\label{wxlistctrlgetnextitem}
\constfunc{long}{GetNextItem}{\param{const long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}} \constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}}
Searches for an item with the given goemetry or state, starting from {\it item}. {\it item} can be -1 Searches for an item with the given goemetry or state, starting from {\it item}. {\it item} can be -1
to find the first item that matches the specified flags. to find the first item that matches the specified flags.
@@ -320,12 +320,12 @@ wxLIST\_HITTEST\_ONITEMSTATEICON.}
\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
\func{long}{InsertColumn}{\param{const long }{col}, \param{wxListItem\& }{info}} \func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}}
For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
\func{long}{InsertColumn}{\param{const long }{col}, \param{const wxString\& }{heading}, \param{const int }{format = wxLIST\_FORMAT\_LEFT},\rtfsp \func{long}{InsertColumn}{\param{long }{col}, \param{const wxString\& }{heading}, \param{int }{format = wxLIST\_FORMAT\_LEFT},\rtfsp
\param{const int }{width = -1}} \param{int }{width = -1}}
For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
@@ -336,21 +336,21 @@ For list view mode (only), inserts a column. For more details, see \helpref{wxLi
Inserts an item, returning the index of the new item if successful, Inserts an item, returning the index of the new item if successful,
-1 otherwise. -1 otherwise.
\func{long}{InsertItem}{\param{const long }{index}, \param{const wxString\& }{label}} \func{long}{InsertItem}{\param{long }{index}, \param{const wxString\& }{label}}
Inserts a string item. Inserts a string item.
\func{long}{InsertItem}{\param{const long }{index}, \param{const int }{imageIndex}} \func{long}{InsertItem}{\param{long }{index}, \param{int }{imageIndex}}
Inserts an image item. Inserts an image item.
\func{long}{InsertItem}{\param{const long }{index}, \param{const wxString\& }{label}, \param{const int }{imageIndex}} \func{long}{InsertItem}{\param{long }{index}, \param{const wxString\& }{label}, \param{int }{imageIndex}}
Insert an image/string item. Insert an image/string item.
\membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist} \membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist}
\func{bool}{ScrollList}{\param{const int }{dx}, \param{const int }{dy}} \func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}}
Scrolls the list control. If in icon, small icon or report view mode, Scrolls the list control. If in icon, small icon or report view mode,
dx specifies the number of pixels to scroll. If in list view mode, dx dx specifies the number of pixels to scroll. If in list view mode, dx
@@ -368,14 +368,14 @@ wxWindow class).
\membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn} \membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn}
\func{bool}{SetColumn}{\param{const int }{col}, \param{wxListItem\& }{item}} \func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
Sets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more Sets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
information. information.
\membersection{wxListCtrl::SetColumnWidth}\label{wxlistctrlsetcolumnwidth} \membersection{wxListCtrl::SetColumnWidth}\label{wxlistctrlsetcolumnwidth}
\func{bool}{SetColumnWidth}{\param{const int }{col}, \param{const int }{width}} \func{bool}{SetColumnWidth}{\param{int }{col}, \param{int }{width}}
Sets the column width (report view only). Sets the column width (report view only).
@@ -383,7 +383,7 @@ Sets the column width (report view only).
\membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist} \membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist}
\func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{const int }{which}} \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}
Sets the image list associated with the control. {\it which} is one of Sets the image list associated with the control. {\it which} is one of
wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented). wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented).
@@ -434,32 +434,32 @@ The {\bf m\_stateMask} and {\bf m\_state} members take flags from the following:
\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state.} \twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state.}
\end{twocollist} \end{twocollist}
\func{long}{SetItem}{\param{const long }{index}, \param{const int }{col}, \param{const wxString\& }{label}, \param{const int }{imageId = -1}} \func{long}{SetItem}{\param{long }{index}, \param{int }{col}, \param{const wxString\& }{label}, \param{int }{imageId = -1}}
Sets a string field at a particular column. Sets a string field at a particular column.
\membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata} \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata}
\func{bool}{SetItemData}{\param{const long }{item}, \param{long }{data}} \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}
Associates application-defined data with this item. Associates application-defined data with this item.
\membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage} \membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage}
\func{bool}{SetItemImage}{\param{const long }{item}, \param{const int }{image}, \param{const int }{selImage}} \func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}}
Sets the unselected and selected images associated with the item. The images are indices into the Sets the unselected and selected images associated with the item. The images are indices into the
image list associated with the list control. image list associated with the list control.
\membersection{wxListCtrl::SetItemPosition}\label{wxlistctrlsetitemposition} \membersection{wxListCtrl::SetItemPosition}\label{wxlistctrlsetitemposition}
\func{bool}{SetItemPosition}{\param{const long }{item}, \param{const wxPoint\& }{pos}} \func{bool}{SetItemPosition}{\param{long }{item}, \param{const wxPoint\& }{pos}}
Sets the position of the item, in icon or small icon view. Sets the position of the item, in icon or small icon view.
\membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate} \membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate}
\func{bool}{SetItemState}{\param{const long }{item}, \param{const long }{state}, \param{const long }{stateMask}} \func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}}
Sets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. Sets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
@@ -467,13 +467,13 @@ The {\bf stateMask} indicates which state flags are valid.
\membersection{wxListCtrl::SetItemText}\label{wxlistctrlsetitemtext} \membersection{wxListCtrl::SetItemText}\label{wxlistctrlsetitemtext}
\func{void}{SetItemText}{\param{const long }{item}, \param{const wxString\& }{text}} \func{void}{SetItemText}{\param{long }{item}, \param{const wxString\& }{text}}
Sets the item text for this item. Sets the item text for this item.
\membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle} \membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle}
\func{void}{SetSingleStyle}{\param{const long }{style}, \param{const bool }{add = TRUE}} \func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = TRUE}}
Adds or removes a single window style. Adds or removes a single window style.
@@ -485,7 +485,7 @@ Sets the text colour of the list control.
\membersection{wxListCtrl::SetWindowStyleFlag}\label{wxlistctrlsetwindowstyleflag} \membersection{wxListCtrl::SetWindowStyleFlag}\label{wxlistctrlsetwindowstyleflag}
\func{void}{SetWindowStyleFlag}{\param{const long }{style}} \func{void}{SetWindowStyleFlag}{\param{long }{style}}
Sets the whole window style. Sets the whole window style.

8
docs/latex/wx/mdi.tex
View File

@@ -57,7 +57,7 @@ frame's own menubar will be displayed.
Default constructor. Default constructor.
\func{}{wxMDIChildFrame}{\param{wxMDIParentFrame* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxMDIChildFrame}{\param{wxMDIParentFrame* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}
@@ -111,7 +111,7 @@ Activates this MDI child frame.
\membersection{wxMDIChildFrame::Create}\label{wxmdichildframecreate} \membersection{wxMDIChildFrame::Create}\label{wxmdichildframecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}
@@ -281,7 +281,7 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxMDIParentFrame}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxMDIParentFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}
@@ -373,7 +373,7 @@ Arranges the MDI child windows in a cascade.
\membersection{wxMDIParentFrame::Create}\label{wxmdiparentframecreate} \membersection{wxMDIParentFrame::Create}\label{wxmdiparentframecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}

48
docs/latex/wx/menu.tex
View File

@@ -55,12 +55,12 @@ Destructor, destroying the menu.
\membersection{wxMenu::Append}\label{wxmenuappend} \membersection{wxMenu::Append}\label{wxmenuappend}
\func{void}{Append}{\param{const int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp \func{void}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
\param{const bool}{ checkable = FALSE}} \param{const bool}{ checkable = FALSE}}
Adds a string item to the end of the menu. Adds a string item to the end of the menu.
\func{void}{Append}{\param{const int}{ id}, \param{const wxString\& }{ item}, \param{wxMenu *}{subMenu},\rtfsp \func{void}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{wxMenu *}{subMenu},\rtfsp
\param{const wxString\& }{helpString = ""}} \param{const wxString\& }{helpString = ""}}
Adds a pull-right submenu to the end of the menu. Adds a pull-right submenu to the end of the menu.
@@ -115,7 +115,7 @@ Inserts a break in a menu, causing the next appended item to appear in a new col
\membersection{wxMenu::Check}\label{wxmenucheck} \membersection{wxMenu::Check}\label{wxmenucheck}
\func{void}{Check}{\param{const int}{ id}, \param{const bool}{ check}} \func{void}{Check}{\param{int}{ id}, \param{const bool}{ check}}
Checks or unchecks the menu item. Checks or unchecks the menu item.
@@ -131,7 +131,7 @@ Checks or unchecks the menu item.
\membersection{wxMenu::Enable}\label{wxmenuenable} \membersection{wxMenu::Enable}\label{wxmenuenable}
\func{void}{Enable}{\param{const int}{ id}, \param{const bool}{ enable}} \func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}}
Enables or disables (greys out) a menu item. Enables or disables (greys out) a menu item.
@@ -170,7 +170,7 @@ before matching.
\membersection{wxMenu::FindItemForId}\label{wxmenufinditemforid} \membersection{wxMenu::FindItemForId}\label{wxmenufinditemforid}
\constfunc{wxMenuItem*}{FindItemForId}{\param{const int}{ id}} \constfunc{wxMenuItem*}{FindItemForId}{\param{int}{ id}}
Finds the menu item object associated with the given menu item identifier. Finds the menu item object associated with the given menu item identifier.
@@ -188,7 +188,7 @@ Returns the menu item object, or NULL if it is not found.
\membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring} \membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}
\constfunc{wxString}{GetHelpString}{\param{const int}{ id}} \constfunc{wxString}{GetHelpString}{\param{int}{ id}}
Returns the help string associated with a menu item. Returns the help string associated with a menu item.
@@ -207,7 +207,7 @@ item was not found.
\membersection{wxMenu::GetLabel}\label{wxmenugetlabel} \membersection{wxMenu::GetLabel}\label{wxmenugetlabel}
\constfunc{wxString}{GetLabel}{\param{const int}{ id}} \constfunc{wxString}{GetLabel}{\param{int}{ id}}
Returns a menu item label. Returns a menu item label.
@@ -239,7 +239,7 @@ This is relevant only to popup menus.
\membersection{wxMenu::IsChecked}\label{wxmenuischecked} \membersection{wxMenu::IsChecked}\label{wxmenuischecked}
\constfunc{bool}{IsChecked}{\param{const int}{ id}} \constfunc{bool}{IsChecked}{\param{int}{ id}}
Determines whether a menu item is checked. Determines whether a menu item is checked.
@@ -257,7 +257,7 @@ TRUE if the menu item is checked, FALSE otherwise.
\membersection{wxMenu::IsEnabled}\label{wxmenuisenabled} \membersection{wxMenu::IsEnabled}\label{wxmenuisenabled}
\constfunc{bool}{IsEnabled}{\param{const int}{ id}} \constfunc{bool}{IsEnabled}{\param{int}{ id}}
Determines whether a menu item is enabled. Determines whether a menu item is enabled.
@@ -275,7 +275,7 @@ TRUE if the menu item is enabled, FALSE otherwise.
\membersection{wxMenu::SetHelpString}\label{wxmenusethelpstring} \membersection{wxMenu::SetHelpString}\label{wxmenusethelpstring}
\func{void}{SetHelpString}{\param{const int}{ id}, \param{const wxString\& }{helpString}} \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}
Sets an item's help string. Sets an item's help string.
@@ -291,7 +291,7 @@ Sets an item's help string.
\membersection{wxMenu::SetLabel}\label{wxmenusetlabel} \membersection{wxMenu::SetLabel}\label{wxmenusetlabel}
\func{void}{SetLabel}{\param{const int}{ id}, \param{const wxString\& }{label}} \func{void}{SetLabel}{\param{int}{ id}, \param{const wxString\& }{label}}
Sets the label of a menu item. Sets the label of a menu item.
@@ -349,7 +349,7 @@ that contains the menu bar.
Default constructor. Default constructor.
\func{void}{wxMenuBar}{\param{const int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}} \func{void}{wxMenuBar}{\param{int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}}
Construct a menu bar from arrays of menus and titles. Construct a menu bar from arrays of menus and titles.
@@ -382,7 +382,7 @@ Adds the item to the end of the menu bar.
\membersection{wxMenuBar::Check}\label{wxmenubarcheck} \membersection{wxMenuBar::Check}\label{wxmenubarcheck}
\func{void}{Check}{\param{const int}{ id}, \param{const bool}{ check}} \func{void}{Check}{\param{int}{ id}, \param{const bool}{ check}}
Checks or unchecks a menu item. Checks or unchecks a menu item.
@@ -399,7 +399,7 @@ with a frame; otherwise, use the wxMenu equivalent call.
\membersection{wxMenuBar::Enable}\label{wxmenubarenable} \membersection{wxMenuBar::Enable}\label{wxmenubarenable}
\func{void}{Enable}{\param{const int}{ id}, \param{const bool}{ enable}} \func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}}
Enables or disables (greys out) a menu item. Enables or disables (greys out) a menu item.
@@ -416,7 +416,7 @@ associated with a frame; otherwise, use the wxMenu equivalent call.
\membersection{wxMenuBar::EnableTop}\label{wxmenubarenabletop} \membersection{wxMenuBar::EnableTop}\label{wxmenubarenabletop}
\func{void}{EnableTop}{\param{const int}{ pos}, \param{const bool}{ enable}} \func{void}{EnableTop}{\param{int}{ pos}, \param{const bool}{ enable}}
Enables or disables a whole menu. Enables or disables a whole menu.
@@ -454,7 +454,7 @@ before matching.
\membersection{wxMenuBar::FindItemById}\label{wxmenubarfinditembyid} \membersection{wxMenuBar::FindItemById}\label{wxmenubarfinditembyid}
\constfunc{wxMenuItem *}{FindItemById}{\param{const int}{ id}} \constfunc{wxMenuItem *}{FindItemById}{\param{int}{ id}}
Finds the menu item object associated with the given menu item identifier, Finds the menu item object associated with the given menu item identifier,
@@ -468,7 +468,7 @@ The found menu item object, or NULL if one was not found.
\membersection{wxMenuBar::GetHelpString}\label{wxmenubargethelpstring} \membersection{wxMenuBar::GetHelpString}\label{wxmenubargethelpstring}
\constfunc{wxString}{GetHelpString}{\param{const int}{ id}} \constfunc{wxString}{GetHelpString}{\param{int}{ id}}
Gets the help string associated with the menu item identifer. Gets the help string associated with the menu item identifer.
@@ -487,7 +487,7 @@ was not found.
\membersection{wxMenuBar::GetLabel}\label{wxmenubargetlabel} \membersection{wxMenuBar::GetLabel}\label{wxmenubargetlabel}
\constfunc{wxString}{GetLabel}{\param{const int}{ id}} \constfunc{wxString}{GetLabel}{\param{int}{ id}}
Gets the label associated with a menu item. Gets the label associated with a menu item.
@@ -505,7 +505,7 @@ Use only after the menubar has been associated with a frame.
\membersection{wxMenuBar::GetLabelTop}\label{wxmenubargetlabeltop} \membersection{wxMenuBar::GetLabelTop}\label{wxmenubargetlabeltop}
\constfunc{wxString}{GetLabelTop}{\param{const int}{ pos}} \constfunc{wxString}{GetLabelTop}{\param{int}{ pos}}
Returns the label of a top-level menu. Returns the label of a top-level menu.
@@ -527,7 +527,7 @@ Use only after the menubar has been associated with a frame.
\membersection{wxMenuBar::IsChecked}\label{wxmenubarischecked} \membersection{wxMenuBar::IsChecked}\label{wxmenubarischecked}
\constfunc{bool}{IsChecked}{\param{const int}{ id}} \constfunc{bool}{IsChecked}{\param{int}{ id}}
Determines whether an item is checked. Determines whether an item is checked.
@@ -541,7 +541,7 @@ TRUE if the item was found and is checked, FALSE otherwise.
\membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled} \membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled}
\constfunc{bool}{IsEnabled}{\param{const int}{ id}} \constfunc{bool}{IsEnabled}{\param{int}{ id}}
Determines whether an item is enabled. Determines whether an item is enabled.
@@ -555,7 +555,7 @@ TRUE if the item was found and is enabled, FALSE otherwise.
\membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring} \membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring}
\func{void}{SetHelpString}{\param{const int}{ id}, \param{const wxString\& }{helpString}} \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}
Sets the help string associated with a menu item. Sets the help string associated with a menu item.
@@ -571,7 +571,7 @@ Sets the help string associated with a menu item.
\membersection{wxMenuBar::SetLabel}\label{wxmenubarsetlabel} \membersection{wxMenuBar::SetLabel}\label{wxmenubarsetlabel}
\func{void}{SetLabel}{\param{const int}{ id}, \param{const wxString\& }{label}} \func{void}{SetLabel}{\param{int}{ id}, \param{const wxString\& }{label}}
Sets the label of a menu item. Sets the label of a menu item.
@@ -591,7 +591,7 @@ Use only after the menubar has been associated with a frame.
\membersection{wxMenuBar::SetLabelTop}\label{wxmenubarsetlabeltop} \membersection{wxMenuBar::SetLabelTop}\label{wxmenubarsetlabeltop}
\func{void}{SetLabelTop}{\param{const int}{ pos}, \param{const wxString\& }{label}} \func{void}{SetLabelTop}{\param{int}{ pos}, \param{const wxString\& }{label}}
Sets the label of a top-level menu. Sets the label of a top-level menu.

4
docs/latex/wx/minifram.tex
View File

@@ -52,7 +52,7 @@ it behaves like a normal frame.
Default constructor. Default constructor.
\func{}{wxMiniFrame}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxMiniFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}
@@ -96,7 +96,7 @@ Destructor. Destroys all child windows and menu bar if present.
\membersection{wxMiniFrame::Create}\label{wxminiframecreate} \membersection{wxMiniFrame::Create}\label{wxminiframecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
\param{const wxString\& }{name = ``frame"}} \param{const wxString\& }{name = ``frame"}}

85
docs/latex/wx/mutex.tex Normal file
View File

@@ -0,0 +1,85 @@
\section{\class{wxMutex}}\label{wxmutex}
A wxMutex controls mutual exclusion, to prevent two or more threads accessing
the same piece of code.
\wxheading{Derived from}
None.
\wxheading{See also}
\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxMutex::wxMutex}\label{wxmutexconstr}
\func{}{wxMutex}{\void}
Default constructor.
\membersection{wxMutex::\destruct{wxMutex}}
\func{}{\destruct{wxMutex}}{\void}
Destroys the wxMutex object.
\membersection{wxMutex::IsLocked}\label{wxmutexislocked}
\constfunc{bool}{IsLocked}{\void}
Returns TRUE if the mutex is locked, FALSE otherwise.
\membersection{wxMutex::Lock}\label{wxmutexlock}
\func{wxMutexError}{Lock}{\void}
Locks the mutex object.
\wxheading{Return value}
One of:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf MUTEX\_NO\_ERROR}}{There was no error.}
\twocolitem{{\bf MUTEX\_DEAD\_LOCK}}{A deadlock situation was detected.}
\twocolitem{{\bf MUTEX\_BUSY}}{The thread is already running.}
\end{twocollist}
\membersection{wxMutex::TryLock}\label{wxmutextrylock}
\func{wxMutexError}{TryLock}{\void}
Tries to lock the mutex object. If it can't, returns immediately with an error.
\wxheading{Return value}
One of:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf MUTEX\_NO\_ERROR}}{There was no error.}
\twocolitem{{\bf MUTEX\_DEAD\_LOCK}}{A deadlock situation was detected.}
\twocolitem{{\bf MUTEX\_BUSY}}{The thread is already running.}
\end{twocollist}
\membersection{wxMutex::Unlock}\label{wxmutexunlock}
\func{wxMutexError}{Unlock}{\void}
Unlocks the mutex object.
\wxheading{Return value}
One of:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf MUTEX\_NO\_ERROR}}{There was no error.}
\twocolitem{{\bf MUTEX\_DEAD\_LOCK}}{A deadlock situation was detected.}
\twocolitem{{\bf MUTEX\_BUSY}}{The thread is already running.}
\end{twocollist}

6
docs/latex/wx/palette.tex
View File

@@ -30,7 +30,7 @@ Copy constructor. This uses reference counting so is a cheap operation.
Copy constructor. This uses reference counting so is a cheap operation. Copy constructor. This uses reference counting so is a cheap operation.
\func{}{wxPalette}{\param{const int}{ n}, \param{const unsigned char* }{red},\\ \func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\
\param{const unsigned char* }{green}, \param{const unsigned char* }{blue}} \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
Creates a palette from arrays of size {\it n}, one for each Creates a palette from arrays of size {\it n}, one for each
@@ -60,7 +60,7 @@ Destructor.
\membersection{wxPalette::Create}\label{wxpalettecreate} \membersection{wxPalette::Create}\label{wxpalettecreate}
\func{bool}{Create}{\param{const int}{ n}, \param{const unsigned char* }{red},\rtfsp \func{bool}{Create}{\param{int}{ n}, \param{const unsigned char* }{red},\rtfsp
\param{const unsigned char* }{green}, \param{const unsigned char* }{blue}} \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
Creates a palette from arrays of size {\it n}, one for each Creates a palette from arrays of size {\it n}, one for each
@@ -109,7 +109,7 @@ The nearest palette index.
\membersection{wxPalette::GetRGB}\label{wxpalettegetrgb} \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb}
\constfunc{bool}{GetPixel}{\param{const int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp \constfunc{bool}{GetPixel}{\param{int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp
\param{const unsigned char* }{blue}} \param{const unsigned char* }{blue}}
Returns RGB values for a given palette index. Returns RGB values for a given palette index.

8
docs/latex/wx/panel.tex
View File

@@ -35,10 +35,10 @@ A panel may be loaded from a wxWindows resource file (extension {\tt wxr}).
Default constructor. Default constructor.
\func{}{wxPanel}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxPanel}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxTAB\_TRAVERSAL},\rtfsp \param{long}{ style = wxTAB\_TRAVERSAL},\rtfsp
\param{const wxString\& }{name = ``panel"}} \param{const wxString\& }{name = ``panel"}}
Constructor. Constructor.
@@ -73,10 +73,10 @@ Destructor. Deletes any child windows before deleting the physical window.
\membersection{wxPanel::Create}\label{wxpanelcreate} \membersection{wxPanel::Create}\label{wxpanelcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxTAB\_TRAVERSAL},\rtfsp \param{long}{ style = wxTAB\_TRAVERSAL},\rtfsp
\param{const wxString\& }{name = ``panel"}} \param{const wxString\& }{name = ``panel"}}
Used for two-step panel construction. See \helpref{wxPanel::wxPanel}{wxpanelconstr}\rtfsp Used for two-step panel construction. See \helpref{wxPanel::wxPanel}{wxpanelconstr}\rtfsp

14
docs/latex/wx/pen.tex
View File

@@ -35,15 +35,15 @@ TODO: an overview for wxPen.
Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will
return FALSE. return FALSE.
\func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{const int}{ width}, \param{const int}{ style}} \func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width}, \param{int}{ style}}
Constructs a pen from a colour object, pen width and style. Constructs a pen from a colour object, pen width and style.
\func{}{wxPen}{\param{const wxString\& }{colourName}, \param{const int}{ width}, \param{const int}{ style}} \func{}{wxPen}{\param{const wxString\& }{colourName}, \param{int}{ width}, \param{int}{ style}}
Constructs a pen from a colour name, pen width and style. Constructs a pen from a colour name, pen width and style.
\func{}{wxPen}{\param{const wxBitmap\&}{ stipple}, \param{const int}{ width}} \func{}{wxPen}{\param{const wxBitmap\&}{ stipple}, \param{int}{ width}}
Constructs a stippled pen from a stipple bitmap and a width. Constructs a stippled pen from a stipple bitmap and a width.
@@ -216,7 +216,7 @@ Sets the pen cap style, which may be one of {\bf wxCAP\_ROUND}, {\bf wxCAP\_PROJ
\func{void}{SetColour}{\param{const wxString\& }{colourName}} \func{void}{SetColour}{\param{const wxString\& }{colourName}}
\func{void}{SetColour}{\param{const int}{ red}, \param{const int}{ green}, \param{const int}{ blue}} \func{void}{SetColour}{\param{int}{ red}, \param{int}{ green}, \param{int}{ blue}}
The pen's colour is changed to the given colour. The pen's colour is changed to the given colour.
@@ -272,7 +272,7 @@ Set the pen style.
\membersection{wxPen::SetWidth}\label{wxpensetwidth} \membersection{wxPen::SetWidth}\label{wxpensetwidth}
\func{void}{SetWidth}{\param{const int}{ width}} \func{void}{SetWidth}{\param{int}{ width}}
Sets the pen width. Sets the pen width.
@@ -353,12 +353,12 @@ Used internally by wxWindows to add a pen to the list.
\membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen} \membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen}
\func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{const int}{ width}, \param{const int}{ style}} \func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{int}{ width}, \param{int}{ style}}
Finds a pen with the specified attributes and returns it, else creates a new pen, adds it Finds a pen with the specified attributes and returns it, else creates a new pen, adds it
to the pen list, and returns it. to the pen list, and returns it.
\func{wxPen*}{FindOrCreatePen}{\param{const wxString\& }{colourName}, \param{const int}{ width}, \param{const int}{ style}} \func{wxPen*}{FindOrCreatePen}{\param{const wxString\& }{colourName}, \param{int}{ width}, \param{int}{ style}}
Finds a pen with the specified attributes and returns it, else creates a new pen, adds it Finds a pen with the specified attributes and returns it, else creates a new pen, adds it
to the pen list, and returns it. to the pen list, and returns it.

2
docs/latex/wx/print.tex
View File

@@ -318,7 +318,7 @@ achieving the correct scaling for the page.
\membersection{wxPrinterDC::wxPrinterDC} \membersection{wxPrinterDC::wxPrinterDC}
\func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output}, \func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output},
\param{const bool }{interactive = TRUE}, \param{const int }{orientation = wxPORTRAIT}} \param{const bool }{interactive = TRUE}, \param{int }{orientation = wxPORTRAIT}}
Constructor. With empty strings for the first three arguments, the default printer dialog is Constructor. With empty strings for the first three arguments, the default printer dialog is
displayed. {\it device} indicates the type of printer and {\it output} displayed. {\it device} indicates the type of printer and {\it output}

24
docs/latex/wx/radiobox.tex
View File

@@ -34,10 +34,10 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp \func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp \param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
\param{const int}{ majorDimension = 0}, \param{const long}{ style = wxRA\_HORIZONTAL},\rtfsp \param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_HORIZONTAL},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``radioBox"}} \param{const wxString\& }{name = ``radioBox"}}
@@ -80,10 +80,10 @@ Destructor, destroying the radiobox item.
\membersection{wxRadioBox::Create}\label{wxradioboxcreate} \membersection{wxRadioBox::Create}\label{wxradioboxcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp \param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
\param{const int}{ majorDimension = 0}, \param{const long}{ style = wxRA\_HORIZONTAL},\rtfsp \param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_HORIZONTAL},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``radioBox"}} \param{const wxString\& }{name = ``radioBox"}}
@@ -96,7 +96,7 @@ for further details.
Enables or disables the entire radiobox. Enables or disables the entire radiobox.
\func{void}{Enable}{\param{const int}{ n}, \param{const bool}{ enable}} \func{void}{Enable}{\param{int}{ n}, \param{const bool}{ enable}}
Enables or disables an individual button in the radiobox. Enables or disables an individual button in the radiobox.
@@ -123,7 +123,7 @@ Finds a button matching the given string, returning the position if found, or
Returns the radiobox label. Returns the radiobox label.
\constfunc{wxString}{GetLabel}{\param{const int }{n}} \constfunc{wxString}{GetLabel}{\param{int }{n}}
Returns the label for the given button. Returns the label for the given button.
@@ -159,7 +159,7 @@ Returns the number of buttons in the radiobox.
Sets the radiobox label. Sets the radiobox label.
\func{void}{SetLabel}{\param{const int }{n}, \param{const wxString\&}{ label}} \func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}}
Sets a label for a radio button. Sets a label for a radio button.
@@ -171,7 +171,7 @@ Sets a label for a radio button.
\membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection} \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
\func{void}{SetSelection}{\param{const int}{ n}} \func{void}{SetSelection}{\param{int}{ n}}
Sets a button by passing the desired string position. Sets a button by passing the desired string position.
@@ -195,7 +195,7 @@ Sets a button by passing the desired string.
Shows or hides the entire radiobox. Shows or hides the entire radiobox.
\func{void}{Show}{\param{const int }{item}, \param{const bool}{ show}} \func{void}{Show}{\param{int }{item}, \param{const bool}{ show}}
Shows or hides individual buttons. Shows or hides individual buttons.
@@ -207,7 +207,7 @@ Shows or hides individual buttons.
\membersection{wxRadioBox::GetString}\label{wxradioboxgetstring} \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
\constfunc{wxString}{GetString}{\param{const int}{ n}} \constfunc{wxString}{GetString}{\param{int}{ n}}
Returns the label for the button at the given position. Returns the label for the button at the given position.

8
docs/latex/wx/radiobut.tex
View File

@@ -29,9 +29,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp \func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0},\rtfsp \param{long}{ style = 0},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``radioButton"}} \param{const wxString\& }{name = ``radioButton"}}
@@ -67,9 +67,9 @@ Destructor, destroying the radio button item.
\membersection{wxRadioButton::Create}\label{wxradiobuttoncreate} \membersection{wxRadioButton::Create}\label{wxradiobuttoncreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0},\rtfsp \param{long}{ style = 0},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``radioButton"}} \param{const wxString\& }{name = ``radioButton"}}

10
docs/latex/wx/rect.tex
View File

@@ -18,7 +18,7 @@ A class for manipulating rectangles.
Default constructor. Default constructor.
\func{}{wxRect}{\param{const int}{ x}, \param{const int}{ y}, \param{const int}{ width}, \param{const int}{ height}} \func{}{wxRect}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}}
Creates a wxRect object from x, y, width and height values. Creates a wxRect object from x, y, width and height values.
@@ -116,25 +116,25 @@ Gets the y member.
\membersection{wxRect::SetHeight}\label{wxrectsetheight} \membersection{wxRect::SetHeight}\label{wxrectsetheight}
\func{void}{SetHeight}{\param{const int}{ height}} \func{void}{SetHeight}{\param{int}{ height}}
Sets the height. Sets the height.
\membersection{wxRect::SetWidth}\label{wxrectsetwidth} \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
\func{void}{SetWidth}{\param{const int}{ width}} \func{void}{SetWidth}{\param{int}{ width}}
Sets the width. Sets the width.
\membersection{wxRect::SetX}\label{wxrectsetx} \membersection{wxRect::SetX}\label{wxrectsetx}
\func{void}{SetX}{\param{const int}{ x}} \func{void}{SetX}{\param{int}{ x}}
Sets the x position. Sets the x position.
\membersection{wxRect::SetY}\label{wxrectsety} \membersection{wxRect::SetY}\label{wxrectsety}
\func{void}{SetY}{\param{const int}{ y}} \func{void}{SetY}{\param{int}{ y}}
Sets the y position. Sets the y position.

22
docs/latex/wx/scrolbar.tex
View File

@@ -76,9 +76,9 @@ functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
Default constructor. Default constructor.
\func{}{wxScrollBar}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxScrollBar}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``scrollBar"}} \param{const wxString\& }{name = ``scrollBar"}}
Constructor, creating and showing a scrollbar. Constructor, creating and showing a scrollbar.
@@ -111,9 +111,9 @@ Destructor, destroying the scrollbar.
\membersection{wxScrollBar::Create}\label{wxscrollbarcreate} \membersection{wxScrollBar::Create}\label{wxscrollbarcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``scrollBar"}} \param{const wxString\& }{name = ``scrollBar"}}
Scrollbar creation function called by the scrollbar constructor. Scrollbar creation function called by the scrollbar constructor.
@@ -164,7 +164,7 @@ Returns the thumb or `view' size.
\begin{comment} \begin{comment}
\membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength} \membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength}
\func{void}{SetObjectLength}{\param{const int}{ objectLength}} \func{void}{SetObjectLength}{\param{int}{ objectLength}}
Sets the object length for the scrollbar. This is the total object size (virtual size). You must Sets the object length for the scrollbar. This is the total object size (virtual size). You must
call \helpref{SetViewLength}{wxscrollbarsetviewlength} {\it before} calling SetObjectLength. call \helpref{SetViewLength}{wxscrollbarsetviewlength} {\it before} calling SetObjectLength.
@@ -189,7 +189,7 @@ contents (the object length).
\membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize} \membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize}
\func{void}{SetPageSize}{\param{const int}{ pageSize}} \func{void}{SetPageSize}{\param{int}{ pageSize}}
Sets the page size for the scrollbar. This is the number of scroll units which are scrolled when the Sets the page size for the scrollbar. This is the number of scroll units which are scrolled when the
user pages down (clicks on the scrollbar outside the thumbtrack area). user pages down (clicks on the scrollbar outside the thumbtrack area).
@@ -209,7 +209,7 @@ At present, this needs to be called {\it before} other set functions.
\membersection{wxScrollBar::SetPosition}\label{wxscrollbarsetposition} \membersection{wxScrollBar::SetPosition}\label{wxscrollbarsetposition}
\func{void}{SetPosition}{\param{const int}{ viewStart}} \func{void}{SetPosition}{\param{int}{ viewStart}}
Sets the position of the scrollbar. Sets the position of the scrollbar.
@@ -223,9 +223,9 @@ Sets the position of the scrollbar.
\membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar} \membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar}
\func{virtual void}{SetScrollbar}{\param{const int }{position},\rtfsp \func{virtual void}{SetScrollbar}{\param{int }{position},\rtfsp
\param{const int }{thumbSize}, \param{const int }{range},\rtfsp \param{int }{thumbSize}, \param{int }{range},\rtfsp
\param{const int }{pageSize},\rtfsp \param{int }{pageSize},\rtfsp
\param{const bool }{refresh = TRUE}} \param{const bool }{refresh = TRUE}}
Sets the scrollbar properties. Sets the scrollbar properties.
@@ -280,7 +280,7 @@ from a \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
\begin{comment} \begin{comment}
\membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength} \membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength}
\func{void}{SetViewLength}{\param{const int}{ viewLength}} \func{void}{SetViewLength}{\param{int}{ viewLength}}
Sets the view length for the scrollbar. Sets the view length for the scrollbar.

8
docs/latex/wx/scrolwin.tex
View File

@@ -48,9 +48,9 @@ to build your own scroll behaviour.
Default constructor. Default constructor.
\func{}{wxScrolledWindow}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id = -1},\rtfsp \func{}{wxScrolledWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxHSCROLL \pipe wxVSCROLL}, \param{const wxString\& }{name = ``scrolledWindow"}} \param{long}{ style = wxHSCROLL \pipe wxVSCROLL}, \param{const wxString\& }{name = ``scrolledWindow"}}
Constructor. Constructor.
@@ -84,9 +84,9 @@ Destructor.
\membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate} \membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id = -1},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxHSCROLL \pipe wxVSCROLL}, \param{const wxString\& }{name = ``scrolledWindow"}} \param{long}{ style = wxHSCROLL \pipe wxVSCROLL}, \param{const wxString\& }{name = ``scrolledWindow"}}
Creates the window for two-step construction. Derived classes Creates the window for two-step construction. Derived classes
should call or replace this function. See \helpref{wxScrolledWindow::wxScrolledWindow}{wxscrolledwindowconstr}\rtfsp should call or replace this function. See \helpref{wxScrolledWindow::wxScrolledWindow}{wxscrolledwindowconstr}\rtfsp

28
docs/latex/wx/slider.tex
View File

@@ -43,10 +43,10 @@ See also \helpref{window styles overview}{windowstyles}.
Default slider. Default slider.
\func{}{wxSlider}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const int }{value },\rtfsp \func{}{wxSlider}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{int }{value },\rtfsp
\param{const int}{ minValue}, \param{const int}{ maxValue},\rtfsp \param{int}{ minValue}, \param{int}{ maxValue},\rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxSL\_HORIZONTAL},\rtfsp \param{long}{ style = wxSL\_HORIZONTAL},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``slider"}} \param{const wxString\& }{name = ``slider"}}
@@ -104,10 +104,10 @@ Windows 95 only.
\membersection{wxSlider::Create}\label{wxslidercreate} \membersection{wxSlider::Create}\label{wxslidercreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const int }{value },\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{int }{value },\rtfsp
\param{const int}{ minValue}, \param{const int}{ maxValue},\rtfsp \param{int}{ minValue}, \param{int}{ maxValue},\rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxSL\_HORIZONTAL},\rtfsp \param{long}{ style = wxSL\_HORIZONTAL},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``slider"}} \param{const wxString\& }{name = ``slider"}}
@@ -223,7 +223,7 @@ Gets the current slider value.
\membersection{wxSlider::SetRange}\label{wxslidersetrange} \membersection{wxSlider::SetRange}\label{wxslidersetrange}
\func{void}{SetRange}{\param{const int}{ minValue}, \param{const int}{ maxValue}} \func{void}{SetRange}{\param{int}{ minValue}, \param{int}{ maxValue}}
Sets the minimum and maximum slider values. Sets the minimum and maximum slider values.
@@ -233,7 +233,7 @@ Sets the minimum and maximum slider values.
\membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq} \membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq}
\func{void}{SetTickFreq}{\param{const int }{n}, \param{const int }{pos}} \func{void}{SetTickFreq}{\param{int }{n}, \param{int }{pos}}
Sets the tick mark frequency and position. Sets the tick mark frequency and position.
@@ -254,7 +254,7 @@ Windows 95 only.
\membersection{wxSlider::SetLineSize}\label{wxslidersetlinesize} \membersection{wxSlider::SetLineSize}\label{wxslidersetlinesize}
\func{void}{SetLineSize}{\param{const int }{lineSize}} \func{void}{SetLineSize}{\param{int }{lineSize}}
Sets the line size for the slider. Sets the line size for the slider.
@@ -268,7 +268,7 @@ Sets the line size for the slider.
\membersection{wxSlider::SetPageSize}\label{wxslidersetpagesize} \membersection{wxSlider::SetPageSize}\label{wxslidersetpagesize}
\func{void}{SetPageSize}{\param{const int }{pageSize}} \func{void}{SetPageSize}{\param{int }{pageSize}}
Sets the page size for the slider. Sets the page size for the slider.
@@ -282,7 +282,7 @@ Sets the page size for the slider.
\membersection{wxSlider::SetSelection}\label{wxslidersetselection} \membersection{wxSlider::SetSelection}\label{wxslidersetselection}
\func{void}{SetSelection}{\param{const int }{startPos}, \param{const int }{endPos}} \func{void}{SetSelection}{\param{int }{startPos}, \param{int }{endPos}}
Sets the selection. Sets the selection.
@@ -302,7 +302,7 @@ Windows 95 only.
\membersection{wxSlider::SetThumbLength}\label{wxslidersetthumblength} \membersection{wxSlider::SetThumbLength}\label{wxslidersetthumblength}
\func{void}{SetThumbLength}{\param{const int }{len}} \func{void}{SetThumbLength}{\param{int }{len}}
Sets the slider thumb length. Sets the slider thumb length.
@@ -320,7 +320,7 @@ Windows 95 only.
\membersection{wxSlider::SetTick}\label{wxslidersettick} \membersection{wxSlider::SetTick}\label{wxslidersettick}
\func{void}{SetTick}{\param{const int}{ tickPos}} \func{void}{SetTick}{\param{int}{ tickPos}}
Sets a tick position. Sets a tick position.
@@ -338,7 +338,7 @@ Windows 95 only.
\membersection{wxSlider::SetValue}\label{wxslidersetvalue} \membersection{wxSlider::SetValue}\label{wxslidersetvalue}
\func{void}{SetValue}{\param{const int}{ value}} \func{void}{SetValue}{\param{int}{ value}}
Sets the slider position. Sets the slider position.

2
docs/latex/wx/sngchdlg.tex
View File

@@ -20,7 +20,7 @@ and then pressing OK.
\membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogconstr} \membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogconstr}
\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp \func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption}, \param{const int }{n}, \param{const wxString* }{choices},\rtfsp \param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices},\rtfsp
\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp \param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}} \param{const wxPoint\& }{pos = wxDefaultPosition}}

12
docs/latex/wx/spinbutt.tex
View File

@@ -59,9 +59,9 @@ functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
Default constructor. Default constructor.
\func{}{wxSpinButton}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxSpinButton}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxSP\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{long}{ style = wxSP\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``spinButton"}} \param{const wxString\& }{name = ``spinButton"}}
Constructor, creating and showing a spin button. Constructor, creating and showing a spin button.
@@ -94,9 +94,9 @@ Destructor, destroying the spin button.
\membersection{wxSpinButton::Create}\label{wxspinbuttoncreate} \membersection{wxSpinButton::Create}\label{wxspinbuttoncreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxSP\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{long}{ style = wxSP\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``spinButton"}} \param{const wxString\& }{name = ``spinButton"}}
Scrollbar creation function called by the spin button constructor. Scrollbar creation function called by the spin button constructor.
@@ -134,7 +134,7 @@ Returns the current spin button value.
\membersection{wxSpinButton::SetRange}\label{wxspinbuttonsetrange} \membersection{wxSpinButton::SetRange}\label{wxspinbuttonsetrange}
\func{void}{SetRange}{\param{const int}{ min}, \param{const int}{ max}} \func{void}{SetRange}{\param{int}{ min}, \param{int}{ max}}
Sets the range of the spin button. Sets the range of the spin button.
@@ -150,7 +150,7 @@ Sets the range of the spin button.
\membersection{wxSpinButton::SetValue}\label{wxspinbuttonsetvalue} \membersection{wxSpinButton::SetValue}\label{wxspinbuttonsetvalue}
\func{void}{SetValue}{\param{const int}{ value}} \func{void}{SetValue}{\param{int}{ value}}
Sets the value of the spin button. Sets the value of the spin button.

18
docs/latex/wx/splitter.tex
View File

@@ -32,9 +32,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxSplitterWindow}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id}, \param{int }{x},\rtfsp \func{}{wxSplitterWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{int }{x},\rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}} \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
Constructor for creating the window. Constructor for creating the window.
@@ -76,9 +76,9 @@ Destroys the wxSplitterWindow and its children.
\membersection{wxSplitterWindow::Create}\label{wxsplitterwindowcreate} \membersection{wxSplitterWindow::Create}\label{wxsplitterwindowcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id}, \param{int }{x},\rtfsp \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{int }{x},\rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}} \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
Creation function, for two-step construction. See \helpref{wxSplitterWindow::wxSplitterWindow}{wxsplitterwindowconstr} for Creation function, for two-step construction. See \helpref{wxSplitterWindow::wxSplitterWindow}{wxsplitterwindowconstr} for
details. details.
@@ -195,7 +195,7 @@ may wish to delete the window.
\membersection{wxSplitterWindow::SetSashPosition}\label{wxsplitterwindowsetsashposition} \membersection{wxSplitterWindow::SetSashPosition}\label{wxsplitterwindowsetsashposition}
\func{void}{SetSashPosition}{\param{const int }{position}, \param{const bool}{ redraw = TRUE}} \func{void}{SetSashPosition}{\param{int }{position}, \param{const bool}{ redraw = TRUE}}
Sets the sash position. Sets the sash position.
@@ -215,7 +215,7 @@ Does not currently check for an out-of-range value.
\membersection{wxSplitterWindow::SetMinimumPaneSize}\label{wxsplitterwindowsetminimumpanesize} \membersection{wxSplitterWindow::SetMinimumPaneSize}\label{wxsplitterwindowsetminimumpanesize}
\func{void}{SetMinimumPaneSize}{\param{const int }{paneSize}} \func{void}{SetMinimumPaneSize}{\param{int }{paneSize}}
Sets the minimum pane size. Sets the minimum pane size.
@@ -235,7 +235,7 @@ set a minimum size, for example 20 pixels.
\membersection{wxSplitterWindow::SetSplitMode}\label{wxsplitterwindowsetsplitmode} \membersection{wxSplitterWindow::SetSplitMode}\label{wxsplitterwindowsetsplitmode}
\func{void}{SetSplitMode}{\param{const int }{mode}} \func{void}{SetSplitMode}{\param{int }{mode}}
Sets the split mode. Sets the split mode.
@@ -255,7 +255,7 @@ Only sets the internal variable; does not update the display.
\membersection{wxSplitterWindow::SplitHorizontally}\label{wxsplitterwindowsplithorizontally} \membersection{wxSplitterWindow::SplitHorizontally}\label{wxsplitterwindowsplithorizontally}
\func{bool}{SplitHorizontally}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2}, \func{bool}{SplitHorizontally}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2},
\param{const int}{ sashPosition = -1}} \param{int}{ sashPosition = -1}}
Initializes the top and bottom panes of the splitter window. Initializes the top and bottom panes of the splitter window.
@@ -285,7 +285,7 @@ but the application should check that the window is not currently split using \h
\membersection{wxSplitterWindow::SplitVertically}\label{wxsplitterwindowsplitvertically} \membersection{wxSplitterWindow::SplitVertically}\label{wxsplitterwindowsplitvertically}
\func{bool}{SplitVertically}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2}, \func{bool}{SplitVertically}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2},
\param{const int}{ sashPosition = -1}} \param{int}{ sashPosition = -1}}
Initializes the left and right panes of the splitter window. Initializes the left and right panes of the splitter window.

8
docs/latex/wx/statbmp.tex
View File

@@ -32,9 +32,9 @@ palette problems.
Default constructor. Default constructor.
\func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxStaticBitmap}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxBitmap\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxBitmap\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
Constructor, creating and showing a text control. Constructor, creating and showing a text control.
@@ -60,9 +60,9 @@ Constructor, creating and showing a text control.
\membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate} \membersection{wxStaticBitmap::Create}\label{wxstaticbitmapcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxBitmap\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxBitmap\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBitmap"}}
Creation function, for two-step construction. For details see \helpref{wxStaticBitmap::wxStaticBitmap}{wxstaticbitmapconstr}. Creation function, for two-step construction. For details see \helpref{wxStaticBitmap::wxStaticBitmap}{wxstaticbitmapconstr}.

8
docs/latex/wx/statbox.tex
View File

@@ -28,9 +28,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxStaticBox}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp \func{}{wxStaticBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
Constructor, creating and showing a static box. Constructor, creating and showing a static box.
@@ -62,9 +62,9 @@ Destructor, destroying the group box.
\membersection{wxStaticBox::Create}\label{wxstaticboxcreate} \membersection{wxStaticBox::Create}\label{wxstaticboxcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxconstr}\rtfsp Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxconstr}\rtfsp
for further details. for further details.

8
docs/latex/wx/stattext.tex
View File

@@ -31,9 +31,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxStaticText}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxStaticText}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}
Constructor, creating and showing a text control. Constructor, creating and showing a text control.
@@ -59,9 +59,9 @@ Constructor, creating and showing a text control.
\membersection{wxStaticText::Create}\label{wxstatictextcreate} \membersection{wxStaticText::Create}\label{wxstatictextcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}} \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}
Creation function, for two-step construction. For details see \helpref{wxStaticText::wxStaticText}{wxstatictextconstr}. Creation function, for two-step construction. For details see \helpref{wxStaticText::wxStaticText}{wxstatictextconstr}.

18
docs/latex/wx/statusbr.tex
View File

@@ -31,7 +31,7 @@ from an {\bf OnSize} event handler.
Default constructor. Default constructor.
\func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
\param{const wxString\& }{name = ``statusBar"}} \param{const wxString\& }{name = ``statusBar"}}
@@ -68,7 +68,7 @@ Destructor.
\membersection{wxStatusBar::Create}\label{wxstatusbarcreate} \membersection{wxStatusBar::Create}\label{wxstatusbarcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
\param{const wxString\& }{name = ``statusBar"}} \param{const wxString\& }{name = ``statusBar"}}
@@ -79,7 +79,7 @@ See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarconstr} for details.
\membersection{wxStatusBar::GetFieldRect}\label{wxstatusbargetfieldrect} \membersection{wxStatusBar::GetFieldRect}\label{wxstatusbargetfieldrect}
\constfunc{virtual bool}{GetFieldRect}{\param{const int}{ i}, \param{wxRect\&}{ rect}} \constfunc{virtual bool}{GetFieldRect}{\param{int}{ i}, \param{wxRect\&}{ rect}}
Returns the size and position of a fields internal bounding rectangle. Returns the size and position of a fields internal bounding rectangle.
@@ -105,7 +105,7 @@ Returns the number of fields in the status bar.
\membersection{wxStatusBar::GetStatusText}\label{wxstatusbargetstatustext} \membersection{wxStatusBar::GetStatusText}\label{wxstatusbargetstatustext}
\constfunc{virtual wxString}{GetStatusText}{\param{const int}{ ir = 0}} \constfunc{virtual wxString}{GetStatusText}{\param{int}{ ir = 0}}
Returns the string associated with a status bar field. Returns the string associated with a status bar field.
@@ -123,7 +123,7 @@ The status field string if the field is valid, otherwise the empty string.
\membersection{wxStatusBar::DrawField}\label{wxstatusbardrawfield} \membersection{wxStatusBar::DrawField}\label{wxstatusbardrawfield}
\func{virtual void}{DrawField}{\param{wxDC\& }{dc}, \param{const int }{i}} \func{virtual void}{DrawField}{\param{wxDC\& }{dc}, \param{int }{i}}
Draws a field, including shaded borders and text. Draws a field, including shaded borders and text.
@@ -139,7 +139,7 @@ Draws a field, including shaded borders and text.
\membersection{wxStatusBar::DrawFieldText}\label{wxstatusbardrawfieldtext} \membersection{wxStatusBar::DrawFieldText}\label{wxstatusbardrawfieldtext}
\func{virtual void}{DrawFieldText}{\param{wxDC\& }{dc}, \param{const int }{i}} \func{virtual void}{DrawFieldText}{\param{wxDC\& }{dc}, \param{int }{i}}
Draws a field's text. Draws a field's text.
@@ -186,7 +186,7 @@ and refreshes the window.
\membersection{wxStatusBar::SetFieldsCount}\label{wxstatusbarsetfieldscount} \membersection{wxStatusBar::SetFieldsCount}\label{wxstatusbarsetfieldscount}
\func{virtual void}{SetFieldsCount}{\param{const int}{ number = 1}, \param{const int* }{widths = NULL}} \func{virtual void}{SetFieldsCount}{\param{int}{ number = 1}, \param{int* }{widths = NULL}}
Sets the number of fields, and optionally the field widths. Sets the number of fields, and optionally the field widths.
@@ -200,7 +200,7 @@ field must be -1.}
\membersection{wxStatusBar::SetStatusText}\label{wxstatusbarsetstatustext} \membersection{wxStatusBar::SetStatusText}\label{wxstatusbarsetstatustext}
\func{virtual void}{SetStatusText}{\param{const wxString\& }{text}, \param{const int}{ i = 0}} \func{virtual void}{SetStatusText}{\param{const wxString\& }{text}, \param{int}{ i = 0}}
Sets the text for one field. Sets the text for one field.
@@ -216,7 +216,7 @@ Sets the text for one field.
\membersection{wxStatusBar::SetStatusWidths}\label{wxstatusbarsetstatuswidths} \membersection{wxStatusBar::SetStatusWidths}\label{wxstatusbarsetstatuswidths}
\func{virtual void}{SetStatusWidths}{\param{const int}{ n}, \param{const int *}{widths}} \func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}
Sets the widths of the fields in the status line. Sets the widths of the fields in the status line.

8
docs/latex/wx/tab.tex
View File

@@ -16,9 +16,9 @@ A dialog suitable for handling tabs.
\membersection{wxTabbedDialog::wxTabbedDialog} \membersection{wxTabbedDialog::wxTabbedDialog}
\func{}{wxTabbedDialog}{\param{wxWindow *}{parent}, \param{const wxWindowID }{id}, \func{}{wxTabbedDialog}{\param{wxWindow *}{parent}, \param{wxWindowID }{id},
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},
\param{const long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{const wxString\& }{name="dialogBox"}} \param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{const wxString\& }{name="dialogBox"}}
Constructor. Constructor.
@@ -60,9 +60,9 @@ A panel suitable for handling tabs.
\membersection{wxTabbedPanel::wxTabbedPanel} \membersection{wxTabbedPanel::wxTabbedPanel}
\func{}{wxTabbedPanel}{\param{wxWindow *}{parent}, \param{const wxWindowID}{ id}, \func{}{wxTabbedPanel}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},
\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size}, \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},
\param{const long}{ style=0}, \param{const wxString\& }{name="panel"}} \param{long}{ style=0}, \param{const wxString\& }{name="panel"}}
Constructor. Constructor.

141
docs/latex/wx/tabctrl.tex
View File

@@ -9,6 +9,10 @@ This class represents a tab control, which manages multiple tabs.
\helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject} \helpref{wxObject}{wxobject}
\wxheading{See also}
\helpref{wxTabEvent}{wxtabevent}, \helpref{wxImageList}{wximagelist}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTabCtrl::wxTabCtrl}\label{wxtabctrlconstr} \membersection{wxTabCtrl::wxTabCtrl}\label{wxtabctrlconstr}
@@ -17,8 +21,8 @@ This class represents a tab control, which manages multiple tabs.
Default constructor. Default constructor.
\func{}{wxTabCtrl}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \func{}{wxTabCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
\param{const wxSize\&}{ size}, \param{const long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}} \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}}
Constructs a tab control. Constructs a tab control.
@@ -43,12 +47,24 @@ Destroys the wxTabCtrl object.
\membersection{wxTabCtrl::Create}\label{wxtabctrlcreate} \membersection{wxTabCtrl::Create}\label{wxtabctrlcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
\param{const wxSize\&}{ size}, \param{const long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}} \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}}
Creates a tab control. See \helpref{wxTabCtrl::wxTabCtrl}{wxtabctrlconstr} for a description Creates a tab control. See \helpref{wxTabCtrl::wxTabCtrl}{wxtabctrlconstr} for a description
of the parameters. of the parameters.
\membersection{wxTabCtrl::DeleteAllItems}\label{wxtabctrldeleteallitems}
\func{bool}{DeleteAllItems}{\void}
Deletes all tab items.
\membersection{wxTabCtrl::DeleteItem}\label{wxtabctrldeleteitem}
\func{bool}{DeleteItem}{\param{int}{ item}}
Deletes the specified tab item.
\membersection{wxTabCtrl::GetImageList}\label{wxtabctrlgetimagelist} \membersection{wxTabCtrl::GetImageList}\label{wxtabctrlgetimagelist}
\constfunc{wxImageList*}{GetImageList}{\void} \constfunc{wxImageList*}{GetImageList}{\void}
@@ -65,9 +81,21 @@ Returns the associated image list.
Returns the number of tabs in the tab control. Returns the number of tabs in the tab control.
\membersection{wxTabCtrl::GetItemData}\label{wxtabctrlgetitemdata}
\constfunc{void*}{GetItemData}{\void}
Returns the client data for the given tab.
\membersection{wxTabCtrl::GetItemImage}\label{wxtabctrlgetitemimage}
\constfunc{int}{GetItemImage}{\void}
Returns the image index for the given tab.
\membersection{wxTabCtrl::GetItemRect}\label{wxtabctrlgetitemrect} \membersection{wxTabCtrl::GetItemRect}\label{wxtabctrlgetitemrect}
\constfunc{bool}{GetItemRect}{\param{const int item}, \param{wxRect\&}{ rect}} \constfunc{bool}{GetItemRect}{\param{int }{item}, \param{wxRect\&}{ rect}}
Returns the rectangle bounding the given tab. Returns the rectangle bounding the given tab.
@@ -75,6 +103,12 @@ Returns the rectangle bounding the given tab.
\helpref{wxRect}{wxrect} \helpref{wxRect}{wxrect}
\membersection{wxTabCtrl::GetItemText}\label{wxtabctrlgetitemtext}
\constfunc{wxString}{GetItemText}{\void}
Returns the string for the given tab.
\membersection{wxTabCtrl::GetRowCount}\label{wxtabctrlgetrowcount} \membersection{wxTabCtrl::GetRowCount}\label{wxtabctrlgetrowcount}
\constfunc{bool}{GetRowCount}{\void} \constfunc{bool}{GetRowCount}{\void}
@@ -91,5 +125,102 @@ Returns the index for the currently selected tab.
\helpref{wxTabCtrl::SetSelection}{wxtabctrlsetselection} \helpref{wxTabCtrl::SetSelection}{wxtabctrlsetselection}
\membersection{wxTabCtrl::HitTest}\label{wxtabctrlhittest}
\func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long\&}{ flags}}
Tests whether a tab is at the specified position.
\wxheading{Parameters}
\docparam{pt}{Specifies the point for the hit test.}
\docparam{flags}{Return value for detailed information. One of the following values:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxTAB\_HITTEST\_NOWHERE}}{There was no tab under this point.}
\twocolitem{{\bf wxTAB\_HITTEST\_ONICON}}{The point was over an icon.}
\twocolitem{{\bf wxTAB\_HITTEST\_ONLABEL}}{The point was over a label.}
\twocolitem{{\bf wxTAB\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.}
\end{twocollist}
}
\wxheading{Return value}
Returns the zero-based tab index or -1 if no tab is at the specified position.
\membersection{wxTabCtrl::InsertItem}\label{wxtabctrlinsertitem}
\func{void}{InsertItem}{\param{int}{ item}, \param{const wxString\&}{ text}, \param{int }{imageId = -1},
\param{void*}{ clientData = NULL}}
Inserts a new tab.
\wxheading{Parameters}
\docparam{item}{Specifies the index for the new item.}
\docparam{text}{Specifies the text for the new item.}
\docparam{imageId}{Specifies the optional image index for the new item.}
\docparam{clientData}{Specifies the optional client data for the new item.}
\wxheading{Return value}
TRUE if successful, FALSE otherwise.
\membersection{wxTabCtrl::SetItemData}\label{wxtabctrlsetitemdata}
\func{bool}{SetItemData}{\param{int}{ item}, \param{void*}{ data}}
Sets the client data for a tab.
\membersection{wxTabCtrl::SetItemImage}\label{wxtabctrlsetitemimage}
\func{bool}{SetItemImage}{\param{int}{ item}, \param{int }{image}}
Sets the image index for the given tab. {\it image} is an index into
the image list which was set with \helpref{wxTabCtrl::SetImageList}{setimagelist}.
\membersection{wxTabCtrl::SetImageList}\label{wxtabctrlsetimagelist}
\func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
Sets the image list for the tab control.
\wxheading{See also}
\helpref{wxImageList}{wximagelist}
\membersection{wxTabCtrl::SetItemSize}\label{wxtabctrlsetitemsize}
\func{void}{SetItemSize}{\param{const wxSize\&}{ size}}
Sets the width and height of the tabs.
\membersection{wxTabCtrl::SetItemText}\label{wxtabctrlsetitemtext}
\func{bool}{SetItemText}{\param{int}{ item}, \param{const wxString\& }{text}}
Sets the text for the given tab.
\membersection{wxTabCtrl::SetPadding}\label{wxtabctrlsetpadding}
\func{void}{SetPadding}{\param{const wxSize\&}{ padding}}
Sets the amount of space around each tab's icon and label.
\membersection{wxTabCtrl::SetSelection}\label{wxtabctrlsetselection}
\func{int}{SetSelection}{\param{int}{ item}}
Sets the selection for the given tab, returning the index of the previously
selected tab. Returns -1 if the call was unsuccessful.
\wxheading{See also}
\helpref{wxTabCtrl::GetSelection}{wxtabctrlgetselection}

24
docs/latex/wx/text.tex
View File

@@ -58,9 +58,9 @@ wxTextCtrl header file.
Default constructor. Default constructor.
\func{}{wxTextCtrl}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxTextCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{value = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxString\& }{value = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``text"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``text"}}
Constructor, creating and showing a text control. Constructor, creating and showing a text control.
@@ -112,9 +112,9 @@ Copies the selected text to the clipboard under Motif and MS Windows.
\membersection{wxTextCtrl::Create}\label{wxtextctrlcreate} \membersection{wxTextCtrl::Create}\label{wxtextctrlcreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\& }{value = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxString\& }{value = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``text"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``text"}}
Creates the text control for two-step construction. Derived classes Creates the text control for two-step construction. Derived classes
should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp
@@ -160,7 +160,7 @@ The length of the line, or -1 if {\it lineNo} was invalid.
\membersection{wxTextCtrl::GetLineText}\label{wxtextctrlgetlinetext} \membersection{wxTextCtrl::GetLineText}\label{wxtextctrlgetlinetext}
\constfunc{wxString}{GetLineText}{\param{const long}{ lineNo}} \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}
Returns the contents of a given line in the text control. Returns the contents of a given line in the text control.
@@ -255,7 +255,7 @@ Pastes text from the clipboard to the text item.
\membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy} \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
\constfunc{long}{PositionToXY}{\param{const long }{pos}, \param{long *}{x}, \param{long *}{y}} \constfunc{long}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
Converts given character and line position to a position. Converts given character and line position to a position.
@@ -273,7 +273,7 @@ Converts given character and line position to a position.
\membersection{wxTextCtrl::Remove}\label{wxtextctrlremove} \membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
\func{virtual void}{Remove}{\param{const long}{ from}, \param{const long}{ to}} \func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}
Removes the text between the two positions. Removes the text between the two positions.
@@ -285,7 +285,7 @@ Removes the text between the two positions.
\membersection{wxTextCtrl::Replace}\label{wxtextctrlreplace} \membersection{wxTextCtrl::Replace}\label{wxtextctrlreplace}
\func{virtual void}{Replace}{\param{const long}{ from}, \param{const long}{ to}, \param{const wxString\& }{value}} \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
Replaces the text between two positions with the given text. Replaces the text between two positions with the given text.
@@ -323,7 +323,7 @@ Makes the text item editable or read-only.
\membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint} \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint}
\func{virtual void}{SetInsertionPoint}{\param{const long}{ pos}} \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}
Sets the insertion point. Windows only. ?? Sets the insertion point. Windows only. ??
@@ -339,7 +339,7 @@ Sets the insertion point at the end of the text control.
\membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection} \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
\func{virtual void}{SetSelection}{\param{const long}{ from}, \param{const long}{ to}} \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
Selects the text between the two positions. Selects the text between the two positions.
@@ -361,7 +361,7 @@ Sets the text value.
\membersection{wxTextCtrl::ShowPosition}\label{wxtextctrlshowposition} \membersection{wxTextCtrl::ShowPosition}\label{wxtextctrlshowposition}
\func{void}{ShowPosition}{\param{const long}{ pos}} \func{void}{ShowPosition}{\param{long}{ pos}}
Makes the line containing the given position visible. Makes the line containing the given position visible.
@@ -388,7 +388,7 @@ window.
\membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition} \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
\func{long}{XYToPosition}{\param{const long}{ x}, \param{const long}{ y}} \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
Converts the given character and line position to a position. Converts the given character and line position to a position.

125
docs/latex/wx/thread.tex Normal file
View File

@@ -0,0 +1,125 @@
\section{\class{wxThread}}\label{wxthread}
A wxThread manages a system thread, code which executes as a mini-process within the application.
\wxheading{Derived from}
None.
\wxheading{See also}
\helpref{wxMutex}{wxmutex}, \helpref{wxCondition}{wxcondition}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxThread::wxThread}\label{wxthreadconstr}
\func{}{wxThread}{\void}
Default constructor.
\membersection{wxThread::\destruct{wxThread}}
\func{}{\destruct{wxThread}}{\void}
Destroys the wxThread object.
\membersection{wxThread::Create}\label{wxthreadcreate}
\func{wxThreadError}{Create}{\void}
Creates a thread control.
\wxheading{Return value}
One of:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf THREAD\_NO\_ERROR}}{There was no error.}
\twocolitem{{\bf THREAD\_NO\_RESOURCE}}{There were insufficient resources to create a new thread.}
\twocolitem{{\bf THREAD\_RUNNING}}{The thread is already running.}
\end{twocollist}
\membersection{wxThread::DeferDestroy}\label{wxthreaddeferdestroy}
\func{void}{DeferDestroy}{\param{bool}{ defer}}
If {\it defer} is TRUE, defers thread destruction.
\membersection{wxThread::Destroy}\label{wxthreaddestroy}
\func{wxThreadError}{Destroy}{\void}
Destroys the thread immediately unless the application has specified deferral via \helpref{wxThread::DeferDestroy}{deferdestroy}.
\wxheading{Return value}
One of:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf THREAD\_NO\_ERROR}}{There was no error.}
\twocolitem{{\bf THREAD\_NOT\_RUNNING}}{The thread is not running.}
\end{twocollist}
\membersection{wxThread::GetID}\label{wxthreadgetid}
\constfunc{unsigned long}{GetID}{\void}
Gets the thread identifier.
\membersection{wxThread::GetPriority}\label{wxthreadgetpriority}
\constfunc{int}{GetPriority}{\void}
Gets the priority of the thread, between zero and 100.
The following priorities are already defined:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf WXTHREAD_MIN_PRIORITY}}{0}
\twocolitem{{\bf WXTHREAD_DEFAULT_PRIORITY}}{50}
\twocolitem{{\bf WXTHREAD_MAX_PRIORITY}}{100}
\end{twocollist}
\membersection{wxThread::IsAlive}\label{wxthreadisalive}
\constfunc{bool}{IsAlive}{\void}
Returns TRUE if the thread is alive.
\membersection{wxThread::IsMain}\label{wxthreadismain}
\constfunc{bool}{IsMain}{\void}
Returns TRUE if the thread is the main application thread.
\membersection{wxThread::Join}\label{wxthreadjoin}
\func{void*}{Join}{\void}
Waits for the termination of the thread. Returns a platform-specific exit code. TODO
\membersection{wxThread::OnExit}\label{wxthreadonexit}
\func{void}{OnExit}{\void}
Called when the thread exits. The default implementation calls \helpref{wxThread::Join}{wxthreadjoin}.
\membersection{wxThread::SetPriority}\label{wxthreadsetpriority}
\func{void}{SetPriority}{\param{int}{ priority}}
Sets the priority of the thread, between zero and 100. This must be set before the thread is created.
The following priorities are already defined:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf WXTHREAD_MIN_PRIORITY}}{0}
\twocolitem{{\bf WXTHREAD_DEFAULT_PRIORITY}}{50}
\twocolitem{{\bf WXTHREAD_MAX_PRIORITY}}{100}
\end{twocollist}

42
docs/latex/wx/toolbar.tex
View File

@@ -77,7 +77,7 @@ Adds a separator for spacing groups of tools.
\membersection{wxToolBarBase::AddTool}\label{wxtoolbarbaseaddtool} \membersection{wxToolBarBase::AddTool}\label{wxtoolbarbaseaddtool}
\func{wxToolBarBaseTool*}{AddTool}{\param{const int}{ toolIndex}, \param{const wxBitmap\&}{ bitmap1},\rtfsp \func{wxToolBarBaseTool*}{AddTool}{\param{int}{ toolIndex}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxBitmap\&}{ bitmap2 = (wxBitmap *)NULL}, \param{const bool}{ isToggle = FALSE},\rtfsp \param{const wxBitmap\&}{ bitmap2 = (wxBitmap *)NULL}, \param{const bool}{ isToggle = FALSE},\rtfsp
\param{const float}{ xPos = -1}, \param{const float}{ yPos = -1},\rtfsp \param{const float}{ xPos = -1}, \param{const float}{ yPos = -1},\rtfsp
\param{wxObject *}{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}} \param{wxObject *}{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
@@ -152,7 +152,7 @@ For internal use only.
\membersection{wxToolBarBase::EnableTool}\label{wxtoolbarbaseenabletool} \membersection{wxToolBarBase::EnableTool}\label{wxtoolbarbaseenabletool}
\func{void}{EnableTool}{\param{const int }{toolIndex}, \param{const bool}{ enable}} \func{void}{EnableTool}{\param{int }{toolIndex}, \param{const bool}{ enable}}
Enables or disables the tool. Enables or disables the tool.
@@ -246,7 +246,7 @@ This can be used to size a frame around the toolbar canvas.
\membersection{wxToolBarBase::GetToolClientData}\label{wxtoolbarbasegettoolclientdata} \membersection{wxToolBarBase::GetToolClientData}\label{wxtoolbarbasegettoolclientdata}
\constfunc{wxObject*}{GetToolClientData}{\param{const int }{toolIndex}} \constfunc{wxObject*}{GetToolClientData}{\param{int }{toolIndex}}
Get any client data associated with the tool. Get any client data associated with the tool.
@@ -260,7 +260,7 @@ Client data, or NULL if there is none.
\membersection{wxToolBarBase::GetToolEnabled}\label{wxtoolbarbasegettoolenabled} \membersection{wxToolBarBase::GetToolEnabled}\label{wxtoolbarbasegettoolenabled}
\constfunc{bool}{GetToolEnabled}{\param{const int }{toolIndex}} \constfunc{bool}{GetToolEnabled}{\param{int }{toolIndex}}
Called to determine whether a tool is enabled (responds to user input). Called to determine whether a tool is enabled (responds to user input).
@@ -278,7 +278,7 @@ TRUE if the tool is enabled, FALSE otherwise.
% %
\membersection{wxToolBarBase::GetToolLongHelp}\label{wxtoolbarbasegettoollonghelp} \membersection{wxToolBarBase::GetToolLongHelp}\label{wxtoolbarbasegettoollonghelp}
\constfunc{wxString}{GetToolLongHelp}{\param{const int }{toolIndex}} \constfunc{wxString}{GetToolLongHelp}{\param{int }{toolIndex}}
Returns the long help for the given tool. Returns the long help for the given tool.
@@ -313,7 +313,7 @@ Returns the default separator size.
\membersection{wxToolBarBase::GetToolShortHelp}\label{wxtoolbarbasegettoolshorthelp} \membersection{wxToolBarBase::GetToolShortHelp}\label{wxtoolbarbasegettoolshorthelp}
\constfunc{wxString}{GetToolShortHelp}{\param{const int }{toolIndex}} \constfunc{wxString}{GetToolShortHelp}{\param{int }{toolIndex}}
Returns the short help for the given tool. Returns the short help for the given tool.
@@ -330,7 +330,7 @@ Returns the long help for the given tool.
\membersection{wxToolBarBase::GetToolState}\label{wxtoolbarbasegettoolstate} \membersection{wxToolBarBase::GetToolState}\label{wxtoolbarbasegettoolstate}
\constfunc{bool}{GetToolState}{\param{const int }{toolIndex}} \constfunc{bool}{GetToolState}{\param{int }{toolIndex}}
Gets the on/off state of a toggle tool. Gets the on/off state of a toggle tool.
@@ -448,7 +448,7 @@ and not the eventual size of the tool button.
\func{void}{SetMargins}{\param{const wxSize\&}{ size}} \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
\func{void}{SetMargins}{\param{const int}{ x}, \param{const int}{ y}} \func{void}{SetMargins}{\param{int}{ x}, \param{int}{ y}}
Set the values to be used as margins for the toolbar. Set the values to be used as margins for the toolbar.
@@ -492,7 +492,7 @@ You might use the long help for displaying the tool purpose on the status line.
\membersection{wxToolBarBase::SetToolPacking}\label{wxtoolbarbasesettoolpacking} \membersection{wxToolBarBase::SetToolPacking}\label{wxtoolbarbasesettoolpacking}
\func{void}{SetToolPacking}{\param{const int}{ packing}} \func{void}{SetToolPacking}{\param{int}{ packing}}
Sets the value used for spacing tools. The default value is 1. Sets the value used for spacing tools. The default value is 1.
@@ -511,7 +511,7 @@ and for spacing in the horizontal direction if the toolbar is vertical.
\membersection{wxToolBarBase::SetToolShortHelp}\label{wxtoolbarbasesettoolshorthelp} \membersection{wxToolBarBase::SetToolShortHelp}\label{wxtoolbarbasesettoolshorthelp}
\func{void}{SetToolShortHelp}{\param{const int }{toolIndex}, \param{const wxString\& }{helpString}} \func{void}{SetToolShortHelp}{\param{int }{toolIndex}, \param{const wxString\& }{helpString}}
Sets the short help for the given tool. Sets the short help for the given tool.
@@ -531,7 +531,7 @@ An application might use short help for identifying the tool purpose in a toolti
\membersection{wxToolBarBase::SetToolSeparation}\label{wxtoolbarbasesettoolseparation} \membersection{wxToolBarBase::SetToolSeparation}\label{wxtoolbarbasesettoolseparation}
\func{void}{SetToolSeparation}{\param{const int}{ separation}} \func{void}{SetToolSeparation}{\param{int}{ separation}}
Sets the default separator size. The default value is 5. Sets the default separator size. The default value is 5.
@@ -545,7 +545,7 @@ Sets the default separator size. The default value is 5.
\membersection{wxToolBarBase::ToggleTool}\label{wxtoolbarbasetoggletool} \membersection{wxToolBarBase::ToggleTool}\label{wxtoolbarbasetoggletool}
\func{void}{ToggleTool}{\param{const int }{toolIndex}, \param{const bool}{ toggle}} \func{void}{ToggleTool}{\param{int }{toolIndex}, \param{const bool}{ toggle}}
Toggles a tool on or off. Toggles a tool on or off.
@@ -600,10 +600,10 @@ For member functions, see the documentation for \helpref{wxToolBarBase}{wxtoolba
\membersection{wxToolBar95::wxToolBar95}\label{wxtoolbar95constr} \membersection{wxToolBar95::wxToolBar95}\label{wxtoolbar95constr}
\func{}{wxToolBar95}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxToolBar95}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long }{style = 0}, \param{const int }{orientation = wxVERTICAL},\rtfsp \param{long }{style = 0}, \param{int }{orientation = wxVERTICAL},\rtfsp
\param{const int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}} \param{int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}}
Constructs a toolbar. Constructs a toolbar.
@@ -666,10 +666,10 @@ For member functions, see the documentation for \helpref{wxToolBarBase}{wxtoolba
\membersection{wxToolBarMSW::wxToolBarMSW}\label{wxtoolbarmswconstr} \membersection{wxToolBarMSW::wxToolBarMSW}\label{wxtoolbarmswconstr}
\func{}{wxToolBarMSW}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxToolBarMSW}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long }{style = 0}, \param{const int }{orientation = wxVERTICAL},\rtfsp \param{long }{style = 0}, \param{int }{orientation = wxVERTICAL},\rtfsp
\param{const int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}} \param{int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}}
Constructs a toolbar. Constructs a toolbar.
@@ -736,10 +736,10 @@ For member functions, see the documentation for \helpref{wxToolBarBase}{wxtoolba
\membersection{wxToolBarSimple::wxToolBarSimple}\label{wxtoolbarsimpleconstr} \membersection{wxToolBarSimple::wxToolBarSimple}\label{wxtoolbarsimpleconstr}
\func{}{wxToolBarSimple}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp \func{}{wxToolBarSimple}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const long }{style = 0}, \param{const int }{orientation = wxVERTICAL},\rtfsp \param{long }{style = 0}, \param{int }{orientation = wxVERTICAL},\rtfsp
\param{const int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}} \param{int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}}
Constructs a toolbar. Constructs a toolbar.

56
docs/latex/wx/treectrl.tex
View File

@@ -37,9 +37,9 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}} \param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
Constructor, creating and showing a tree control. Constructor, creating and showing a tree control.
@@ -72,9 +72,9 @@ Destructor, destroying the list control.
\membersection{wxTreeCtrl::Create}\label{wxtreectrlcreate} \membersection{wxTreeCtrl::Create}\label{wxtreectrlcreate}
\func{bool}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id},\rtfsp \func{bool}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{const long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}} \param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details. Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details.
@@ -86,25 +86,25 @@ Deletes all the items in the control.
\membersection{wxTreeCtrl::DeleteItem}\label{wxtreectrldeleteitem} \membersection{wxTreeCtrl::DeleteItem}\label{wxtreectrldeleteitem}
\func{bool}{DeleteItem}{\param{const long }{item}} \func{bool}{DeleteItem}{\param{long }{item}}
Deletes the specified item. Deletes the specified item.
\membersection{wxTreeCtrl::Edit}\label{wxtreectrledit} \membersection{wxTreeCtrl::Edit}\label{wxtreectrledit}
\func{wxTextCtrl\&}{Edit}{\param{const long }{item}} \func{wxTextCtrl\&}{Edit}{\param{long }{item}}
Starts editing the label of the given item, returning the text control that the tree control uses for editing. Starts editing the label of the given item, returning the text control that the tree control uses for editing.
\membersection{wxTreeCtrl::EnsureVisible}\label{wxtreectrlensurevisible} \membersection{wxTreeCtrl::EnsureVisible}\label{wxtreectrlensurevisible}
\func{bool}{EnsureVisible}{\param{const long }{item}} \func{bool}{EnsureVisible}{\param{long }{item}}
Scrolls and/or expands items to ensure that the given item is visible. Scrolls and/or expands items to ensure that the given item is visible.
\membersection{wxTreeCtrl::ExpandItem}\label{wxtreectrlexpanditem} \membersection{wxTreeCtrl::ExpandItem}\label{wxtreectrlexpanditem}
\func{bool}{ExpandItem}{\param{const long }{item}, \param{const int }{action}} \func{bool}{ExpandItem}{\param{long }{item}, \param{int }{action}}
Expands the given item. Expands the given item.
@@ -120,7 +120,7 @@ Expands the given item.
\membersection{wxTreeCtrl::GetChild}\label{wxtreectrlgetchild} \membersection{wxTreeCtrl::GetChild}\label{wxtreectrlgetchild}
\constfunc{long}{GetChild}{\param{const long }{item}} \constfunc{long}{GetChild}{\param{long }{item}}
Call this function to retrieve the tree view item that is the first child of the item specified by {\it item}. Call this function to retrieve the tree view item that is the first child of the item specified by {\it item}.
@@ -144,7 +144,7 @@ Returns the first visible item.
\membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist} \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist}
\constfunc{wxImageList*}{GetImageList}{\param{const int }{which = wxIMAGE\_LIST\_NORMAL}} \constfunc{wxImageList*}{GetImageList}{\param{int }{which = wxIMAGE\_LIST\_NORMAL}}
Returns the specified image list. {\it which} may be one of: Returns the specified image list. {\it which} may be one of:
@@ -170,31 +170,31 @@ information.
\membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata} \membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata}
\constfunc{long}{GetItemData}{\param{const long }{item}} \constfunc{long}{GetItemData}{\param{long }{item}}
Returns the client data associated with the item, if any. Returns the client data associated with the item, if any.
\membersection{wxTreeCtrl::GetItemRect}\label{wxtreectrlgetitemrect} \membersection{wxTreeCtrl::GetItemRect}\label{wxtreectrlgetitemrect}
\constfunc{bool}{GetItemRect}{\param{const long }{item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}} \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}}
Returns the position and size of the rectangle bounding the item. Returns the position and size of the rectangle bounding the item.
\membersection{wxTreeCtrl::GetItemState}\label{wxtreectrlgetitemstate} \membersection{wxTreeCtrl::GetItemState}\label{wxtreectrlgetitemstate}
\constfunc{int}{GetItemState}{\param{const long }{item}, \param{const long }{stateMask}} \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
Gets the item state. For a list of state flags, see \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem}. Gets the item state. For a list of state flags, see \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem}.
\membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext} \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
\constfunc{wxString}{GetItemText}{\param{const long }{item}} \constfunc{wxString}{GetItemText}{\param{long }{item}}
Returns the item label. Returns the item label.
\membersection{wxTreeCtrl::GetNextItem}\label{wxtreectrlgetnextitem} \membersection{wxTreeCtrl::GetNextItem}\label{wxtreectrlgetnextitem}
\constfunc{long}{GetNextItem}{\param{const long }{item}, \param{int }{code}} \constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{code}}
Searches for an item using the given criterion, starting from {\it item}. Searches for an item using the given criterion, starting from {\it item}.
@@ -218,13 +218,13 @@ Returns the item or 0 if unsuccessful.
\membersection{wxTreeCtrl::GetNextVisibleItem}\label{wxtreectrlgetnextvisibleitem} \membersection{wxTreeCtrl::GetNextVisibleItem}\label{wxtreectrlgetnextvisibleitem}
\constfunc{long}{GetNextVisibleItem}{\param{const long }{item}} \constfunc{long}{GetNextVisibleItem}{\param{long }{item}}
Returns the next visible item. Returns the next visible item.
\membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent} \membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent}
\constfunc{long}{GetParent}{\param{const long }{item}} \constfunc{long}{GetParent}{\param{long }{item}}
Returns the item's parent. Returns the item's parent.
@@ -264,11 +264,11 @@ in {\it flags}. {\it flags} is a bitlist of the following:
\membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem} \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
\func{long}{InsertItem}{\param{const long }{parent}, \param{wxTreeItem\& }{info}, \param{const long }{insertAfter = wxTREE\_INSERT\_LAST}} \func{long}{InsertItem}{\param{long }{parent}, \param{wxTreeItem\& }{info}, \param{long }{insertAfter = wxTREE\_INSERT\_LAST}}
Inserts an item. For more information on {\it info}, see \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem}. Inserts an item. For more information on {\it info}, see \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem}.
\func{long}{InsertItem}{\param{const long }{parent}, \param{const wxString\& }{label}, \param{const int }{image = -1}, \param{const int }{selImage = -1}, \param{const long }{insertAfter = wxTREE\_INSERT\_LAST}} \func{long}{InsertItem}{\param{long }{parent}, \param{const wxString\& }{label}, \param{int }{image = -1}, \param{int }{selImage = -1}, \param{long }{insertAfter = wxTREE\_INSERT\_LAST}}
Inserts an item. Inserts an item.
@@ -277,19 +277,19 @@ both selected and unselected items.
\membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren} \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren}
\constfunc{bool}{ItemHasChildren}{\param{const long }{item}} \constfunc{bool}{ItemHasChildren}{\param{long }{item}}
Returns TRUE if the item has children. Returns TRUE if the item has children.
\membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto} \membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto}
\func{bool}{ScrollTo}{\param{const long }{item}} \func{bool}{ScrollTo}{\param{long }{item}}
selects the specified item and scrolls the item into view, selects the specified item and scrolls the item into view,
\membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem} \membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem}
\func{bool}{SelectItem}{\param{const long }{item}} \func{bool}{SelectItem}{\param{long }{item}}
Selects the given item. Selects the given item.
@@ -301,7 +301,7 @@ Sets the indentation for the tree control.
\membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist} \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
\func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{const int }{which = wxIMAGE\_LIST\_NORMAL}} \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which = wxIMAGE\_LIST\_NORMAL}}
Sets the image list. {\it which} should be one of wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL and Sets the image list. {\it which} should be one of wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL and
wxIMAGE\_LIST\_STATE. wxIMAGE\_LIST\_STATE.
@@ -357,31 +357,31 @@ Only one item can have the focus.}
\membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage} \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
\func{bool}{SetItemImage}{\param{const long }{item}, \param{const int }{image}, \param{const int }{selImage}} \func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}}
Sets the item image and selected image. These are indices into the assciated image list. Sets the item image and selected image. These are indices into the assciated image list.
\membersection{wxTreeCtrl::SetItemState}\label{wxtreectrlsetitemstate} \membersection{wxTreeCtrl::SetItemState}\label{wxtreectrlsetitemstate}
\func{bool}{SetItemState}{\param{const long }{item}, \param{const long }{state}, \param{const long }{stateMask}} \func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}}
Sets the item state. See \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem} for valid state and state mask flags. Sets the item state. See \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem} for valid state and state mask flags.
\membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext} \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
\func{void}{SetItemText}{\param{const long }{item}, \param{const wxString\& }{text}} \func{void}{SetItemText}{\param{long }{item}, \param{const wxString\& }{text}}
Sets the item label. Sets the item label.
\membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata} \membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata}
\func{bool}{SetItemData}{\param{const long }{item}, \param{long }{data}} \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}
Sets the item client data. Sets the item client data.
\membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren} \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
\func{bool}{SortChildren}{\param{const long }{item}} \func{bool}{SortChildren}{\param{long }{item}}
Sorts the children of the given item in ascending alphabetical order. Sorts the children of the given item in ascending alphabetical order.

2
docs/latex/wx/valtext.tex
View File

@@ -22,7 +22,7 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
Copy constructor. Copy constructor.
\func{}{wxTextValidator}{\param{const long}{ style = wxFILTER\_NONE}, \param{wxString* }{valPtr = NULL}} \func{}{wxTextValidator}{\param{long}{ style = wxFILTER\_NONE}, \param{wxString* }{valPtr = NULL}}
Constructor, taking a style and optional pointer to a wxString variable. Constructor, taking a style and optional pointer to a wxString variable.

64
docs/latex/wx/wave.tex Normal file
View File

@@ -0,0 +1,64 @@
\section{\class{wxWave}}\label{wxwave}
This class represents a short wave file, in Windows WAV format, that
can be stored in memory and played. Currently this class is for Windows
only.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxWave::wxWave}\label{wxwaveconstr}
\func{}{wxWave}{\void}
Default constructor.
\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
determine whether this succeeded.
\wxheading{Parameters}
\docparam{fileName}{The filename or Windows resource.}
\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
\membersection{wxWave::\destruct{wxWave}}
\func{}{\destruct{wxWave}}{\void}
Destroys the wxWave object.
\membersection{wxWave::Create}\label{wxwavecreate}
\func{bool}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
Constructs a wave object from a file or resource.
\wxheading{Parameters}
\docparam{fileName}{The filename or Windows resource.}
\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
\wxheading{Return value}
TRUE if the call was successful, FALSE otherwise.
\membersection{wxWave::IsOk}\label{wxwaveisok}
\constfunc{bool}{IsOk}{\void}
Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise.
\membersection{wxWave::Play}\label{wxwaveplay}
\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}}
Plays the wave file synchronously or asynchronously, looped or single-shot.

44
docs/latex/wx/window.tex
View File

@@ -45,10 +45,10 @@ See also \helpref{window styles overview}{windowstyles}.
Default constructor. Default constructor.
\func{}{wxWindow}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id}, \func{}{wxWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxPoint\& }{pos = wxDefaultPosition},
\param{const wxSize\& }{size = wxDefaultSize}, \param{const wxSize\& }{size = wxDefaultSize},
\param{const long }{style = 0}, \param{long }{style = 0},
\param{const wxString\& }{name = wxPanelNameStr}} \param{const wxString\& }{name = wxPanelNameStr}}
Constructs a window, which can be a child of a frame, dialog or any other non-control window. Constructs a window, which can be a child of a frame, dialog or any other non-control window.
@@ -110,13 +110,13 @@ release the capture.
\membersection{wxWindow::Center}\label{wxwindowcenter} \membersection{wxWindow::Center}\label{wxwindowcenter}
\func{void}{Center}{\param{const int}{ direction}} \func{void}{Center}{\param{int}{ direction}}
A synonym for \helpref{Centre}{wxwindowcentre}. A synonym for \helpref{Centre}{wxwindowcentre}.
\membersection{wxWindow::Centre}\label{wxwindowcentre} \membersection{wxWindow::Centre}\label{wxwindowcentre}
\func{virtual void}{Centre}{\param{const int}{ direction = wxHORIZONTAL}} \func{virtual void}{Centre}{\param{int}{ direction = wxHORIZONTAL}}
Centres the window. Centres the window.
@@ -240,7 +240,7 @@ Enable or disable the window for user input.
\membersection{wxWindow::FakePopupMenu}\label{wxwindowfakepopupmenu} \membersection{wxWindow::FakePopupMenu}\label{wxwindowfakepopupmenu}
\func{virtual bool}{FakePopupMenu}{\param{wxMenu* }{menu}, \param{const int }{x}, \param{const int }{y}} \func{virtual bool}{FakePopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}}
A replacement for wxWindow::PopupMenu for cases where the PopupMenu implementation A replacement for wxWindow::PopupMenu for cases where the PopupMenu implementation
does not work correctly, in particular on Motif platforms. does not work correctly, in particular on Motif platforms.
@@ -479,7 +479,7 @@ a code to the application.
\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb} \membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
\func{virtual int}{GetScrollThumb}{\param{const int }{orientation}} \func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
Returns the built-in scrollbar thumb size. Returns the built-in scrollbar thumb size.
@@ -489,7 +489,7 @@ Returns the built-in scrollbar thumb size.
\membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos} \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
\func{virtual int}{GetScrollPos}{\param{const int }{orientation}} \func{virtual int}{GetScrollPos}{\param{int }{orientation}}
Returns the built-in scrollbar position. Returns the built-in scrollbar position.
@@ -499,7 +499,7 @@ See \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
\membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange} \membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange}
\func{virtual int}{GetScrollRange}{\param{const int }{orientation}} \func{virtual int}{GetScrollRange}{\param{int }{orientation}}
Returns the built-in scrollbar range. Returns the built-in scrollbar range.
@@ -653,7 +653,7 @@ the user can only interact with this window. If FALSE, the effect is reversed.}
\membersection{wxWindow::Move}\label{wxwindowmove} \membersection{wxWindow::Move}\label{wxwindowmove}
\func{void}{Move}{\param{const int}{ x}, \param{const int}{ y}} \func{void}{Move}{\param{int}{ x}, \param{int}{ y}}
Moves the window to the given position. Moves the window to the given position.
@@ -1230,7 +1230,7 @@ default value is FALSE.}
\membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu} \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu}
\func{virtual bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const int }{x}, \param{const int }{y}} \func{virtual bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}}
Pops up the given menu at the specified coordinates, relative to this Pops up the given menu at the specified coordinates, relative to this
window, and returns control when the user has dismissed the menu. If a window, and returns control when the user has dismissed the menu. If a
@@ -1346,7 +1346,7 @@ Converts from screen to client window coordinates.
\membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow} \membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow}
\func{virtual void}{ScrollWindow}{\param{const int }{dx}, \param{const int }{dy}, \param{const wxRect*}{ rect = NULL}} \func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}}
Physically scrolls the pixels in the window. Physically scrolls the pixels in the window.
@@ -1530,8 +1530,8 @@ a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogend
\membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar} \membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar}
\func{virtual void}{SetScrollbar}{\param{const int }{orientation}, \param{const int }{position},\rtfsp \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp
\param{const int }{thumbSize}, \param{const int }{range},\rtfsp \param{int }{thumbSize}, \param{int }{range},\rtfsp
\param{const bool }{refresh = TRUE}} \param{const bool }{refresh = TRUE}}
Sets the scrollbar properties of a built-in scrollbar. Sets the scrollbar properties of a built-in scrollbar.
@@ -1581,7 +1581,7 @@ from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
\begin{comment} \begin{comment}
\membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage} \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
\func{virtual void}{SetScrollPage}{\param{const int }{orientation}, \param{const int }{pageSize}, \param{const bool }{refresh = TRUE}} \func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{const bool }{refresh = TRUE}}
Sets the page size of one of the built-in scrollbars. Sets the page size of one of the built-in scrollbars.
@@ -1621,7 +1621,7 @@ handling of pages and ranges.
\membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos} \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
\func{virtual void}{SetScrollPos}{\param{const int }{orientation}, \param{const int }{pos}, \param{const bool }{refresh = TRUE}} \func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{const bool }{refresh = TRUE}}
Sets the position of one of the built-in scrollbars. Sets the position of one of the built-in scrollbars.
@@ -1649,7 +1649,7 @@ application to take note of scrollbar attributes and redraw contents accordingly
\begin{comment} \begin{comment}
\membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange} \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
\func{virtual void}{SetScrollRange}{\param{const int }{orientation}, \param{const int }{range}, \param{const bool }{refresh = TRUE}} \func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{const bool }{refresh = TRUE}}
Sets the range of one of the built-in scrollbars. Sets the range of one of the built-in scrollbars.
@@ -1681,12 +1681,12 @@ and usually the scrollbar will be automatically hidden.
\membersection{wxWindow::SetSize}\label{wxwindowsetsize} \membersection{wxWindow::SetSize}\label{wxwindowsetsize}
\func{virtual void}{SetSize}{\param{const int}{ x}, \param{const int}{ y}, \param{const int}{ width}, \param{int}{ height}, \func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
\param{const int}{ sizeFlags = wxSIZE\_AUTO}} \param{int}{ sizeFlags = wxSIZE\_AUTO}}
Sets the size and position of the window in pixels. Sets the size and position of the window in pixels.
\func{virtual void}{SetSize}{\param{const int}{ width}, \param{const int}{ height}} \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
Sets the size of the window in pixels. Sets the size of the window in pixels.
@@ -1733,8 +1733,8 @@ by wxWindows, or that the current value of the dimension should be used.
\membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints} \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
\func{virtual void}{SetSizeHints}{\param{const int}{ minW=-1}, \param{const int}{ minH=-1}, \param{const int}{ maxW=-1}, \param{int}{ maxH=-1}, \func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},
\param{const int}{ incW=-1}, \param{const int}{ incH=-1}} \param{int}{ incW=-1}, \param{int}{ incH=-1}}
Allows specification of minimum and maximum window sizes, and window size increments. Allows specification of minimum and maximum window sizes, and window size increments.
If a pair of values is not set (or set to -1), the default values will be used. If a pair of values is not set (or set to -1), the default values will be used.
@@ -1762,7 +1762,7 @@ The resizing increments are only significant under Motif or Xt.
\membersection{wxWindow::SetClientSize} \membersection{wxWindow::SetClientSize}
\func{virtual void}{SetClientSize}{\param{const int}{ width}, \param{const int}{ height}} \func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}}
This sets the size of the window client area in pixels. Using this function to size a window This sets the size of the window client area in pixels. Using this function to size a window
tends to be more device-independent than \helpref{wxWindow::SetSize}{wxwindowsetsize}, since the application need not tends to be more device-independent than \helpref{wxWindow::SetSize}{wxwindowsetsize}, since the application need not

1882
docs/latex/wx/wx.cnt
View File

File diff suppressed because it is too large Load Diff

2
docs/latex/wx/wx.hpj
View File

@@ -1,5 +1,5 @@
[OPTIONS] [OPTIONS]
BMROOT=. ; Assume that bitmaps are where the source is BMROOT=d:\wx2\wxWindows\docs\latex\wx ; Assume that bitmaps are where the source is
TITLE=wxWindows Manual TITLE=wxWindows Manual
CONTENTS=Contents CONTENTS=Contents
COMPRESS=HIGH COMPRESS=HIGH