Remove wxDialog::OnSysColourChanged() documentation.

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

diff --git a/interface/wx/combo.h b/interface/wx/combo.h
index 38ef1f93425111630291330c3474968993ac610d..d6e219350e85bc6d10155b6471cdf0e9dd9c580b 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.


@@ -86,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


@@ -254,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:


@@ -285,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.


@@ -300,16 +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_COMBOX_DROPDOWN(id, func)}
-           Process a wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
+    @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).
            when the popup window is shown (drops down).

-    @event{EVT_COMBOX_CLOSEUP(id, func)}
-           Process a wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
+    @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).
            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}


@@ -319,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:
     /**


@@ -387,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.


@@ -447,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.
 


@@ -513,7 +566,9 @@ public:
 
         @param generateEvent
             Set this to @true in order to generate
 
         @param generateEvent
             Set this to @true in order to generate

-            wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
+            @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
+
+        @deprecated Use Dismiss() instead.

     */
     virtual void HidePopup(bool generateEvent=false);
 
     */
     virtual void HidePopup(bool generateEvent=false);
 


@@ -550,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.


@@ -619,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.
 


@@ -712,6 +789,22 @@ 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
     /**
         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


@@ -730,14 +823,10 @@ public:
     */
     virtual void SetValue(const wxString& value);
 
     */
     virtual void SetValue(const wxString& value);
 

-    /**
-        Same as SetValue(), but also sends wxCommandEvent of type
-        wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.
-    */
-    void SetValueWithEvent(const wxString& value, bool withEvent = true);
-

     /**
         Show the popup.
     /**
         Show the popup.

+
+        @deprecated Use Popup() instead.

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


@@ -773,7 +862,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