X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..c6b65b76a196e1aa2313f89f6fc609d497c388a0:/docs/latex/wx/ctrlsub.tex?ds=sidebyside diff --git a/docs/latex/wx/ctrlsub.tex b/docs/latex/wx/ctrlsub.tex index 55d6c1ac36..fe7dbbf5fe 100644 --- a/docs/latex/wx/ctrlsub.tex +++ b/docs/latex/wx/ctrlsub.tex @@ -1,4 +1,4 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% Name: ctrlsub.tex %% Purpose: wxControlWithItems documentation %% Author: Vadim Zeitlin @@ -6,12 +6,12 @@ %% Created: 01.01.03 %% RCS-ID: $Id$ %% Copyright: (c) 2003 Vadim Zeitlin -%% License: wxWindows license -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% License: wxWidgets license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxControlWithItems}}\label{wxcontrolwithitems} -This class is an abstract base class for some wxWindows controls which contain +This class is an abstract base class for some wxWidgets controls which contain several items, such as \helpref{wxListBox}{wxlistbox} and \helpref{wxCheckListBox}{wxchecklistbox} derived from it, \helpref{wxChoice}{wxchoice} and \helpref{wxComboBox}{wxcombobox}. @@ -218,6 +218,35 @@ selected. \helpref{GetSelection}{wxcontrolwithitemsgetselection} +\membersection{wxControlWithItems::Insert}\label{wxcontrolwithitemsinsert} + +\func{int}{Insert}{\param{const wxString\& }{ item}, \param{int }{pos}} + +Inserts the item into the list before pos. +Not valid for {\tt wxLB\_SORT} or {\tt wxCB\_SORT} styles, use Append instead. + +\func{int}{Insert}{\param{const wxString\& }{ item}, \param{int }{pos}, \param{void *}{clientData}} + +\func{int}{Insert}{\param{const wxString\& }{ item}, \param{int }{pos}, \param{wxClientData *}{clientData}} + +Inserts the item into the list before pos, associating the given, typed or +untyped, client data pointer with the item. +Not valid for {\tt wxLB\_SORT} or {\tt wxCB\_SORT} styles, use Append instead. + +\wxheading{Parameters} + +\docparam{item}{String to add.} + +\docparam{pos}{Position to insert item before, zero based.} + +\docparam{clientData}{Client data to associate with the item.} + +\wxheading{Return value} + +The return value is the index of the newly inserted item. If the insertion failed +for some reason, -1 is returned. + + \membersection{wxControlWithItems::IsEmpty}\label{wxcontrolwithitemsisempty} \constfunc{bool}{IsEmpty}{\void} @@ -235,7 +264,7 @@ Returns {\tt true} if the control is empty or {\tt false} if it has some items. {\bf Obsolescence note:} This method is obsolete and was replaced with \helpref{GetCount}{wxcontrolwithitemsgetcount}, please use the new method in -the new code. This method is only available if wxWindows was compiled with +the new code. This method is only available if wxWidgets was compiled with {\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in future versions. @@ -278,8 +307,10 @@ pointers had been associated with the control items before. \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. \wxheading{Parameters}