Doc suggestions applied

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@20367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex
index ea7fec95400d22df891344e9cc94f435dff4c774..0d12b11b81bd34a61a568d1e996ad75e987cbc9f 100644 (file)
--- 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 
 \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 
 
 {\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 71e1d47759d74d7c16c0d09eb703daf7b019adf3..9a179f0bf538ceb26ee5f247f94276be410389e2 100644 (file)
--- 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.
 
 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}}
 \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/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index 7789b647884b96fc5f4146a1e842ad426aab4aee..bf2edce0341b7f4ceec931fe1b9d95090081dec5 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -86,7 +86,7 @@ Clears the global clipboard object and the system's clipboard if possible.
 
 \membersection{wxClipboard::Close}\label{wxclipboardclose}
 
 
 \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}.
 
 
 Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.
 

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 14301013216d8ef6db29b8891b25e407fc71723f..03b3a892236e830770478bb2284b1be1d86b8006 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -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/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)
 
 <wx/msw/regconf.h> (wxRegConfig class)\\
 <wx/msw/iniconf.h> (wxIniConfig class)
 

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index b5261ffb0b670753144b368c666f3b8b56c3ef20..9af09d9c0aa9d6ad66c140aa0991ec9859ab45cd 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -201,6 +201,7 @@ the corresponding topic.
 \helpref{wxSplitPath}{wxsplitfunction}\\
 \helpref{wxStartTimer}{wxstarttimer}\\
 \helpref{wxStaticCast}{wxstaticcast}\\
 \helpref{wxSplitPath}{wxsplitfunction}\\
 \helpref{wxStartTimer}{wxstarttimer}\\
 \helpref{wxStaticCast}{wxstaticcast}\\

+\helpref{wxStrcmp}{wxstrcmp}\\

 \helpref{wxStricmp}{wxstricmp}\\
 \helpref{wxStringEq}{wxstringeq}\\
 \helpref{wxStringMatch}{wxstringmatch}\\
 \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.
 
 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}}
 \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 d6cab4486b655686c432106ee41461ec6cd8e1d1..9f9c1473937ea81e615c8ee00ba5052ce121fbee 100644 (file)
--- 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
 
 \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
 \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 9d102d9419003321808f37d2030c9be8a232cb53..e625e3059d86e22a1f89641d6f730e8140490ac2 100644 (file)
--- 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.
 
 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}
 \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.
 
 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}}
 \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}).
  \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
 
 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
 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}
 
 
 \wxheading{See also}