From: Włodzimierz Skiba Date: Tue, 14 Mar 2006 19:30:06 +0000 (+0000) Subject: Line-up interfaces to use size_t for GetCount()s (and count related api). X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/afbe150a7625268fb9fcc1a770dfb7d7bd218e01 Line-up interfaces to use size_t for GetCount()s (and count related api). git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@38075 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/changes.txt b/docs/changes.txt index 3cfe88d9d2..87ed494bb8 100644 --- a/docs/changes.txt +++ b/docs/changes.txt @@ -43,6 +43,7 @@ All: - Added support for wxLongLong in wx stream classes (Mark Junker) - wxSOCKET_REUSEADDR can be used with wxSocketClient. - Overloaded Connect and SetLocal methods for binding to local address/port. +- Consistency of count getters (GetCount()) with returning size_t everywhere. All (GUI): diff --git a/docs/latex/wx/ctrlsub.tex b/docs/latex/wx/ctrlsub.tex index fcd01effb3..032f4b9af4 100644 --- a/docs/latex/wx/ctrlsub.tex +++ b/docs/latex/wx/ctrlsub.tex @@ -12,8 +12,8 @@ \section{\class{wxControlWithItems}}\label{wxcontrolwithitems} 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, +several items, such as \helpref{wxListBox}{wxlistbox} and +\helpref{wxCheckListBox}{wxchecklistbox} derived from it, \helpref{wxChoice}{wxchoice} and \helpref{wxComboBox}{wxcombobox}. It defines the methods for accessing the controls items and although each of @@ -25,8 +25,8 @@ optionally, client data associated with them. Client data may be of two different kinds: either simple untyped ({\tt void *}) pointers which are simply stored by the control but not used in any way by it, or typed pointers ({\tt wxClientData *}) which are owned by the control meaning that the typed -client data (and only it) will be deleted when an item is -\helpref{deleted}{wxcontrolwithitemsdelete} or the entire control is +client data (and only it) will be deleted when an item is +\helpref{deleted}{wxcontrolwithitemsdelete} or the entire control is \helpref{cleared}{wxcontrolwithitemsclear} (which also happens when it is destroyed). Finally note that in the same control all items must have client data of the same type (typed or untyped), if any. This type is determined by @@ -161,7 +161,7 @@ A pointer to the client data, or {\tt NULL} if not present. \membersection{wxControlWithItems::GetCount}\label{wxcontrolwithitemsgetcount} -\constfunc{int}{GetCount}{\void} +\constfunc{size\_t}{GetCount}{\void} Returns the number of items in the control. @@ -183,7 +183,7 @@ The position of the current selection. \wxheading{Remarks} -This method can be used with single selection list boxes only, you should use +This method can be used with single selection list boxes only, you should use \helpref{wxListBox::GetSelections}{wxlistboxgetselections} for the list boxes with {\tt wxLB\_MULTIPLE} style. @@ -266,7 +266,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 wxWidgets 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. @@ -299,7 +299,7 @@ associated with the control items before. \func{void}{SetClientObject}{\param{int}{ n}, \param{wxClientData *}{data}} -Associates the given typed client data pointer with the given item: the +Associates the given typed client data pointer with the given item: the {\it data} object will be deleted when the item is deleted (either explicitly by using \helpref{Deletes}{wxcontrolwithitemsdelete} or implicitly when the control itself is destroyed). @@ -366,5 +366,3 @@ the control. \wxheading{See also} \helpref{SetSelection}{wxcontrolwithitemssetselection} - - diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index be872cccf5..c49d141417 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -3,7 +3,7 @@ %% Purpose: wxRadioBox documentation %% Author: wxWidgets Team %% Modified by: -%% Created: +%% Created: %% RCS-ID: $Id$ %% Copyright: (c) wxWidgets Team %% License: wxWindows license @@ -17,6 +17,7 @@ labelled buttons. \wxheading{Derived from} +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -192,13 +193,6 @@ Finds a button matching the given string, returning the position if found, or Returns the number of columns in the radiobox. -\membersection{wxRadioBox::GetCount}\label{wxradioboxgetcount} - -\constfunc{int}{GetCount}{\void} - -Returns the number of items in the radiobox. - - \membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel} \constfunc{wxString}{GetLabel}{\void} @@ -258,7 +252,7 @@ Returns the label for the button at the given position. \constfunc{bool}{IsItemEnabled}{\void} -Returns \true if the item is enabled or \false if it was disabled using +Returns \true if the item is enabled or \false if it was disabled using \helpref{Enable(n, false)}{wxradioboxenable}. {\bf Platform note:} Currently only implemented in wxMSW, wxGTK and wxUniversal @@ -269,7 +263,7 @@ and always returns \true in the other ports. \constfunc{bool}{IsItemShown}{\void} -Returns \true if the item is currently shown or \false if it was hidden using +Returns \true if the item is currently shown or \false if it was hidden using \helpref{Show(n, false)}{wxradioboxshow}. Note that this function returns \true for an item which hadn't been hidden even diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index c20646f507..8147946ad9 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: treectrl.tex +%% Purpose: wxTreeCtrl documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxTreeCtrl}}\label{wxtreectrl} A tree control presents information as a hierarchy, with items that may be expanded @@ -31,7 +42,7 @@ to show + and - buttons to the left of parent items.} to hide vertical level connectors.} \twocolitem{\windowstyle{wxTR\_FULL\_ROW\_HIGHLIGHT}}{Use this style to have the background colour and the selection highlight extend over the entire horizontal -row of the tree control window. (This flag is ignored under Windows unless you +row of the tree control window. (This flag is ignored under Windows unless you specify wxTR\_NO\_LINES as well.) } \twocolitem{\windowstyle{wxTR\_LINES\_AT\_ROOT}}{Use this style to show lines between root nodes. @@ -105,7 +116,7 @@ implemented in the system library {\tt comctl32.dll}. Some versions of this library are known to have bugs with handling the tree control colours: the usual symptom is that the expanded items leave black (or otherwise incorrectly coloured) background behind them, especially for the controls using non-default background colour. The recommended solution is to upgrade the {\tt comctl32.dll} -to a newer version: see +to a newer version: see \urlref{http://www.microsoft.com/downloads/release.asp?ReleaseID=11916}{http://www.microsoft.com/downloads/release.asp?ReleaseID=11916}. \latexignore{\rtfignore{\wxheading{Members}}} @@ -257,7 +268,7 @@ This function may cause a subsequent call to GetNextChild to fail. \func{void}{DeleteAllItems}{\void} -Deletes all items in the control. Note that this may not generate +Deletes all items in the control. Note that this may not generate {\tt EVT\_TREE\_DELETE\_ITEM} events under some Windows versions although normally such event is generated for each removed item. @@ -267,7 +278,7 @@ normally such event is generated for each removed item. \func{void}{DeleteChildren}{\param{const wxTreeItemId\& }{item}} Deletes all children of the given item (but not the item itself). Note that -this will {\bf not} generate any events unlike +this will {\bf not} generate any events unlike \helpref{Delete}{wxtreectrldelete} method. If you have called \helpref{wxTreeCtrl::SetItemHasChildren}{wxtreectrlsetitemhaschildren}, you @@ -336,7 +347,7 @@ item is currently invisible. {\tt item} and {\tt textOnly} parameters. The return value is either a {\tt wxRect} object or {\tt None}.} -\perlnote{In wxPerl this method only takes the parameters {\tt item} and +\perlnote{In wxPerl this method only takes the parameters {\tt item} and {\tt textOnly}, and returns a Wx::Rect ( or undef ).} @@ -359,7 +370,7 @@ of descendants, otherwise only one level of children is counted. \membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount} -\constfunc{int}{GetCount}{\void} +\constfunc{size\_t}{GetCount}{\void} Returns the number of items in the control. @@ -976,5 +987,3 @@ all items if it does have this style. \func{void}{UnselectItem}{\param{const wxTreeItemId\& }{item}} Unselects the given item. This works in multiselection controls only. - -