Make storing non-trivial data in wxThreadSpecificInfo possible.

[wxWidgets.git] / interface / wx / bmpcbox.h

diff --git a/interface/wx/bmpcbox.h b/interface/wx/bmpcbox.h
index af60247aa8afc51d8d2c7e958c7c6a2f979658f7..a11249ea9e15867012d9ad01e6980a14af3c79d6 100644 (file)
--- a/interface/wx/bmpcbox.h
+++ b/interface/wx/bmpcbox.h
@@ -2,8 +2,7 @@
 // Name:        bmpcbox.h
 // Purpose:     interface of wxBitmapComboBox
 // Author:      wxWidgets team
 // Name:        bmpcbox.h
 // Purpose:     interface of wxBitmapComboBox
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -28,7 +27,7 @@
     @style{wxCB_SORT}
            Sorts the entries in the list alphabetically.
     @style{wxTE_PROCESS_ENTER}
     @style{wxCB_SORT}
            Sorts the entries in the list alphabetically.
     @style{wxTE_PROCESS_ENTER}

-           The control will generate the event wxEVT_COMMAND_TEXT_ENTER
+           The control will generate the event wxEVT_TEXT_ENTER

            (otherwise pressing Enter key is either processed internally by the
            control or used for navigation between dialog controls).
            Windows only.
            (otherwise pressing Enter key is either processed internally by the
            control or used for navigation between dialog controls).
            Windows only.


@@ -36,20 +35,20 @@
 
     @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER!
 
 
     @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER!
 

-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}

     @event{EVT_COMBOBOX(id, func)}
     @event{EVT_COMBOBOX(id, func)}

-           Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
+           Process a @c wxEVT_COMBOBOX event, when an item on

            the list is selected.
     @event{EVT_TEXT(id, func)}
            the list is selected.
     @event{EVT_TEXT(id, func)}

-           Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text changes.
+           Process a @c wxEVT_TEXT event, when the combobox text changes.

     @event{EVT_TEXT_ENTER(id, func)}
     @event{EVT_TEXT_ENTER(id, func)}

-           Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
+           Process a @c wxEVT_TEXT_ENTER event, when RETURN is pressed in

            the combobox.
     @endEventTable
 
     @library{wxadv}
     @category{ctrl}
            the combobox.
     @endEventTable
 
     @library{wxadv}
     @category{ctrl}

-    <!-- @appearance{bitmapcombobox.png} -->
+    @appearance{bitmapcombobox}

 
     @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent
 */
 
     @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent
 */


@@ -70,22 +69,32 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.

+        @param pos
+            Initial position.
+        @param size
+            Initial size.

         @param n
             Number of strings with which to initialise the control.
         @param choices
             An array of strings with which to initialise the control.
         @param n
             Number of strings with which to initialise the control.
         @param choices
             An array of strings with which to initialise the control.

+        @param style
+            The window style, see wxCB_* flags.
+        @param validator
+            Validator which can be used for additional data checks.
+        @param name
+            Control name.

 
         @see Create(), wxValidator
     */
 
         @see Create(), wxValidator
     */

-    wxBitmapComboBox(wxWindow* parent, wxWindowID id,
-                     const wxString& value = "",
+    wxBitmapComboBox(wxWindow* parent, wxWindowID id = wxID_ANY,
+                     const wxString& value = wxEmptyString,

                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      int n = 0,
                      const wxString choices[] = NULL,
                      long style = 0,
                      const wxValidator& validator = wxDefaultValidator,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      int n = 0,
                      const wxString choices[] = NULL,
                      long style = 0,
                      const wxValidator& validator = wxDefaultValidator,

-                     const wxString& name = "comboBox");
+                     const wxString& name = wxBitmapComboBoxNameStr);

 
     /**
         Constructor, creating and showing a combobox.
 
     /**
         Constructor, creating and showing a combobox.


@@ -96,8 +105,18 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.

+        @param pos
+            Initial position.
+        @param size
+            Initial size.

         @param choices
             An wxArrayString with which to initialise the control.
         @param choices
             An wxArrayString with which to initialise the control.

+        @param style
+            The window style, see wxCB_* flags.
+        @param validator
+            Validator which can be used for additional data checks.
+        @param name
+            Control name.

 
         @see Create(), wxValidator
     */
 
         @see Create(), wxValidator
     */


@@ -106,9 +125,9 @@ public:
                      const wxPoint& pos,
                      const wxSize& size,
                      const wxArrayString& choices,
                      const wxPoint& pos,
                      const wxSize& size,
                      const wxArrayString& choices,

-                     long style = 0,
+                     long style,

                      const wxValidator& validator = wxDefaultValidator,
                      const wxValidator& validator = wxDefaultValidator,

-                     const wxString& name = "comboBox");
+                     const wxString& name = wxBitmapComboBoxNameStr);

 
     /**
         Destructor, destroying the combobox.
 
     /**
         Destructor, destroying the combobox.


@@ -139,13 +158,13 @@ public:
         Creates the combobox for two-step construction.
     */
     bool Create(wxWindow* parent, wxWindowID id,
         Creates the combobox for two-step construction.
     */
     bool Create(wxWindow* parent, wxWindowID id,

-                const wxString& value = "",
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
+                const wxString& value,
+                const wxPoint& pos,
+                const wxSize& size,

                 int n, const wxString choices[],
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 int n, const wxString choices[],
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "comboBox");
+                const wxString& name = wxBitmapComboBoxNameStr);

 
     /**
         Creates the combobox for two-step construction.
 
     /**
         Creates the combobox for two-step construction.


@@ -157,10 +176,11 @@ public:
                 const wxArrayString& choices,
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxArrayString& choices,
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "comboBox");
+                const wxString& name = wxBitmapComboBoxNameStr);

 
     /**
 
     /**

-        Returns size of bitmaps used in the list.
+        Returns the size of the bitmaps used in the combo box.
+        If the combo box is empty, then ::wxDefaultSize is returned.

     */
     virtual wxSize GetBitmapSize() const;
 
     */
     virtual wxSize GetBitmapSize() const;