Minor doc corrections for [q-r] in ticket #9581 (most of the patch was applied alread...

[wxWidgets.git] / interface / ctrlsub.h

diff --git a/interface/ctrlsub.h b/interface/ctrlsub.h
index efe7d939c8dea28f82bf30f24c0d5a4e1ab7c985..f5407614709e3d61963451f3ca475d5d58f694dc 100644 (file)
--- a/interface/ctrlsub.h
+++ b/interface/ctrlsub.h
@@ -8,6 +8,7 @@
 
 
 /**
 
 
 /**

+    @class wxItemContainerImmutable

     @wxheader{ctrlsub.h}
 
     wxItemContainer defines an interface which is implemented by all controls
     @wxheader{ctrlsub.h}
 
     wxItemContainer defines an interface which is implemented by all controls


@@ -49,15 +50,14 @@ public:
     */
     bool IsEmpty() const;
 
     */
     bool IsEmpty() const;
 

-

     /**
         Returns the label of the item with the given index.
 
         @param n
             The zero-based index.
 
     /**
         Returns the label of the item with the given index.
 
         @param n
             The zero-based index.
 

-        @returns The label of the item or an empty string if the position was
-                 invalid.
+        @return The label of the item or an empty string if the position was
+                invalid.

     */
     virtual wxString GetString(unsigned int n) const;
 
     */
     virtual wxString GetString(unsigned int n) const;
 


@@ -84,15 +84,14 @@ public:
         @param caseSensitive
             Whether search is case sensitive (default is not).
 
         @param caseSensitive
             Whether search is case sensitive (default is not).
 

-        @returns The zero-based position of the item, or wxNOT_FOUND if the
-                 string was not found.
+        @return The zero-based position of the item, or wxNOT_FOUND if the
+                string was not found.

     */
     virtual int FindString(const wxString& s, bool bCase = false) const;
 
     //@}
 
     */
     virtual int FindString(const wxString& s, bool bCase = false) const;
 
     //@}
 

-    // selection
-    // ---------
+    /// @name Selection

     //@{
 
     /**
     //@{
 
     /**


@@ -114,7 +113,7 @@ public:
         Returns the index of the selected item or @c wxNOT_FOUND if no item is
         selected.
 
         Returns the index of the selected item or @c wxNOT_FOUND if no item is
         selected.
 

-        @returns The position of the current selection.
+        @return The position of the current selection.

 
         @remarks This method can be used with single selection list boxes only,
                  you should use wxListBox::GetSelections() for the list
 
         @remarks This method can be used with single selection list boxes only,
                  you should use wxListBox::GetSelections() for the list


@@ -131,8 +130,8 @@ public:
         @param string
             The string to select.
 
         @param string
             The string to select.
 

-        @returns @true if the specified string has been selected, @false if it
-                 wasn't found in the control.
+        @return @true if the specified string has been selected, @false if it
+                wasn't found in the control.

     */
     bool SetStringSelection(const wxString& string);
 
     */
     bool SetStringSelection(const wxString& string);
 


@@ -155,6 +154,7 @@ public:
 
 
 /**
 
 
 /**

+    @class wxItemContainer

     @wxheader{ctrlsub.h}
 
     This class is an abstract base class for some wxWidgets controls which
     @wxheader{ctrlsub.h}
 
     This class is an abstract base class for some wxWidgets controls which


@@ -175,13 +175,13 @@ public:
     simply stored by the control but not used in any way by it, or typed
     pointers (wxClientData*) which are owned by the control meaning that the
     typed client data (and only it) will be deleted when an item is deleted
     simply stored by the control but not used in any way by it, or typed
     pointers (wxClientData*) which are owned by the control meaning that the
     typed client data (and only it) will be deleted when an item is deleted

-    using wxItemContainer::Delete() or the entire control is cleared using
-    wxItemContainer::Clear(), which also happens when it is destroyed.
+    using Delete() or the entire control is cleared using Clear(), which also
+    happens when it is destroyed.

 
     Finally note that in the same control all items must have client data of
     the same type (typed or untyped), if any. This type is determined by the
 
     Finally note that in the same control all items must have client data of
     the same type (typed or untyped), if any. This type is determined by the

-    first call to wxItemContainer::Append() (the version with client data
-    pointer) or wxItemContainer::SetClientData().
+    first call to Append() (the version with client data pointer) or
+    SetClientData().

 
     Note that this is not a control, it's a mixin interface that classes
     have to derive from in addition to wxControl or wxWindow. Convenience
 
     Note that this is not a control, it's a mixin interface that classes
     have to derive from in addition to wxControl or wxWindow. Convenience


@@ -203,10 +203,10 @@ public:
         @param item
             String to add.
 
         @param item
             String to add.
 

-        @returns The return value is the index of the newly inserted item.
-                 Note that this may be different from the last one if the
-                 control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
-                 style).
+        @return The return value is the index of the newly inserted item.
+                Note that this may be different from the last one if the
+                control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
+                style).

     */
     int Append(const wxString& item);
 
     */
     int Append(const wxString& item);
 


