added zlib directly to dynamic targets

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

diff --git a/interface/wx/combo.h b/interface/wx/combo.h
index 4cfafc2598181d88d9d2e40ebcf0feee5eee4c7b..4a67cd784da88ce310e0ed5e6a286aa9c5b156c1 100644 (file)
--- a/interface/wx/combo.h
+++ b/interface/wx/combo.h
@@ -56,6 +56,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().


@@ -154,7 +159,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


@@ -299,6 +304,13 @@ struct wxComboCtrlFeatures
     @event{EVT_TEXT_ENTER(id, func)}
            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
            the combo control.
     @event{EVT_TEXT_ENTER(id, func)}
            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
            the combo control.

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


@@ -327,9 +339,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


@@ -435,6 +448,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 +470,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 +501,8 @@ public:
 
     /**
         Returns actual indentation in pixels.
 
     /**
         Returns actual indentation in pixels.

+
+        @deprecated Use GetMargins() instead.

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


@@ -483,8 +520,12 @@ public:
 
     /**
         Dismisses the popup window.
 
     /**
         Dismisses the popup window.

+
+        @param generateEvent
+            Set this to @true in order to generate
+            wxEVT_COMMAND_COMBOBOX_CLOSEUP event.

     */
     */

-    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


@@ -588,6 +629,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 +654,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


@@ -670,6 +738,8 @@ public:
         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);