define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

[wxWidgets.git] / docs / latex / wx / choice.tex

diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex
index 74d0664db4fcff96232db27cff9d93693e1f783a..f810c735a0801ebadb591fec524443fa05f4729f 100644 (file)
--- a/docs/latex/wx/choice.tex
+++ b/docs/latex/wx/choice.tex
@@ -6,6 +6,7 @@ menu of choices.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

+\helpref{wxControlWithItems}{wxcontrolwithitems}\\

 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\


@@ -36,7 +37,8 @@ when an item on the list is selected.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxChoice::wxChoice}\label{wxchoiceconstr}
+
+\membersection{wxChoice::wxChoice}\label{wxchoicector}

 
 \func{}{wxChoice}{\void}
 
 
 \func{}{wxChoice}{\void}
 


@@ -47,6 +49,11 @@ Default constructor.
 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
 
 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
 

+\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
+

 Constructor, creating and showing a choice.
 
 \wxheading{Parameters}
 Constructor, creating and showing a choice.
 
 \wxheading{Parameters}


@@ -74,61 +81,48 @@ appropriately.}
 
 \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
 

-\pythonnote{The wxChoice constructor in wxPython reduces the \tt{n}
-and \tt{choices} arguments are to a single argument, which is
+\pythonnote{The wxChoice constructor in wxPython reduces the {\tt n}
+and {\tt choices} arguments are to a single argument, which is

 a list of strings.}
 
 a list of strings.}
 

-\membersection{wxChoice::\destruct{wxChoice}}
-
-\func{}{\destruct{wxChoice}}{\void}
-
-Destructor, destroying the choice item.
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}

 
 

-\membersection{wxChoice::Append}\label{wxchoiceappend}

 
 

-\func{void}{Append}{\param{const wxString\& }{ item}}
+\membersection{wxChoice::\destruct{wxChoice}}\label{wxchoicedtor}

 
 

-Adds the item to the end of the choice control.
-
-\func{void}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}}
-
-Adds the item to the end of the combobox, associating the given data
-with the item.
-
-\wxheading{Parameters}
-
-\docparam{item}{String to add.}
-
-\docparam{clientData}{Client data to associate with the item.}
-
-\membersection{wxChoice::Clear}\label{wxchoiceclear}
+\func{}{\destruct{wxChoice}}{\void}

 
 

-\func{void}{Clear}{\void}
+Destructor, destroying the choice item.

 
 

-Clears the strings from the choice item.

 
 \membersection{wxChoice::Create}\label{wxchoicecreate}
 
 \func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
 
 \membersection{wxChoice::Create}\label{wxchoicecreate}
 
 \func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp

-\param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
+\param{const wxString\& }{name = ``choice"}}

 
 

-Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}.
+\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
+\param{const wxString\& }{name = ``choice"}}

 
 

-\membersection{wxChoice::FindString}\label{wxchoicefindstring}
+Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.

 
 

-\constfunc{int}{FindString}{\param{const wxString\& }{string}}

 
 

-Finds a choice matching the given string.
+\membersection{wxChoice::Delete}\label{wxchoicedelete}

 
 

-\wxheading{Parameters}
+\func{void}{Delete}{\param{int }{n}}

 
 

-\docparam{string}{String to find.}
+Deletes the item with the given index from the control.

 
 

-\wxheading{Return value}
+\wxheading{Parameters}
+
+\docparam{n}{The item to delete.}

 
 

-Returns the position if found, or -1 if not found.

 
 \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns}
 
 
 \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns}
 


@@ -138,65 +132,25 @@ Gets the number of columns in this choice item.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-This is implemented for Motif only.
-
-\membersection{wxChoice::GetClientData}\label{wxchoicegetclientdata}
-
-\constfunc{void*}{GetClientData}{\param{int}{ n}}
-
-Returns a pointer to the client data associated with the given item (if any).
-
-\wxheading{Parameters}
-
-\docparam{n}{An item, starting from zero.}
-
-\wxheading{Return value}
-
-A pointer to the client data, or NULL if the item was not found.
-
-\membersection{wxChoice::GetSelection}\label{wxchoicegetselection}
-
-\constfunc{int}{GetSelection}{\void}
-
-Gets the id (position) of the selected string, or -1 if there is no selection.
+This is implemented for Motif only and always returns $1$ for the other
+platforms.

 
 

-\membersection{wxChoice::GetString}\label{wxchoicegetstring}

 
 

-\constfunc{wxString}{GetString}{\param{int}{ n}}
+\membersection{wxChoice::GetCurrentSelection}\label{wxchoicegetcurrentselection}

 
 

-Returns the string at the given position.
+\constfunc{int}{GetCurrentSelection}{\void}

 
 

-\wxheading{Parameters}
-
-\docparam{n}{The zero-based position.}
-
-\wxheading{Return value}
-
-The string at the given position, or the empty string if {\it n} is invalid.
-
-\membersection{wxChoice::GetStringSelection}\label{wxchoicegetstringselection}
-
-\constfunc{wxString}{GetStringSelection}{\void}
-
-Gets the selected string, or the empty string if no string is selected.
-
-\membersection{wxChoice::Number}\label{wxchoicenumber}
-
-\constfunc{int}{Number}{\void}
+Unlike \helpref{GetSelection}{wxcontrolwithitemsgetselection} which only
+returns the accepted selection value, i.e. the selection in the control once
+the user closes the dropdown list, this function returns the current selection.
+That is, while the dropdown list is shown, it returns the currently selected
+item in it. When it is not shown, its result is the same as for the other
+function.

 
 

-Returns the number of strings in the choice control.
+\newsince{2.6.2} (before this version 
+\helpref{GetSelection}{wxcontrolwithitemsgetselection} itself behaved like
+this).

 
 

-\membersection{wxChoice::SetClientData}\label{wxchoicesetclientdata}
-
-\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}}
-
-Associates the given client data pointer with the given item.
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based item.}
-
-\docparam{data}{The client data.}

 
 \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
 
 
 \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
 


@@ -210,36 +164,6 @@ Sets the number of columns in this choice item.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-This is implemented for Motif only.
-
-\membersection{wxChoice::SetSelection}\label{wxchoicesetselection}
-
-\func{void}{SetSelection}{\param{int}{ n}}
-
-Sets the choice by passing the desired string position. This does not cause
-a wxEVT\_COMMAND\_CHOICE\_SELECTED event to get emitted.
-
-\wxheading{Parameters}
-
-\docparam{n}{The string position to select, starting from zero.}
-
-\wxheading{See also}
-
-\helpref{wxChoice::SetStringSelection}{wxchoicesetstringselection}
-
-\membersection{wxChoice::SetStringSelection}\label{wxchoicesetstringselection}
-
-\func{void}{SetStringSelection}{\param{const wxString\& }{ string}}
-
-Sets the choice by passing the desired string. This does not cause
-a wxEVT\_COMMAND\_CHOICE\_SELECTED event to get emitted.
-
-\wxheading{Parameters}
-
-\docparam{string}{The string to select.}
-
-\wxheading{See also}
-
-\helpref{wxChoice::SetSelection}{wxchoicesetselection}
-
+This is implemented for Motif only and doesn't do anything under other
+platforms.