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

Some wxPython doc changes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6808 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2000-03-17 18:59:26 +00:00
parent 6a6d5b4731
commit aa9fb2be6d
2 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/latex/wx/listctrl.tex
View File

@@ -3,7 +3,7 @@
A list control presents lists in a number of formats: list view, report view, A list control presents lists in a number of formats: list view, report view,
icon view and small icon view. In any case, elements are numbered from zero. icon view and small icon view. In any case, elements are numbered from zero.
Using many of wxListCtrl is shown in the Using many of wxListCtrl is shown in the
\helpref{corresponding sample}{samplelistctrl}. \helpref{corresponding sample}{samplelistctrl}.
To intercept events from a list control, use the event table macros described To intercept events from a list control, use the event table macros described
@@ -144,7 +144,7 @@ Deletes all items and all columns.
\func{bool}{DeleteItem}{\param{long }{item}} \func{bool}{DeleteItem}{\param{long }{item}}
Deletes the specified item. This function sends the Deletes the specified item. This function sends the
{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted. {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted.
See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems} See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
@@ -155,7 +155,7 @@ See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
Deletes all the items in the list control. Deletes all the items in the list control.
{\bf NB:} This function does {\it not} send the {\bf NB:} This function does {\it not} send the
{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}). from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}).
@@ -288,7 +288,7 @@ Returns the rectangle representing the item's size and position, in client coord
{\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL. {\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL.
\pythonnote{The wxPython version of this method accepts only the item \pythonnote{The wxPython version of this method accepts only the item
ID and returns the wxRect.} ID and code and returns the wxRect.}
\membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
@@ -322,7 +322,7 @@ Gets the item text for this item.
\constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}} \constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}}
Searches for an item with the given goemetry or state, starting from Searches for an item with the given goemetry or state, starting from
{\it item} but excluding the {\it item} itself. If {\it item} is -1, {\it item} but excluding the {\it item} itself. If {\it item} is -1,
the first item that matches the specified flags will be returned. the first item that matches the specified flags will be returned.
@@ -642,7 +642,7 @@ Sets the whole window style.
\func{bool}{SortItems}{\param{wxListCtrlCompare }{fnSortCallBack}, \param{long }{data}} \func{bool}{SortItems}{\param{wxListCtrlCompare }{fnSortCallBack}, \param{long }{data}}
Call this function to sorts the items in the list control. Sorting is done Call this function to sort the items in the list control. Sorting is done
using the specified {\it fnSortCallBack} function. This function must have the using the specified {\it fnSortCallBack} function. This function must have the
following prototype: following prototype:
@@ -658,7 +658,9 @@ second one and positive value if the first one is greater than the second one
\wxheading{Parameters} \wxheading{Parameters}
\docparam{item1}{client data associated with the first item ({\bf NOT} the index).} \docparam{item1}{client data associated with the first item ({\bf NOT} the index).}
\docparam{item2}{client data associated with the second item ({\bf NOT} the index).} \docparam{item2}{client data associated with the second item ({\bf NOT} the index).}
\docparam{data}{the value passed to SortItems() itself.} \docparam{data}{the value passed to SortItems() itself.}
Notice that the control may only be sorted on client data associated with the Notice that the control may only be sorted on client data associated with the
@@ -668,3 +670,7 @@ you want to be able to sort the items in the control.
Please see the \helpref{listctrl sample}{samplelistctrl} for an example of Please see the \helpref{listctrl sample}{samplelistctrl} for an example of
using this function. using this function.
\pythonnote{wxPython uses the sortData parameter to pass the Python
function to call, so it is not available for programmer use. Call
SortItems with a reference to a callable object that expects two
parameters.}

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

@@ -429,7 +429,7 @@ Returns the state image list (from which application-defined state images are ta
\membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest} \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
\func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}} \func{wxTreeItemId}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
Calculates which (if any) item is under the given point, returning extra information Calculates which (if any) item is under the given point, returning extra information
in {\it flags}. {\it flags} is a bitlist of the following: in {\it flags}. {\it flags} is a bitlist of the following:
@@ -449,6 +449,9 @@ in {\it flags}. {\it flags} is a bitlist of the following:
\twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.} \twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.}
\end{twocollist} \end{twocollist}
\pythonnote{in wxPython both the wxTreeItemId and the flags are
returned as a tuple.}
\membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem} \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
\func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text}, \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text},