wxSTAY_ON_TOP is available on all 3 major platforms now, remove Windows-only note

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

diff --git a/docs/latex/wx/ctrlsub.tex b/docs/latex/wx/ctrlsub.tex
index 855d3e7ceaf7299199899d5e4c17b5f5327a321f..83079b643b424ab3c2ebb076f1df3bb3833b3f84 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}


@@ -269,6 +269,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}}


@@ -307,8 +316,11 @@ pointers had been associated with the control items before.
 
 \func{void}{SetSelection}{\param{int}{ n}}
 
 
 \func{void}{SetSelection}{\param{int}{ n}}
 

-Sets the choice by passing the desired string position. This does not cause
-any command events to get emitted.
+Sets the selection to the given item \arg{n} or removes the selection entirely
+if \arg{n} $==$ {\tt wxNOT\_FOUND}.
+
+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}
 


@@ -335,7 +347,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.


@@ -344,6 +356,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}