fix tests for WXWIN_COMPATIBILITY_2_8, closes #13800

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

diff --git a/interface/wx/combo.h b/interface/wx/combo.h
index 4cfafc2598181d88d9d2e40ebcf0feee5eee4c7b..268f247573b07e4862f11f716e5f74a136a245e7 100644 (file)
--- a/interface/wx/combo.h
+++ b/interface/wx/combo.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxComboCtrl and wxComboPopup
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxComboCtrl and wxComboPopup
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

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


@@ -36,11 +36,42 @@ public:
     */
     virtual bool Create(wxWindow* parent) = 0;
 
     */
     virtual bool Create(wxWindow* parent) = 0;
 

+    /**
+        You only need to implement this member function if you create
+        your popup class in non-standard way. The default implementation can
+        handle both multiple-inherited popup control (as seen in wxComboCtrl
+        samples) and one allocated separately in heap.
+
+        If you do completely re-implement this function, make sure it calls
+        Destroy() for the popup control and also deletes @a this object
+        (usually as the last thing).
+    */
+    virtual void DestroyPopup();
+

     /**
         Utility function that hides the popup.
     */
     void Dismiss();
 
     /**
         Utility function that hides the popup.
     */
     void Dismiss();
 

+    /**
+        Implement to customize matching of value string to an item container
+        entry.
+        
+        @param item
+            String entered, usually by user or from SetValue() call.
+            
+        @param trueItem
+            When item matches an entry, but the entry's string representation
+            is not exactly the same (case mismatch, for example), then the
+            true item string should be written back to here, if it is not
+            a NULL pointer.
+
+        @remarks
+            Default implementation always return true and does not alter
+            trueItem.
+    */
+    virtual bool FindItem(const wxString& item, wxString* trueItem=NULL);
+

     /**
         The derived class may implement this to return adjusted size for the
         popup control, according to the variables given.
     /**
         The derived class may implement this to return adjusted size for the
         popup control, according to the variables given.


@@ -56,6 +87,11 @@ public:
     */
     virtual wxSize GetAdjustedSize(int minWidth, int prefHeight, int maxHeight);
 
     */
     virtual wxSize GetAdjustedSize(int minWidth, int prefHeight, int maxHeight);
 

+    /**
+        Returns pointer to the associated parent wxComboCtrl.
+    */
+    wxComboCtrl* GetComboCtrl() const;
+

     /**
         The derived class must implement this to return pointer to the
         associated control created in Create().
     /**
         The derived class must implement this to return pointer to the
         associated control created in Create().


@@ -81,7 +117,7 @@ public:
         Useful in conjunction with LazyCreate().
     */
     bool IsCreated() const;
         Useful in conjunction with LazyCreate().
     */
     bool IsCreated() const;

-
+    

     /**
         The derived class may implement this to return @true if it wants to
         delay call to Create() until the popup is shown for the first time. It
     /**
         The derived class may implement this to return @true if it wants to
         delay call to Create() until the popup is shown for the first time. It


@@ -154,7 +190,7 @@ struct wxComboCtrlFeatures
         BitmapButton    = 0x0002, ///< Button may be replaced with bitmap.
         ButtonSpacing   = 0x0004, ///< Button can have spacing from the edge
                                   ///< of the control.
         BitmapButton    = 0x0002, ///< Button may be replaced with bitmap.
         ButtonSpacing   = 0x0004, ///< Button can have spacing from the edge
                                   ///< of the control.

-        TextIndent      = 0x0008, ///< wxComboCtrl::SetTextIndent() can be used.
+        TextIndent      = 0x0008, ///< wxComboCtrl::SetMargins() can be used.

         PaintControl    = 0x0010, ///< Combo control itself can be custom painted.
         PaintWritable   = 0x0020, ///< A variable-width area in front of writable
                                   ///< combo control's textctrl can be custom
         PaintControl    = 0x0010, ///< Combo control itself can be custom painted.
         PaintWritable   = 0x0020, ///< A variable-width area in front of writable
                                   ///< combo control's textctrl can be custom


@@ -249,13 +285,13 @@ struct wxComboCtrlFeatures
         int m_value; // current item index
 
     private:
         int m_value; // current item index
 
     private:

-        DECLARE_EVENT_TABLE()
+        wxDECLARE_EVENT_TABLE();

     };
 
     };
 

-    BEGIN_EVENT_TABLE(wxListViewComboPopup, wxListView)
+    wxBEGIN_EVENT_TABLE(wxListViewComboPopup, wxListView)

         EVT_MOTION(wxListViewComboPopup::OnMouseMove)
         EVT_LEFT_UP(wxListViewComboPopup::OnMouseClick)
         EVT_MOTION(wxListViewComboPopup::OnMouseMove)
         EVT_LEFT_UP(wxListViewComboPopup::OnMouseClick)

-    END_EVENT_TABLE()
+    wxEND_EVENT_TABLE()

     @endcode
 
     Here's how you would create and populate it in a dialog constructor:
     @endcode
 
     Here's how you would create and populate it in a dialog constructor:


@@ -280,7 +316,7 @@ struct wxComboCtrlFeatures
     @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 @c wxEVT_COMMAND_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.


@@ -295,10 +331,17 @@ struct wxComboCtrlFeatures
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TEXT(id, func)}
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TEXT(id, func)}

-           Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes.
+           Process a @c wxEVT_COMMAND_TEXT_UPDATED event, when the 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_COMMAND_TEXT_ENTER event, when RETURN is pressed in

            the combo control.
            the combo control.

+    @event{EVT_COMBOBOX_DROPDOWN(id, func)}
+           Process a @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
+           when the popup window is shown (drops down).
+    @event{EVT_COMBOBOX_CLOSEUP(id, func)}
+           Process a @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
+           when the popup window of the combo control disappears (closes up).
+           You should avoid adding or deleting items in this event.

     @endEventTable
 
     @library{wxbase}
     @endEventTable
 
     @library{wxbase}


@@ -308,7 +351,8 @@ struct wxComboCtrlFeatures
     @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup,
          wxCommandEvent
 */
     @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup,
          wxCommandEvent
 */

