Dtor for wxHtmlCell

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

diff --git a/docs/latex/wx/ctrlsub.tex b/docs/latex/wx/ctrlsub.tex
index caac770407c6988bb847852a6a2d678e07067cda..fcd01effb319751b7450fbfe37f8f5240c7e273f 100644 (file)
--- a/docs/latex/wx/ctrlsub.tex
+++ b/docs/latex/wx/ctrlsub.tex
@@ -6,7 +6,7 @@
 %% Created:     01.01.03
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2003 Vadim Zeitlin
 %% Created:     01.01.03
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2003 Vadim Zeitlin

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxControlWithItems}}\label{wxcontrolwithitems}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxControlWithItems}}\label{wxcontrolwithitems}


@@ -107,7 +107,7 @@ items in the control.
 
 \membersection{wxControlWithItems::FindString}\label{wxcontrolwithitemsfindstring}
 
 
 \membersection{wxControlWithItems::FindString}\label{wxcontrolwithitemsfindstring}
 

-\func{int}{FindString}{\param{const wxString\& }{string}}
+\func{int}{FindString}{\param{const wxString\& }{string}, \param{bool}{ caseSensitive = false}}

 
 Finds an item whose label matches the given string.
 
 
 Finds an item whose label matches the given string.
 


@@ -115,6 +115,8 @@ Finds an item whose label matches the given string.
 
 \docparam{string}{String to find.}
 
 
 \docparam{string}{String to find.}
 

+\docparam{caseSensitive}{Whether search is case sensitive (default is not).}
+

 \wxheading{Return value}
 
 The zero-based position of the item, or {\tt wxNOT\_FOUND} if the string was
 \wxheading{Return value}
 
 The zero-based position of the item, or {\tt wxNOT\_FOUND} if the string was


@@ -269,6 +271,15 @@ the new code. This method is only available if wxWidgets was compiled with
 future versions.
 
 
 future versions.
 
 

+\membersection{wxControlWithItems::Select}\label{wxcontrolwithitemsselect}
+
+\func{void}{Select}{\param{int}{ n}}
+
+This is the same as \helpref{SetSelection}{wxcontrolwithitemssetselection} and
+exists only because it is slightly more natural for controls which support
+multiple selection.
+
+

 \membersection{wxControlWithItems::SetClientData}\label{wxcontrolwithitemssetclientdata}
 
 \func{void}{SetClientData}{\param{int}{ n}, \param{void *}{data}}
 \membersection{wxControlWithItems::SetClientData}\label{wxcontrolwithitemssetclientdata}
 
 \func{void}{SetClientData}{\param{int}{ n}, \param{void *}{data}}


@@ -308,9 +319,10 @@ pointers had been associated with the control items before.
 \func{void}{SetSelection}{\param{int}{ n}}
 
 Sets the selection to the given item \arg{n} or removes the selection entirely
 \func{void}{SetSelection}{\param{int}{ n}}
 
 Sets the selection to the given item \arg{n} or removes the selection entirely

-if \arg{n} $==$ \textt{wxNOT\_FOUND}.
+if \arg{n} $==$ {\tt wxNOT\_FOUND}.

 
 

-Note that this does not cause any command events to be emitted.
+Note that this does not cause any command events to be emitted nor does it
+deselect any other items in the controls which support multiple selections.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -337,7 +349,7 @@ Sets the label for the given item.
 
 \membersection{wxControlWithItems::SetStringSelection}\label{wxcontrolwithitemssetstringselection}
 
 
 \membersection{wxControlWithItems::SetStringSelection}\label{wxcontrolwithitemssetstringselection}
 

-\func{void}{SetStringSelection}{\param{const wxString\& }{ string}}
+\func{bool}{SetStringSelection}{\param{const wxString\& }{ string}}

 
 Selects the item with the specified string in the control. This doesn't cause
 any command events being emitted.
 
 Selects the item with the specified string in the control. This doesn't cause
 any command events being emitted.


@@ -346,6 +358,11 @@ any command events being emitted.
 
 \docparam{string}{The string to select.}
 
 
 \docparam{string}{The string to select.}
 

+\wxheading{Return value}
+
+\true if the specified string has been selected, \false if it wasn't found in
+the control.
+

 \wxheading{See also}
 
 \helpref{SetSelection}{wxcontrolwithitemssetselection}
 \wxheading{See also}
 
 \helpref{SetSelection}{wxcontrolwithitemssetselection}