X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d1b5756b71267e8c5b123dc868e38034e57ff0d5..82540ef2327daaf6ae78189139a669afc9edf9d9:/docs/latex/wx/array.tex diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex index f4d712e9ab..2840322d0c 100644 --- a/docs/latex/wx/array.tex +++ b/docs/latex/wx/array.tex @@ -2,7 +2,7 @@ This section describes the so called {\it dynamic arrays}. This is a C array-like data structure i.e. the member access time is constant (and not -linear in number of container elements as for linked lists). However, these +linear according to the number of container elements as for linked lists). However, these arrays are dynamic in the sense that they will automatically allocate more memory if there is not enough of it for adding a new element. They also perform range checking on the index values but in debug mode only, so please be sure to @@ -15,7 +15,7 @@ release build. The array classes were designed to be reasonably efficient, both in terms of run-time speed and memory consumption and the executable size. The speed of -array item access if, of course, constant (independent of number of elements) +array item access is, of course, constant (independent of the number of elements) making them much more efficient than linked lists (\helpref{wxList}{wxlist}). Adding items to the arrays is also implemented in more or less constant time - but the price is preallocating the memory in advance. In the \helpref{memory management}{wxarraymemorymanagement} section @@ -35,8 +35,8 @@ element type. wxArray is suitable for storing integer types and pointers which it does not treat as objects in any way, i.e. the element pointed to by the pointer is not -deleted when the element is removed from the array \&c. It should be noted that -all of wxArray functions are inline, so it costs strictly nothing to define as +deleted when the element is removed from the array. It should be noted that +all of wxArray's functions are inline, so it costs strictly nothing to define as many array types as you want (either in terms of the executable size or the speed) as long as at least one of them is defined and this is always the case because wxArrays are used by wxWindows internally. @@ -94,7 +94,6 @@ class MyDirectory WX_DEFINE_OBJARRAY(ArrayOfDirectories); // that's all! - \end{verbatim} It is not as elegant as writing @@ -106,7 +105,7 @@ typedef std::vector ArrayOfDirectories; but is not that complicated and allows the code to be compiled with any, however dumb, C++ compiler in the world. -The things are much simpler for wxArray and wxSortedArray however: it is enough +Things are much simpler for wxArray and wxSortedArray however: it is enough just to write \begin{verbatim} @@ -209,7 +208,7 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method. \membersection{WX\_DEFINE\_ARRAY}\label{wxdefinearray} -\func{}{WX\_DEFINE\_ARRAY}{\param{}{T}, \param{name}} +\func{}{WX\_DEFINE\_ARRAY}{\param{}{T}, \param{}{name}} This macro defines a new array class named {\it name} and containing the elements of type {\it T}. Example: @@ -263,10 +262,12 @@ wxArrayOfMyClass another(CompareMyClassObjects); This macro declares a new object array class named {\it name} and containing the elements of type {\it T}. Example: + \begin{verbatim} class MyClass; WX_DEFINE_OBJARRAY(MyClass, wxArrayOfMyClass); // note: not "MyClass *"! \end{verbatim} + You must use \helpref{WX\_DEFINE\_OBJARRAY()}{wxdefineobjarray} macro to define the array class - otherwise you would get link errors. @@ -303,17 +304,17 @@ WX_DEFINE_OBJARRAY(wxArrayOfMyClass); \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray} -\func{\void}{WX\_CLEAR\_ARRAY}{\param{wxArray\& }{array}} +\func{void}{WX\_CLEAR\_ARRAY}{\param{wxArray\& }{array}} This macro may be used to delete all elements of the array before emptying it. It can not be used with wxObjArrays - but they will delete their elements anyhow when you call Empty(). -\membersection{Default constructors}\label{wxarrayctor} +\membersection{Default constructors}\label{wxarrayctordef} -\func{}{wxArray}{} +\func{}{wxArray}{\void} -\func{}{wxObjArray}{} +\func{}{wxObjArray}{\void} Default constructor initializes an empty array object. @@ -325,7 +326,7 @@ two arguments of type {\it T} where {\it T} is the array element type and which should return a negative, zero or positive value according to whether the first element passed to it is less than, equal to or greater than the second one. -\membersection{wxArray copy constructor and assignemnt operator}\label{wxarrayctorcopy} +\membersection{wxArray copy constructor and assignment operator}\label{wxarrayctorcopy} \func{}{wxArray}{\param{const wxArray\& }{array}} @@ -333,11 +334,11 @@ element passed to it is less than, equal to or greater than the second one. \func{}{wxObjArray}{\param{const wxObjArray\& }{array}} -\func{wxArray\&}{operator=}{\param{const wxArray\& }{array}} +\func{wxArray\&}{operator$=$}{\param{const wxArray\& }{array}} -\func{wxSortedArray\&}{operator=}{\param{const wxSortedArray\& }{array}} +\func{wxSortedArray\&}{operator$=$}{\param{const wxSortedArray\& }{array}} -\func{wxObjArray\&}{operator=}{\param{const wxObjArray\& }{array}} +\func{wxObjArray\&}{operator$=$}{\param{const wxObjArray\& }{array}} The copy constructors and assignment operators perform a shallow array copy (i.e. they don't copy the objects pointed to even if the source array contains @@ -346,11 +347,11 @@ the array element are copied too) for wxObjArray. \membersection{wxArray::\destruct{wxArray}}\label{wxarraydtor} -\func{}{\destruct{wxArray}}{} +\func{}{\destruct{wxArray}}{\void} -\func{}{\destruct{wxSortedArray}}{} +\func{}{\destruct{wxSortedArray}}{\void} -\func{}{\destruct{wxObjArray}}{} +\func{}{\destruct{wxObjArray}}{\void} The wxObjArray destructor deletes all the items owned by the array. This is not done by wxArray and wxSortedArray versions - you may use @@ -358,17 +359,17 @@ done by wxArray and wxSortedArray versions - you may use \membersection{wxArray::Add}\label{wxarrayadd} -\func{\void}{Add}{\param{T }{item}} +\func{void}{Add}{\param{T }{item}} -\func{\void}{Add}{\param{T *}{item}} +\func{void}{Add}{\param{T *}{item}} -\func{\void}{Add}{\param{T \&}{item}} +\func{void}{Add}{\param{T \&}{item}} Appends a new element to the array (where {\it T} is the type of the array elements.) The first version is used with wxArray and wxSortedArray. The second and the -third are used with wxObjArray. There is an {\bf important difference} between +third are used with wxObjArray. There is an important difference between them: if you give a pointer to the array, it will take ownership of it, i.e. will delete it when the item is deleted from the array. If you give a reference to the array, however, the array will make a copy of the item and will not take @@ -377,7 +378,7 @@ because the other array types never take ownership of their elements. \membersection{wxArray::Alloc}\label{wxarrayalloc} -\func{\void}{Alloc}{\param{size\_t }{count}} +\func{void}{Alloc}{\param{size\_t }{count}} Preallocates memory for a given number of array elements. It is worth calling when the number of items which are going to be added to the array is known in @@ -386,7 +387,7 @@ has enough memory for the given number of items, nothing happens. \membersection{wxArray::Clear}\label{wxarrayclear} -\func{\void}{Clear}{\void} +\func{void}{Clear}{\void} This function does the same as \helpref{Empty()}{wxarrayempty} and additionally frees the memory allocated to the array. @@ -409,11 +410,11 @@ pointer to the removed element. \membersection{wxArray::Empty}\label{wxarrayempty} -\func{\void}{Empty}{\void} +\func{void}{Empty}{\void} Empties the array. For wxObjArray classes, this destroys all of the array elements. For wxArray and wxSortedArray this does nothing except marking the -array of being empty - this function does not free the allocated memory, use +array of being empty - this function does not free the allocated memory, use \helpref{Clear()}{wxarrayclear} for this. \membersection{wxArray::GetCount}\label{wxarraygetcount} @@ -442,14 +443,14 @@ parameter doesn't make sense for it). \membersection{wxArray::Insert}\label{wxarrayinsert} -\func{\void}{Insert}{\param{T }{item}, \param{size\_t }{n}} +\func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}} -\func{\void}{Insert}{\param{T *}{item}, \param{size\_t }{n}} +\func{void}{Insert}{\param{T *}{item}, \param{size\_t }{n}} -\func{\void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}} +\func{void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}} -Insert a new item into the array before the item {\it n} - thus, {\it -Insert(something, 0u}} will insert an item in such way that it will become the +Insert a new item into the array before the item {\it n} - thus, {\it Insert(something, 0u)} will +insert an item in such way that it will become the first array element. Please see \helpref{Add()}{wxarrayadd} for explanation of the differences @@ -457,7 +458,7 @@ between the overloaded versions of this function. \membersection{wxArray::IsEmpty}\label{wxarrayisempty} -\constfunc{bool}{IsEmpty}{} +\constfunc{bool}{IsEmpty}{\void} Returns TRUE if the array is empty, FALSE otherwise. @@ -505,7 +506,7 @@ elements of a wxArray (supposed to contain pointers). \membersection{wxArray::Shrink}\label{wxarrayshrink} -\func{\void}{Shrink}{\void} +\func{void}{Shrink}{\void} Frees all memory unused by the array. If the program knows that no new items will be added to the array it may call Shrink() to reduce its memory usage. @@ -514,7 +515,7 @@ allocated again. \membersection{wxArray::Sort}\label{wxarraysort} -\func{\void}{Sort}{\param{CMPFUNC }{compareFunction}} +\func{void}{Sort}{\param{CMPFUNC }{compareFunction}} The notation CMPFUNC should be read as if we had the following declaration: @@ -522,7 +523,7 @@ The notation CMPFUNC should be read as if we had the following declaration: template int CMPFUNC(T *first, T *second); \end{verbatim} -where {\it T} is the type of the array elements. I.e. it is a function returning +where {\it T} is the type of the array elements. I.e. it is a function returning {\it int} which is passed two arguments of type {\it T *}. Sorts the array using the specified compare function: this function should