Doc suggestions applied

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@20367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 2003-04-28 10:37:08 +00:00
parent 01d0d0e57d
commit 2f930c8501
7 changed files with 30 additions and 5 deletions

View File

@ -246,7 +246,7 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man
\func{void}{Sort}{\param{bool}{ reverseOrder = false}}
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
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
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}
\func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}

View File

@ -86,7 +86,7 @@ Clears the global clipboard object and the system's clipboard if possible.
\membersection{wxClipboard::Close}\label{wxclipboardclose}
\func{bool}{Close}{\void}
\func{void}{Close}{\void}
Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.

View File

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

View File

@ -201,6 +201,7 @@ the corresponding topic.
\helpref{wxSplitPath}{wxsplitfunction}\\
\helpref{wxStartTimer}{wxstarttimer}\\
\helpref{wxStaticCast}{wxstaticcast}\\
\helpref{wxStrcmp}{wxstrcmp}\\
\helpref{wxStricmp}{wxstricmp}\\
\helpref{wxStringEq}{wxstringeq}\\
\helpref{wxStringMatch}{wxstringmatch}\\
@ -1226,6 +1227,16 @@ as wxGetTranslation.
Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty
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}
\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}
\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\_HIGHLIGHT(id, func)}}{The menu item with the
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
generated.
This function may cause a subsequent call to GetNextChild to fail.
\membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems}
\func{void}{DeleteAllItems}{\void}
@ -253,6 +255,10 @@ Deletes all children of the given item (but not the item itself). Note that
this will {\bf not} generate any events unlike
\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}
\func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}}
@ -625,6 +631,7 @@ returned as a tuple.}
\param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
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 normal image list specifying the image to use for unselected and
@ -844,7 +851,7 @@ The new mode takes effect immediately.
Sorts the children of the given item using
\helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
should override that method to change the sort order (the default is ascending
alphabetical order).
case-sensitive alphabetical order).
\wxheading{See also}