remove C++ comment

[wxWidgets.git] / docs / latex / wx / arrstrng.tex

diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex
index 71f698a11c6569796867fe1b8fbcb37a8d3bb3c7..fc5877f8cb90b06efa9dee6ba8aa5676dc7754bb 100644 (file)
--- a/docs/latex/wx/arrstrng.tex
+++ b/docs/latex/wx/arrstrng.tex
@@ -12,7 +12,7 @@ uses its knowledge of internals of wxString class to achieve this).
 This class is used in the same way as other dynamic \helpref{arrays}{wxarray},
 except that no {\it WX\_DEFINE\_ARRAY} declaration is needed for it. When a
 string is added or inserted in the array, a copy of the string is created, so
 This class is used in the same way as other dynamic \helpref{arrays}{wxarray},
 except that no {\it WX\_DEFINE\_ARRAY} declaration is needed for it. When a
 string is added or inserted in the array, a copy of the string is created, so

-the original string may be safely deleted (e.g. if it was a {\it char *} 
+the original string may be safely deleted (e.g. if it was a {\it wxChar *} 

 pointer the memory it was using can be freed immediately after this). In
 general, there is no need to worry about string memory deallocation when using
 this class - it will always free the memory it uses itself.
 pointer the memory it was using can be freed immediately after this). In
 general, there is no need to worry about string memory deallocation when using
 this class - it will always free the memory it uses itself.


@@ -26,14 +26,14 @@ array elements may be modified in place like this
     array.Last().MakeUpper();
 \end{verbatim}
 
     array.Last().MakeUpper();
 \end{verbatim}
 

-There is also a varian of wxArrayString called wxSortedArrayString which has
+There is also a variant of wxArrayString called wxSortedArrayString which has

 exactly the same methods as wxArrayString, but which always keeps the string
 in it in (alphabetical) order. wxSortedArrayString uses binary search in its 
 exactly the same methods as wxArrayString, but which always keeps the string
 in it in (alphabetical) order. wxSortedArrayString uses binary search in its 

-\helpref{Index}{wxarraystringindex} function (insteadf of linear search for
+\helpref{Index}{wxarraystringindex} function (instead of linear search for

 wxArrayString::Index) which makes it much more efficient if you add strings to
 the array rarely (because, of course, you have to pay for Index() efficiency
 by having Add() be slower) but search for them often. Several methods should
 wxArrayString::Index) which makes it much more efficient if you add strings to
 the array rarely (because, of course, you have to pay for Index() efficiency
 by having Add() be slower) but search for them often. Several methods should

-not be used with sorted array (basicly, all which break the order of items)
+not be used with sorted array (basically, all which break the order of items)

 which is mentioned in their description.
 
 Final word: none of the methods of wxArrayString is virtual including its
 which is mentioned in their description.
 
 Final word: none of the methods of wxArrayString is virtual including its


@@ -48,7 +48,11 @@ functions.
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/string.h>
+<wx/arrstr.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -60,13 +64,23 @@ functions.
 
 \func{}{wxArrayString}{\void}
 
 
 \func{}{wxArrayString}{\void}
 

-\func{}{wxArrayString}{\param{const wxArrayString\&}{ array}}
+Default constructor.

 
 

-Default and copy constructors.
+\func{}{wxArrayString}{\param{const wxArrayString\&}{ array}}

 
 

-Note that when an array is assigned to a sorted array, its contents is
+Copy constructor. Note that when an array is assigned to a sorted array, its contents is

 automatically sorted during construction.
 
 automatically sorted during construction.
 

+\func{}{wxArrayString}{\param{size\_t}{ sz}, \param{const char**}{ arr}}
+
+\func{}{wxArrayString}{\param{size\_t}{ sz}, \param{const wchar\_t**}{ arr}}
+
+Constructor from a C string array. Pass a size {\it sz} and array {\it arr}.
+
+\func{}{wxArrayString}{\param{size\_t}{ sz}, \param{const wxString*}{ arr}}
+
+Constructor from a wxString array. Pass a size {\it sz} and array {\it arr}.
+

 \membersection{wxArrayString::\destruct{wxArrayString}}\label{wxarraystringdtor}
 
 \func{}{\destruct{wxArrayString}}{}
 \membersection{wxArrayString::\destruct{wxArrayString}}\label{wxarraystringdtor}
 
 \func{}{\destruct{wxArrayString}}{}


