More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

[wxWidgets.git] / interface / bmpcbox.h

diff --git a/interface/bmpcbox.h b/interface/bmpcbox.h
index 86aeb320654567b104bb00cb5d095308209fe243..765058513b1768eaa67347456a9a73e243908ca3 100644 (file)
--- a/interface/bmpcbox.h
+++ b/interface/bmpcbox.h
@@ -14,44 +14,57 @@
     It currently only allows using bitmaps of one size, and resizes itself
     so that a bitmap can be shown next to the text field.
 
+    @remarks
+    While wxBitmapComboBox contains the wxComboBox API, but it might not actually
+    be derived from that class. In fact, if the platform does not have a native
+    implementation, wxBitmapComboBox will inherit from wxOwnerDrawnComboBox.
+    You can determine if the implementation is generic by checking whether
+    @c wxGENERIC_BITMAPCOMBOBOX is defined.
+
     @beginStyleTable
-    @style{wxCB_READONLY}:
+    @style{wxCB_READONLY}
            Creates a combobox without a text editor. On some platforms the
            control may appear very different when this style is used.
-    @style{wxCB_SORT}:
+    @style{wxCB_SORT}
            Sorts the entries in the list alphabetically.
-    @style{wxTE_PROCESS_ENTER}:
+    @style{wxTE_PROCESS_ENTER}
            The control will generate the event wxEVT_COMMAND_TEXT_ENTER
            (otherwise pressing Enter key is either processed internally by the
-           control or used for navigation between dialog controls). Windows
-           only.
+           control or used for navigation between dialog controls).
+           Windows only.
     @endStyleTable
 
-    @beginEventTable
-    @event{EVT_COMBOBOX(id, func)}:
+    @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER!
+
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_COMBOBOX(id, func)}
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected.
-    @event{EVT_TEXT(id, func)}:
-           Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text
-           changes.
-    @event{EVT_TEXT_ENTER(id, func)}:
+    @event{EVT_TEXT(id, func)}
+           Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text changes.
+    @event{EVT_TEXT_ENTER(id, func)}
            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
            the combobox.
     @endEventTable
 
     @library{wxadv}
     @category{ctrl}
-    @appearance{bitmapcombobox.png}
+    <!-- @appearance{bitmapcombobox.png} -->
 
     @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent
 */
 class wxBitmapComboBox : public wxComboBox
 {
 public:
+    /**
+        Default ctor.
+    */
+    wxBitmapComboBox();
+
     //@{
     /**
         Constructor, creating and showing a combobox.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -61,8 +74,7 @@ public:
         @param pos
             Window position.
         @param size
-            Window size. If wxDefaultSize is specified then the window is
-        sized
+            Window size. If wxDefaultSize is specified then the window is sized
             appropriately.
         @param n
             Number of strings with which to initialise the control.
@@ -74,10 +86,9 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
-    wxBitmapComboBox();
     wxBitmapComboBox(wxWindow* parent, wxWindowID id,
                      const wxString& value = "",
                      const wxPoint& pos = wxDefaultPosition,
@@ -100,15 +111,19 @@ public:
     /**
         Destructor, destroying the combobox.
     */
-    ~wxBitmapComboBox();
+    virtual ~wxBitmapComboBox();
 
-    //@{
     /**
-        Adds the item to the end of the combo box, associating the given, typed or
-        untyped, client data pointer with the item.
+        Adds the item to the end of the combo box.
     */
     int Append(const wxString& item,
                const wxBitmap& bitmap = wxNullBitmap);
+
+    //@{
+    /**
+        Adds the item to the end of the combo box, associating the given, typed or
+        untyped, client data pointer @a clientData with the item.
+    */
     int Append(const wxString& item, const wxBitmap& bitmap,
                void* clientData);
     int Append(const wxString& item, const wxBitmap& bitmap,
@@ -142,21 +157,27 @@ public:
     /**
         Returns size of bitmaps used in the list.
     */
-    wxSize GetBitmapSize() const;
+    virtual wxSize GetBitmapSize() const;
 
     /**
         Returns the bitmap of the item with the given index.
     */
-    wxBitmap GetItemBitmap(unsigned int n) const;
+    virtual wxBitmap GetItemBitmap(unsigned int n) const;
+
+    /**
+        Inserts the item into the list before @a pos.
+        Not valid for @c wxCB_SORT style, use Append() instead.
+    */
+    int Insert(const wxString& item, const wxBitmap& bitmap,
+               unsigned int pos);
 
     //@{
     /**
         Inserts the item into the list before pos, associating the given, typed or
         untyped, client data pointer with the item.
-        Not valid for @c wxCB_SORT style, use Append instead.
+        Not valid for @c wxCB_SORT style, use Append() instead.
     */
-    int Insert(const wxString& item, const wxBitmap& bitmap,
-               unsigned int pos);
+
     int Insert(const wxString& item, const wxBitmap& bitmap,
                unsigned int pos,
                void* clientData);
@@ -168,6 +189,6 @@ public:
     /**
         Sets the bitmap for the given item.
     */
-    void SetItemBitmap(unsigned int n, const wxBitmap& bitmap);
+    virtual void SetItemBitmap(unsigned int n, const wxBitmap& bitmap);
 };