Add documentation of wxFileSelectorEx() and wx{Load,Save}FileSelector().

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

diff --git a/interface/wx/odcombo.h b/interface/wx/odcombo.h
index 778ea4e20283a0abda3675370173de4951b6c513..568079dc2263edadd33dfbe469c57a15716fe23e 100644 (file)
--- a/interface/wx/odcombo.h
+++ b/interface/wx/odcombo.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxOwnerDrawnComboBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxOwnerDrawnComboBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -45,7 +45,7 @@ enum wxOwnerDrawnComboBoxPaintingFlags
 
     @see wxComboCtrl window styles and @ref overview_windowstyles.
 
 
     @see wxComboCtrl window styles and @ref overview_windowstyles.
 

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

     @event{EVT_COMBOBOX(id, func)}
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue() returns the new
     @event{EVT_COMBOBOX(id, func)}
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue() returns the new


@@ -68,7 +68,6 @@ public:
     */
     wxOwnerDrawnComboBox();
 
     */
     wxOwnerDrawnComboBox();
 

-    //@{

     /**
         Constructor, creating and showing a owner-drawn combobox.
 
     /**
         Constructor, creating and showing a owner-drawn combobox.
 


@@ -97,11 +96,11 @@ public:
         @see Create(), wxValidator
     */
     wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,
         @see Create(), wxValidator
     */
     wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,

-                         const wxString& value = "",
+                         const wxString& value = wxEmptyString,

                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          int n = 0,
                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          int n = 0,

-                         const wxString[] choices = NULL,
+                         const wxString choices[] = NULL,

                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = "comboBox");
                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = "comboBox");


@@ -138,7 +137,6 @@ public:
                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = "comboBox");
                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = "comboBox");

-    //@}

 
     /**
         Destructor, destroying the owner-drawn combobox.
 
     /**
         Destructor, destroying the owner-drawn combobox.


@@ -152,22 +150,33 @@ public:
 
         @remarks Derived classes should call or replace this function.
     */
 
         @remarks Derived classes should call or replace this function.
     */

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

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                int n, const wxString choices[],

                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "comboBox");
-    bool Create(wxWindow* parent, wxWindowID id,
+                const wxString& name = wxComboBoxNameStr);
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& value,
+                const wxPoint& pos,
+                const wxSize& size,
+                int n,
+                const wxString choices[],
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxComboBoxNameStr);
+    bool Create(wxWindow *parent,
+                wxWindowID id,

                 const wxString& value,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& value,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,

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

     //@}
 
     /**
     //@}
 
     /**


@@ -180,6 +189,8 @@ public:
     */
     virtual int GetWidestItemWidth();
 
     */
     virtual int GetWidestItemWidth();
 

+protected:
+

     /**
         This method is used to draw the items background and, maybe, a border around it.
 
     /**
         This method is used to draw the items background and, maybe, a border around it.
 


@@ -189,8 +200,8 @@ public:
 
         @remarks flags has the same meaning as with OnDrawItem().
     */
 
         @remarks flags has the same meaning as with OnDrawItem().
     */

-    void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,
-                          int flags) const;
+    virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,
+                                  int flags) const;

 
     /**
         The derived class may implement this function to actually draw the item
 
     /**
         The derived class may implement this function to actually draw the item


@@ -209,8 +220,8 @@ public:
         @param flags
             A combination of the ::wxOwnerDrawnComboBoxPaintingFlags enumeration values.
     */
         @param flags
             A combination of the ::wxOwnerDrawnComboBoxPaintingFlags enumeration values.
     */

-    void OnDrawItem(wxDC& dc, const wxRect& rect, int item,
-                    int flags) const;
+    virtual void OnDrawItem(wxDC& dc, const wxRect& rect, int item,
+                            int flags) const;

 
     /**
         The derived class may implement this method to return the height of the
 
     /**
         The derived class may implement this method to return the height of the