Doc suggestions applied

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_4_BRANCH@20367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2003-04-28 10:37:08 +00:00
parent 146dd475ae
commit 0e66b22778
7 changed files with 31 additions and 4 deletions

View File

@@ -246,7 +246,7 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man
\func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}} \func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
Sorts the array in alphabetical order or in reverse alphabetical order if Sorts the array in alphabetical order or in reverse alphabetical order if
{\it reverseOrder} is TRUE. {\it reverseOrder} is TRUE. The sort is case-sensitive.
{\bf Warning:} this function should not be used with sorted array because it {\bf Warning:} this function should not be used with sorted array because it
could break the order of items and, for example, subsequent calls to could break the order of items and, for example, subsequent calls to

View File

@@ -238,6 +238,12 @@ Creates an image from a platform-dependent bitmap. This preserves
mask information so that bitmaps and images can be converted back mask information so that bitmaps and images can be converted back
and forth without loss in that respect. and forth without loss in that respect.
\membersection{wxBitmap::CopyFromIcon}\label{wxbitmapcopyfromicon}
\func{bool}{CopyFromIcon}{\param{const wxIcon\&}{ icon}}
Creates the bitmap from an icon.
\membersection{wxBitmap::Create}\label{wxbitmapcreate} \membersection{wxBitmap::Create}\label{wxbitmapcreate}
\func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} \func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}

View File

@@ -28,7 +28,7 @@ No base class
<wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\ <wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\
<wx/confbase.h> (base config class)\\ <wx/confbase.h> (base config class)\\
<wx/fileconf.h> (wxFileconfig class)\\ <wx/fileconf.h> (wxFileConfig class)\\
<wx/msw/regconf.h> (wxRegConfig class)\\ <wx/msw/regconf.h> (wxRegConfig class)\\
<wx/msw/iniconf.h> (wxIniConfig class) <wx/msw/iniconf.h> (wxIniConfig class)

View File

@@ -207,6 +207,7 @@ the corresponding topic.
\helpref{wxSplitPath}{wxsplitfunction}\\ \helpref{wxSplitPath}{wxsplitfunction}\\
\helpref{wxStartTimer}{wxstarttimer}\\ \helpref{wxStartTimer}{wxstarttimer}\\
\helpref{wxStaticCast}{wxstaticcast}\\ \helpref{wxStaticCast}{wxstaticcast}\\
\helpref{wxStrcmp}{wxstrcmp}\\
\helpref{wxStricmp}{wxstricmp}\\ \helpref{wxStricmp}{wxstricmp}\\
\helpref{wxStringEq}{wxstringeq}\\ \helpref{wxStringEq}{wxstringeq}\\
\helpref{wxStringMatch}{wxstringmatch}\\ \helpref{wxStringMatch}{wxstringmatch}\\
@@ -1178,6 +1179,16 @@ This function is deprecated, use \helpref{wxString}{wxstring} class instead.
Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
string, {\tt FALSE} otherwise. string, {\tt FALSE} otherwise.
\membersection{::wxStrcmp}\label{wxstrcmp}
\func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}
Returns a negative value, 0, or positive value if {\it p1} is less than, equal
to or greater than {\it p2}. The comparison is case-sensitive.
This function complements the standard C function {\it stricmp()} which performs
case-insensitive comparison.
\membersection{::wxStricmp}\label{wxstricmp} \membersection{::wxStricmp}\label{wxstricmp}
\func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}} \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}

View File

@@ -23,7 +23,8 @@ functions that take a wxMenuEvent argument.
\twocolwidtha{7cm} \twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened.} \twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened. On Windows,
this is only sent once for each navigation of the menubar (up until all menus have closed).}
\twocolitem{{\bf EVT\_MENU\_CLOSE(func)}}{A menu has been just closed.} \twocolitem{{\bf EVT\_MENU\_CLOSE(func)}}{A menu has been just closed.}
\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(id, func)}}{The menu item with the \twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(id, func)}}{The menu item with the
specified id has been highlighted: used to show help prompts in the status bar specified id has been highlighted: used to show help prompts in the status bar

View File

@@ -237,6 +237,8 @@ Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr}
Deletes the specified item. A {\tt EVT\_TREE\_DELETE\_ITEM} event will be Deletes the specified item. A {\tt EVT\_TREE\_DELETE\_ITEM} event will be
generated. generated.
This function may cause a subsequent call to GetNextChild to fail.
\membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems} \membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems}
\func{void}{DeleteAllItems}{\void} \func{void}{DeleteAllItems}{\void}
@@ -252,6 +254,10 @@ 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. \helpref{Delete}{wxtreectrldelete} method.
If you have called \helpref{wxTreeCtrl::SetItemHasChildren}{wxtreectrlsetitemhaschildren}, you
may need to call it again since {\it DeleteChildren} does not automatically
clear the setting.
\membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel} \membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel}
\func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}} \func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}}
@@ -621,6 +627,7 @@ returned as a tuple.}
\param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}} \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}). Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}).
{\it before} must be less than the number of children.
The {\it image} and {\it selImage} parameters are an index within The {\it image} and {\it selImage} parameters are an index within
the normal image list specifying the image to use for unselected and the normal image list specifying the image to use for unselected and
@@ -840,7 +847,7 @@ The new mode takes effect immediately.
Sorts the children of the given item using Sorts the children of the given item using
\helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You \helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
should override that method to change the sort order (the default is ascending should override that method to change the sort order (the default is ascending
alphabetical order). case-sensitive alphabetical order).
\wxheading{See also} \wxheading{See also}

View File

@@ -970,6 +970,8 @@ Truncate the string to the given length.
\func{void}{UngetWriteBuf}{\void} \func{void}{UngetWriteBuf}{\void}
\func{void}{UngetWriteBuf}{\param{size_t}{ len}}
Puts the string back into a reasonable state, after Puts the string back into a reasonable state, after
\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called. \rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.