@@ -218,10 +218,10 @@ public:
         @param clientData
             Pointer to client data to associate with the new item.
 
         @param clientData
             Pointer to client data to associate with the new item.
 

-        @returns The return value is the index of the newly inserted item.
-                 Note that this may be different from the last one if the
-                 control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
-                 style).
+        @return The return value is the index of the newly inserted item.
+                Note that this may be different from the last one if the
+                control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
+                style).

     */
     int Append(const wxString& item, void* clientData);
 
     */
     int Append(const wxString& item, void* clientData);
 


@@ -233,10 +233,10 @@ public:
         @param clientData
             Pointer to client data to associate with the new item.
 
         @param clientData
             Pointer to client data to associate with the new item.
 

-        @returns The return value is the index of the newly inserted item.
-                 Note that this may be different from the last one if the
-                 control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
-                 style).
+        @return The return value is the index of the newly inserted item.
+                Note that this may be different from the last one if the
+                control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
+                style).

     */
     int Append(const wxString& item, wxClientData* clientData);
 
     */
     int Append(const wxString& item, wxClientData* clientData);
 


@@ -361,7 +361,7 @@ public:
         @param n
             The zero-based position of the item.
 
         @param n
             The zero-based position of the item.
 

-        @returns A pointer to the client data, or @NULL if not present.
+        @return A pointer to the client data, or @NULL if not present.

     */
     void* GetClientData(unsigned int n) const;
 
     */
     void* GetClientData(unsigned int n) const;
 


@@ -375,7 +375,7 @@ public:
         @param n
             The zero-based position of the item.
 
         @param n
             The zero-based position of the item.
 

-        @returns A pointer to the client data, or @NULL if not present.
+        @return A pointer to the client data, or @NULL if not present.

     */
     wxClientData* GetClientObject(unsigned int n) const;
 
     */
     wxClientData* GetClientObject(unsigned int n) const;
 


@@ -418,8 +418,8 @@ public:
         @param pos
             Position to insert item before, zero based.
 
         @param pos
             Position to insert item before, zero based.
 

-        @returns The return value is the index of the newly inserted item.
-                 If the insertion failed for some reason, -1 is returned.
+        @return The return value is the index of the newly inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(const wxString& item, unsigned int pos);
 
     */
     int Insert(const wxString& item, unsigned int pos);
 


@@ -433,8 +433,8 @@ public:
         @param clientData
             Pointer to client data to associate with the new item.
 
         @param clientData
             Pointer to client data to associate with the new item.
 

-        @returns The return value is the index of the newly inserted item.
-                 If the insertion failed for some reason, -1 is returned.
+        @return The return value is the index of the newly inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(const wxString& item, unsigned int pos, void* clientData);
 
     */
     int Insert(const wxString& item, unsigned int pos, void* clientData);
 


@@ -448,8 +448,8 @@ public:
         @param clientData
             Pointer to client data to associate with the new item.
 
         @param clientData
             Pointer to client data to associate with the new item.
 

-        @returns The return value is the index of the newly inserted item.
-                 If the insertion failed for some reason, -1 is returned.
+        @return The return value is the index of the newly inserted item.
+                If the insertion failed for some reason, -1 is returned.

     */
     int Insert(const wxString& item, unsigned int pos,
                wxClientData* clientData);
     */
     int Insert(const wxString& item, unsigned int pos,
                wxClientData* clientData);