@@ -84,14 +98,14 @@ Assignment operator.
 
 \constfunc{bool}{operator $==$}{\param{const wxArrayString\&}{ array}}
 
 
 \constfunc{bool}{operator $==$}{\param{const wxArrayString\&}{ array}}
 

-Compares 2 arrays respecting the case. Returns TRUE only if the arrays have
+Compares 2 arrays respecting the case. Returns true only if the arrays have

 the same number of elements and the same strings in the same order.
 
 \membersection{wxArrayString::operator!=}\label{wxarraystringoperatornotequal}
 
 \constfunc{bool}{operator $!=$}{\param{const wxArrayString\&}{ array}}
 
 the same number of elements and the same strings in the same order.
 
 \membersection{wxArrayString::operator!=}\label{wxarraystringoperatornotequal}
 
 \constfunc{bool}{operator $!=$}{\param{const wxArrayString\&}{ array}}
 

-Compares 2 arrays respecting the case. Returns TRUE if the arrays have
+Compares 2 arrays respecting the case. Returns true if the arrays have

 different number of elements or if the elements don't match pairwise.
 
 \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex}
 different number of elements or if the elements don't match pairwise.
 
 \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex}


@@ -106,10 +120,10 @@ This is the operator version of \helpref{Item}{wxarraystringitem} method.
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 

-\func{size\_t}{Add}{\param{const wxString\& }{str}}
+\func{size\_t}{Add}{\param{const wxString\& }{str}, \param{size\_t}{ copies = $1$}}

 
 

-Appends a new item to the array and return the index of th new item in the
-array.
+Appends the given number of {\it copies} of the new item {\it str} to the
+array and returns the index of the first new item in the array.

 
 {\bf Warning:} For sorted arrays, the index of the inserted item will not be,
 in general, equal to \helpref{GetCount()}{wxarraystringgetcount} - 1 because
 
 {\bf Warning:} For sorted arrays, the index of the inserted item will not be,
 in general, equal to \helpref{GetCount()}{wxarraystringgetcount} - 1 because


@@ -136,14 +150,6 @@ Clears the array contents and frees memory.
 
 See also: \helpref{Empty}{wxarraystringempty}
 
 
 See also: \helpref{Empty}{wxarraystringempty}
 

-\membersection{wxArrayString::Count}\label{wxarraystringcount}
-
-\constfunc{size\_t}{Count}{\void}
-
-Returns the number of items in the array. This function is deprecated and is
-for backwards compatibility only, please use 
-\helpref{GetCount}{wxarraystringgetcount} instead.
-

 \membersection{wxArrayString::Empty}\label{wxarraystringempty}
 
 \func{void}{Empty}{\void}
 \membersection{wxArrayString::Empty}\label{wxarraystringempty}
 
 \func{void}{Empty}{\void}


@@ -163,30 +169,30 @@ Returns the number of items in the array.
 
 \membersection{wxArrayString::Index}\label{wxarraystringindex}
 
 
 \membersection{wxArrayString::Index}\label{wxarraystringindex}
 

-\func{int}{Index}{\param{const char *}{ sz}, \param{bool}{ bCase = TRUE}, \param{bool}{ bFromEnd = FALSE}}
+\func{int}{Index}{\param{const wxString\& }{ sz}, \param{bool}{ bCase = true}, \param{bool}{ bFromEnd = false}}

 
 Search the element in the array, starting from the beginning if
 
 Search the element in the array, starting from the beginning if

-{\it bFromEnd} is FALSE or from end otherwise. If {\it bCase}, comparison is
+{\it bFromEnd} is false or from end otherwise. If {\it bCase}, comparison is

 case sensitive (default), otherwise the case is ignored.
 
 This function uses linear search for wxArrayString and binary search for
 wxSortedArrayString, but it ignores the {\it bCase} and {\it bFromEnd} 
 parameters in the latter case.
 
 case sensitive (default), otherwise the case is ignored.
 
 This function uses linear search for wxArrayString and binary search for
 wxSortedArrayString, but it ignores the {\it bCase} and {\it bFromEnd} 
 parameters in the latter case.
 