-class wxComboCtrl : public wxControl
+class wxComboCtrl : public wxControl,
+                    public wxTextEntry

 {
 public:
     /**
 {
 public:
     /**


@@ -327,9 +371,10 @@ public:
             Initial selection string. An empty string indicates no selection.
         @param pos
             Window position.
             Initial selection string. An empty string indicates no selection.
         @param pos
             Window position.

+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
         @param size

-            Window size. If wxDefaultSize is specified then the window is sized
-            appropriately.
+            Window size. 
+            If ::wxDefaultSize is specified then the window is sized appropriately.

         @param style
             Window style. See wxComboCtrl.
         @param validator
         @param style
             Window style. See wxComboCtrl.
         @param validator


@@ -375,6 +420,17 @@ public:
     */
     virtual void Cut();
 
     */
     virtual void Cut();
 

+    /**
+        Dismisses the popup window.
+
+        Notice that calling this function will generate a
+        @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
+
+        @since 2.9.2
+    */
+    virtual void Dismiss();
+
+

     /**
         Enables or disables popup animation, if any, depending on the value of
         the argument.
     /**
         Enables or disables popup animation, if any, depending on the value of
         the argument.


@@ -435,6 +491,15 @@ public:
     */
     static int GetFeatures();
 
     */
     static int GetFeatures();
 

+    /**
+        Returns the current hint string.
+
+        See SetHint() for more information about hints.
+
+        @since 2.9.1
+    */
+    virtual wxString GetHint() const;
+

     /**
         Returns the insertion point for the combo control's text field.
 
     /**
         Returns the insertion point for the combo control's text field.
 


@@ -448,6 +513,19 @@ public:
     */
     virtual long GetLastPosition() const;
 
     */
     virtual long GetLastPosition() const;
 

+    /**
+        Returns the margins used by the control. The @c x field of the returned
+        point is the horizontal margin and the @c y field is the vertical one.
+
+        @remarks If given margin cannot be accurately determined, its value
+                will be set to -1.
+
+        @see SetMargins()
+
+        @since 2.9.1
+    */
+    wxPoint GetMargins() const;
+

     /**
         Returns current popup interface that has been set with
         SetPopupControl().
     /**
         Returns current popup interface that has been set with
         SetPopupControl().


@@ -466,6 +544,8 @@ public:
 
     /**
         Returns actual indentation in pixels.
 
     /**
         Returns actual indentation in pixels.

+
+        @deprecated Use GetMargins() instead.

     */
     wxCoord GetTextIndent() const;
 
     */
     wxCoord GetTextIndent() const;
 


@@ -483,8 +563,14 @@ public:
 
     /**
         Dismisses the popup window.
 
     /**
         Dismisses the popup window.

+
+        @param generateEvent
+            Set this to @true in order to generate
+            @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
+
+        @deprecated Use Dismiss() instead.

     */
     */

-    virtual void HidePopup();
+    virtual void HidePopup(bool generateEvent=false);

 
     /**
         Returns @true if the popup is currently shown
 
     /**
         Returns @true if the popup is currently shown


@@ -519,6 +605,16 @@ public:
     */
     virtual void Paste();
 
     */
     virtual void Paste();
 

+    /**
+        Shows the popup portion of the combo control.
+
+        Notice that calling this function will generate a
+        @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
+
+        @since 2.9.2
+    */
+    virtual void Popup();
+

     /**
         Removes the text between the two positions in the combo control text
         field.
     /**
         Removes the text between the two positions in the combo control text
         field.


@@ -588,6 +684,18 @@ public:
     */
     void SetCustomPaintWidth(int width);
 
     */
     void SetCustomPaintWidth(int width);
 

+    /**
+        Sets a hint shown in an empty unfocused combo control.
+
+        Notice that hints are known as <em>cue banners</em> under MSW or
+        <em>placeholder strings</em> under OS X.
+
+        @see wxTextEntry::SetHint()
+
+        @since 2.9.1
+    */
+    virtual void SetHint(const wxString& hint);
+

     /**
         Sets the insertion point in the text field.
 
     /**
         Sets the insertion point in the text field.
 


@@ -601,6 +709,21 @@ public:
     */
     virtual void SetInsertionPointEnd();
 
     */
     virtual void SetInsertionPointEnd();
 

+    //@{
+    /**
+        Attempts to set the control margins. When margins are given as wxPoint,
+        x indicates the left and y the top margin. Use -1 to indicate that
+        an existing value should be used.
+
+        @return
+            @true if setting of all requested margins was successful.
+
+        @since 2.9.1
+    */
+    bool SetMargins(const wxPoint& pt);
+    bool SetMargins(wxCoord left, wxCoord top = -1);
+    //@}
+

     /**
         Set side of the control to which the popup will align itself. Valid
         values are @c wxLEFT, @c wxRIGHT and 0. The default value 0 means that
     /**
         Set side of the control to which the popup will align itself. Valid
         values are @c wxLEFT, @c wxRIGHT and 0. The default value 0 means that


@@ -666,10 +789,28 @@ public:
     */
     void SetText(const wxString& value);
 
     */
     void SetText(const wxString& value);
 

+    /**
+        Set a custom window style for the embedded wxTextCtrl. Usually you
+        will need to use this during two-step creation, just before Create().
+        For example:
+
+        @code
+            wxComboCtrl* comboCtrl = new wxComboCtrl();
+
+            // Let's make the text right-aligned
+            comboCtrl->SetTextCtrlStyle(wxTE_RIGHT);
+
+            comboCtrl->Create(parent, wxID_ANY, wxEmptyString);
+        @endcode
+    */
+    void SetTextCtrlStyle( int style );
+

     /**
         This will set the space in pixels between left edge of the control and
         the text, regardless whether control is read-only or not. Value -1 can
         be given to indicate platform default.
     /**
         This will set the space in pixels between left edge of the control and
         the text, regardless whether control is read-only or not. Value -1 can
         be given to indicate platform default.

+
+        @deprecated Use SetMargins() instead.

     */
     void SetTextIndent(int indent);
 
     */
     void SetTextIndent(int indent);
 


@@ -684,12 +825,14 @@ public:
 
     /**
         Same as SetValue(), but also sends wxCommandEvent of type
 
     /**
         Same as SetValue(), but also sends wxCommandEvent of type

-        wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.
+        @c wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.

     */
     void SetValueWithEvent(const wxString& value, bool withEvent = true);
 
     /**
         Show the popup.
     */
     void SetValueWithEvent(const wxString& value, bool withEvent = true);
 
     /**
         Show the popup.

+
+        @deprecated Use Popup() instead.

     */
     virtual void ShowPopup();
 
     */
     virtual void ShowPopup();
 


@@ -725,7 +868,7 @@ protected:
     /**
         This member function is not normally called in application code.
         Instead, it can be implemented in a derived class to return default
     /**
         This member function is not normally called in application code.
         Instead, it can be implemented in a derived class to return default

-        wxComboPopup, incase @a popup is @NULL.
+        wxComboPopup, in case @a popup is @NULL.

 
         @note If you have implemented OnButtonClick() to do something else than
               show the popup, then DoSetPopupControl() must always set @a popup
 
         @note If you have implemented OnButtonClick() to do something else than
               show the popup, then DoSetPopupControl() must always set @a popup