Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

replaced all int/size_t indices in wxControlWithItems API with unsigned int (committing on behalf of ABX)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@38319 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-03-23 22:05:23 +00:00
parent 5aa67d6619
commit aa61d35253
112 changed files with 1367 additions and 1414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/latex/wx/checklst.tex
View File

@@ -1,3 +1,14 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name: checklst.tex
%% Purpose: wxCheckListBox documentation
%% Author: wxWidgets Team
%% Modified by:
%% Created:
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets Team
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxCheckListBox}}\label{wxchecklistbox}
A checklistbox is like a listbox, but allows items to be checked or unchecked.
@@ -107,12 +118,10 @@ wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE being emitted.
\membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked}
\constfunc{bool}{IsChecked}{\param{int}{ item}}
\constfunc{bool}{IsChecked}{\param{unsigned int}{ item}}
Returns true if the given item is checked, false otherwise.
\wxheading{Parameters}
\docparam{item}{Index of item whose check status is to be returned.}

25
docs/latex/wx/choice.tex
View File

@@ -1,3 +1,14 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name: treectrl.tex
%% Purpose: wxChoice documentation
%% Author: wxWidgets Team
%% Modified by:
%% Created:
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets Team
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxChoice}}\label{wxchoice}
A choice item is used to select one of a list of strings. Unlike a
@@ -113,17 +124,6 @@ Destructor, destroying the choice item.
Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.
\membersection{wxChoice::Delete}\label{wxchoicedelete}
\func{void}{Delete}{\param{int }{n}}
Deletes the item with the given index from the control.
\wxheading{Parameters}
\docparam{n}{The item to delete.}
\membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns}
\constfunc{int}{GetColumns}{\void}
@@ -147,7 +147,7 @@ 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.
\newsince{2.6.2} (before this version
\newsince{2.6.2} (before this version
\helpref{GetSelection}{wxcontrolwithitemsgetselection} itself behaved like
this).
@@ -166,4 +166,3 @@ Sets the number of columns in this choice item.
This is implemented for Motif only and doesn't do anything under other
platforms.

22
docs/latex/wx/ctrlsub.tex
View File

@@ -88,7 +88,7 @@ by the control.
\membersection{wxControlWithItems::Delete}\label{wxcontrolwithitemsdelete}
\func{void}{Delete}{\param{int}{ n}}
\func{void}{Delete}{\param{unsigned int}{ n}}
Deletes an item from the control. The client data associated with the item
will be also deleted if it is owned by the control.
@@ -125,7 +125,7 @@ not found.
\membersection{wxControlWithItems::GetClientData}\label{wxcontrolwithitemsgetclientdata}
\constfunc{void *}{GetClientData}{\param{int}{ n}}
\constfunc{void *}{GetClientData}{\param{unsigned int}{ n}}
Returns a pointer to the client data associated with the given item (if any).
It is an error to call this function for a control which doesn't have untyped
@@ -143,7 +143,7 @@ A pointer to the client data, or {\tt NULL} if not present.
\membersection{wxControlWithItems::GetClientObject}\label{wxcontrolwithitemsgetclientobject}
\constfunc{wxClientData *}{GetClientObject}{\param{int}{ n}}
\constfunc{wxClientData *}{GetClientObject}{\param{unsigned int}{ n}}
Returns a pointer to the client data associated with the given item (if any).
It is an error to call this function for a control which doesn't have typed
@@ -161,7 +161,7 @@ A pointer to the client data, or {\tt NULL} if not present.
\membersection{wxControlWithItems::GetCount}\label{wxcontrolwithitemsgetcount}
\constfunc{size\_t}{GetCount}{\void}
\constfunc{unsigned int}{GetCount}{\void}
Returns the number of items in the control.
@@ -195,7 +195,7 @@ with {\tt wxLB\_MULTIPLE} style.
\membersection{wxControlWithItems::GetString}\label{wxcontrolwithitemsgetstring}
\constfunc{wxString}{GetString}{\param{int}{ n}}
\constfunc{wxString}{GetString}{\param{unsigned int}{ n}}
Returns the label of the item with the given index.
@@ -222,14 +222,14 @@ selected.
\membersection{wxControlWithItems::Insert}\label{wxcontrolwithitemsinsert}
\func{int}{Insert}{\param{const wxString\& }{ item}, \param{int }{pos}}
\func{int}{Insert}{\param{const wxString\& }{ item}, \param{unsigned 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{unsigned int }{pos}, \param{void *}{clientData}}
\func{int}{Insert}{\param{const wxString\& }{ item}, \param{int }{pos}, \param{wxClientData *}{clientData}}
\func{int}{Insert}{\param{const wxString\& }{ item}, \param{unsigned 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.
@@ -282,7 +282,7 @@ multiple selection.
\membersection{wxControlWithItems::SetClientData}\label{wxcontrolwithitemssetclientdata}
\func{void}{SetClientData}{\param{int}{ n}, \param{void *}{data}}
\func{void}{SetClientData}{\param{unsigned int}{ n}, \param{void *}{data}}
Associates the given untyped client data pointer with the given item. Note that
it is an error to call this function if any typed client data pointers had been
@@ -297,7 +297,7 @@ associated with the control items before.
\membersection{wxControlWithItems::SetClientObject}\label{wxcontrolwithitemssetclientobject}
\func{void}{SetClientObject}{\param{int}{ n}, \param{wxClientData *}{data}}
\func{void}{SetClientObject}{\param{unsigned int}{ n}, \param{wxClientData *}{data}}
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
@@ -336,7 +336,7 @@ deselect any other items in the controls which support multiple selections.
\membersection{wxControlWithItems::SetString}\label{wxcontrolwithitemssetstring}
\func{void}{SetString}{\param{int}{ n}, \param{const wxString\& }{ string}}
\func{void}{SetString}{\param{unsigned int}{ n}, \param{const wxString\& }{ string}}
Sets the label for the given item.

22
docs/latex/wx/radiobox.tex
View File

@@ -149,7 +149,7 @@ for further details.
Enables or disables the entire radiobox.
\func{virtual bool}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt true}}}
\func{virtual bool}{Enable}{\param{unsigned int}{ n}, \param{bool}{ enable = {\tt true}}}
Enables or disables an individual button in the radiobox.
@@ -188,7 +188,7 @@ Finds a button matching the given string, returning the position if found, or
\membersection{wxRadioBox::GetColumnCount}\label{wxradioboxgetcolumncount}
\constfunc{int}{GetColumnCount}{\void}
\constfunc{unsigned int}{GetColumnCount}{\void}
Returns the number of columns in the radiobox.
@@ -218,7 +218,7 @@ implements the following methods:\par
\membersection{wxRadioBox::GetRowCount}\label{wxradioboxgetrowcount}
\constfunc{int}{GetRowCount}{\void}
\constfunc{unsigned int}{GetRowCount}{\void}
Returns the number of rows in the radiobox.
@@ -239,7 +239,7 @@ Returns the selected string.
\membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
\constfunc{wxString}{GetString}{\param{int}{ n}}
\constfunc{wxString}{GetString}{\param{unsigned int}{ n}}
Returns the label for the button at the given position.
@@ -250,7 +250,7 @@ Returns the label for the button at the given position.
\membersection{wxRadioBox::IsItemEnabled}\label{wxradioboxisitemenabled}
\constfunc{bool}{IsItemEnabled}{\void}
\constfunc{bool}{IsItemEnabled}{\param{unsigned int}{ n}}
Returns \true if the item is enabled or \false if it was disabled using
\helpref{Enable(n, false)}{wxradioboxenable}.
@@ -258,10 +258,14 @@ Returns \true if the item is enabled or \false if it was disabled using
{\bf Platform note:} Currently only implemented in wxMSW, wxGTK and wxUniversal
and always returns \true in the other ports.
\wxheading{Parameters}
\docparam{n}{The zero-based button position.}
\membersection{wxRadioBox::IsItemShown}\label{wxradioboxisitemshown}
\constfunc{bool}{IsItemShown}{\void}
\constfunc{bool}{IsItemShown}{\param{unsigned int}{ n}}
Returns \true if the item is currently shown or \false if it was hidden using
\helpref{Show(n, false)}{wxradioboxshow}.
@@ -272,6 +276,10 @@ if the entire radiobox is not currently shown.
{\bf Platform note:} Currently only implemented in wxMSW, wxGTK and wxUniversal
and always returns \true in the other ports.
\wxheading{Parameters}
\docparam{n}{The zero-based button position.}
\membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
@@ -325,7 +333,7 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
Shows or hides the entire radiobox.
\func{virtual bool}{Show}{\param{int}{ item}, \param{const bool}{ show = {\tt true}}}
\func{virtual bool}{Show}{\param{unsigned int}{ item}, \param{const bool}{ show = {\tt true}}}
Shows or hides individual buttons.

6
docs/latex/wx/treectrl.tex
View File

@@ -362,7 +362,7 @@ This function is only available in the generic version.
\membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt true}}}
\constfunc{unsigned int}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt true}}}
Returns the number of items in the branch. If {\it recursively} is {\tt true}, returns the total number
of descendants, otherwise only one level of children is counted.
@@ -370,7 +370,7 @@ of descendants, otherwise only one level of children is counted.
\membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount}
\constfunc{size\_t}{GetCount}{\void}
\constfunc{unsigned int}{GetCount}{\void}
Returns the number of items in the control.
@@ -631,7 +631,7 @@ this style.
\membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections}
\constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
\constfunc{unsigned int}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
Fills the array of tree items passed in with the currently selected items. This
function can be called only if the control has the wxTR\_MULTIPLE style.