From 0e66b227787638a02ab00910bce292e194ffedad Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Mon, 28 Apr 2003 10:37:08 +0000 Subject: [PATCH] Doc suggestions applied git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_4_BRANCH@20367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/arrstrng.tex | 2 +- docs/latex/wx/bitmap.tex | 6 ++++++ docs/latex/wx/config.tex | 2 +- docs/latex/wx/function.tex | 11 +++++++++++ docs/latex/wx/menuevt.tex | 3 ++- docs/latex/wx/treectrl.tex | 9 ++++++++- docs/latex/wx/wxstring.tex | 2 ++ 7 files changed, 31 insertions(+), 4 deletions(-) diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index 1b706a26af..74d76579c5 100644 --- a/docs/latex/wx/arrstrng.tex +++ b/docs/latex/wx/arrstrng.tex @@ -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 diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index b5082e5dd8..a88539e439 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -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}} diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index b00e4624c6..3a76db5598 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -28,7 +28,7 @@ No base class (to let wxWindows choose a wxConfig class for your platform)\\ (base config class)\\ - (wxFileconfig class)\\ + (wxFileConfig class)\\ (wxRegConfig class)\\ (wxIniConfig class) diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index c82b49f4df..7c4a41ec45 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -207,6 +207,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}\\ @@ -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 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}} diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index d5a7f29a39..f20d372fe7 100644 --- a/docs/latex/wx/menuevt.tex +++ b/docs/latex/wx/menuevt.tex @@ -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 diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index 2c5c4afb29..5030eb93b0 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -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} @@ -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 \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}} @@ -621,6 +627,7 @@ returned as a tuple.} \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}). +{\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 @@ -840,7 +847,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} diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 0ba4b7638a..1c45f72813 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -970,6 +970,8 @@ Truncate the string to the given length. \func{void}{UngetWriteBuf}{\void} +\func{void}{UngetWriteBuf}{\param{size_t}{ len}} + Puts the string back into a reasonable state, after \rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.