-Returns index of the first item matched or wxNOT\_FOUND if there is no match.
+Returns index of the first item matched or {\tt wxNOT\_FOUND} if there is no match.

 
 \membersection{wxArrayString::Insert}\label{wxarraystringinsert}
 
 
 \membersection{wxArrayString::Insert}\label{wxarraystringinsert}
 

-\func{void}{Insert}{\param{const wxString\& }{str}, \param{size\_t}{ nIndex}}
+\func{void}{Insert}{\param{const wxString\& }{str}, \param{size\_t}{ nIndex}, \param{size\_t }{copies = $1$}}

 
 

-Insert a new element in the array before the position {\it nIndex}. Thus, for
+Insert the given number of {\it copies} of the new element in the array before the position {\it nIndex}. Thus, for

 example, to insert the string in the beginning of the array you would write
 
 \begin{verbatim}
 Insert("foo", 0);
 \end{verbatim}
 
 example, to insert the string in the beginning of the array you would write
 
 \begin{verbatim}
 Insert("foo", 0);
 \end{verbatim}
 

-If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as 
+If {\it nIndex} is equal to {\it GetCount()} this function behaves as 

 \helpref{Add}{wxarraystringadd}.
 
 {\bf Warning:} this function should not be used with sorted arrays because it
 \helpref{Add}{wxarraystringadd}.
 
 {\bf Warning:} this function should not be used with sorted arrays because it


@@ -195,9 +201,9 @@ could break the order of items and, for example, subsequent calls to
 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 
 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 

-\func{}{IsEmpty}{}
+\func{bool}{IsEmpty}{}

 
 

-Returns TRUE if the array is empty, FALSE otherwise. This function returns the
+Returns true if the array is empty, false otherwise. This function returns the

 same result as {\it GetCount() == 0} but is probably easier to read.
 
 \membersection{wxArrayString::Item}\label{wxarraystringitem}
 same result as {\it GetCount() == 0} but is probably easier to read.
 
 \membersection{wxArrayString::Item}\label{wxarraystringitem}


@@ -213,7 +219,7 @@ version.
 
 \membersection{wxArrayString::Last}\label{wxarraystringlast}
 
 
 \membersection{wxArrayString::Last}\label{wxarraystringlast}
 

-\func{}{Last}{}
+\func{wxString&}{Last}{}

 
 Returns the last element of the array. Attempt to access the last element of
 an empty array will result in assert failure in debug build, however no checks
 
 Returns the last element of the array. Attempt to access the last element of
 an empty array will result in assert failure in debug build, however no checks


@@ -221,16 +227,18 @@ are done in release mode.
 
 \membersection{wxArrayString::Remove}\label{wxarraystringremove}
 
 
 \membersection{wxArrayString::Remove}\label{wxarraystringremove}
 

-\func{void}{Remove}{\param{const char *}{ sz}}
+\func{void}{Remove}{\param{const wxString\&}{ sz}}

 
 Removes the first item matching this value. An assert failure is provoked by
 an attempt to remove an element which does not exist in debug build.
 
 See also: \helpref{Index}{wxarraystringindex}
 
 
 Removes the first item matching this value. An assert failure is provoked by
 an attempt to remove an element which does not exist in debug build.
 
 See also: \helpref{Index}{wxarraystringindex}
 

-\func{void}{Remove}{\param{size\_t }{nIndex}}
+\membersection{wxArrayString::RemoveAt}\label{wxarraystringremoveat}
+
+\func{void}{RemoveAt}{\param{size\_t }{nIndex}, \param{size\_t }{count = $1$}}

 
 

-Removes the item at given position.
+Removes {\it count} items starting at position {\it nIndex} from the array.

 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}
 
 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}
 


@@ -243,10 +251,10 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man
 
 \membersection{wxArrayString::Sort}\label{wxarraystringsort}
 
 
 \membersection{wxArrayString::Sort}\label{wxarraystringsort}
 

-\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
 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