Use wxWebKitCtrlNameStr to adhere to the convention used by other wx classes.

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

diff --git a/include/wx/combo.h b/include/wx/combo.h
index 7d3af186566aa9ef1d90dc6b591ce571dbacd0ce..797658c901a568b83695c87afebfb032c88be185 100644 (file)
--- a/include/wx/combo.h
+++ b/include/wx/combo.h
@@ -86,8 +86,8 @@ enum
     wxCC_IFLAG_CREATED              = 0x0100,
     // Internal use: really put button outside
     wxCC_IFLAG_BUTTON_OUTSIDE       = 0x0200,
     wxCC_IFLAG_CREATED              = 0x0100,
     // Internal use: really put button outside
     wxCC_IFLAG_BUTTON_OUTSIDE       = 0x0200,

-    // Internal use: SetTextIndent has been called
-    wxCC_IFLAG_INDENT_SET           = 0x0400,
+    // Internal use: SetMargins has been succesfully called
+    wxCC_IFLAG_LEFT_MARGIN_SET      = 0x0400,

     // Internal use: Set wxTAB_TRAVERSAL to parent when popup is dismissed
     wxCC_IFLAG_PARENT_TAB_TRAVERSAL = 0x0800,
     // Internal use: Secondary popup window type should be used (if available).
     // Internal use: Set wxTAB_TRAVERSAL to parent when popup is dismissed
     wxCC_IFLAG_PARENT_TAB_TRAVERSAL = 0x0800,
     // Internal use: Secondary popup window type should be used (if available).


@@ -118,7 +118,8 @@ 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, // SetTextIndent can be used
+        TextIndent          = 0x0008, // SetMargins can be used to control
+                                      // left margin.

         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


@@ -137,7 +138,7 @@ struct wxComboCtrlFeatures
 };
 
 
 };
 
 

-class WXDLLEXPORT wxComboCtrlBase : public wxControl
+class WXDLLIMPEXP_CORE wxComboCtrlBase : public wxControl

 {
     friend class wxComboPopup;
 public:
 {
     friend class wxComboPopup;
 public:


@@ -157,7 +158,7 @@ public:
 
     // show/hide popup window
     virtual void ShowPopup();
 
     // show/hide popup window
     virtual void ShowPopup();

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

 
     // Override for totally custom combo action
     virtual void OnButtonClick();
 
     // Override for totally custom combo action
     virtual void OnButtonClick();


@@ -302,19 +303,18 @@ public:
                            const wxBitmap& bmpHover = wxNullBitmap,
                            const wxBitmap& bmpDisabled = wxNullBitmap );
 
                            const wxBitmap& bmpHover = wxNullBitmap,
                            const wxBitmap& bmpDisabled = wxNullBitmap );
 

+#if WXWIN_COMPATIBILITY_2_8

     //
     // This will set the space in pixels between left edge of the control and the
     // text, regardless whether control is read-only (ie. no wxTextCtrl) or not.
     // Platform-specific default can be set with value-1.
     // Remarks
     // * This method may do nothing on some native implementations.
     //
     // This will set the space in pixels between left edge of the control and the
     // text, regardless whether control is read-only (ie. no wxTextCtrl) or not.
     // Platform-specific default can be set with value-1.
     // Remarks
     // * This method may do nothing on some native implementations.

-    void SetTextIndent( int indent );
+    wxDEPRECATED( void SetTextIndent( int indent ) );

 
     // Returns actual indentation in pixels.
 
     // Returns actual indentation in pixels.

-    wxCoord GetTextIndent() const
-    {
-        return m_absIndent;
-    }
+    wxDEPRECATED( wxCoord GetTextIndent() const );
+#endif

 
     // Returns area covered by the text field.
     const wxRect& GetTextRect() const
 
     // Returns area covered by the text field.
     const wxRect& GetTextRect() const


@@ -385,6 +385,17 @@ public:
     const wxBitmap& GetBitmapHover() const { return m_bmpHover; }
     const wxBitmap& GetBitmapDisabled() const { return m_bmpDisabled; }
 
     const wxBitmap& GetBitmapHover() const { return m_bmpHover; }
     const wxBitmap& GetBitmapDisabled() const { return m_bmpDisabled; }
 

+    // Margins functions mirrored from TextEntryBase
+    // (wxComboCtrl does not inherit from wxTextEntry, but may embed a
+    // wxTextCtrl, so we need these). Also note that these functions
+    // have replaced SetTextIndent() in wxWidgets 2.9.1 and later.
+    bool SetMargins(const wxPoint& pt)
+        { return DoSetMargins(pt); }
+    bool SetMargins(wxCoord left, wxCoord top = -1)
+        { return DoSetMargins(wxPoint(left, top)); }
+    wxPoint GetMargins() const
+        { return DoGetMargins(); }
+

     // Return internal flags
     wxUint32 GetInternalFlags() const { return m_iFlags; }
 
     // Return internal flags
     wxUint32 GetInternalFlags() const { return m_iFlags; }
 


@@ -392,7 +403,7 @@ public:
     bool IsCreated() const { return m_iFlags & wxCC_IFLAG_CREATED ? true : false; }
 
     // common code to be called on popup hide/dismiss
     bool IsCreated() const { return m_iFlags & wxCC_IFLAG_CREATED ? true : false; }
 
     // common code to be called on popup hide/dismiss

-    void OnPopupDismiss();
+    void OnPopupDismiss(bool generateEvent);

 
     // PopupShown states
     enum
 
     // PopupShown states
     enum


@@ -423,7 +434,8 @@ protected:
     // called from wxSizeEvent handler
     virtual void OnResize() = 0;
 
     // called from wxSizeEvent handler
     virtual void OnResize() = 0;
 

-    // Return native text identation (for pure text, not textctrl)
+    // Return native text identation
+    // (i.e. text margin, for pure text, not textctrl)

     virtual wxCoord GetNativeTextIndent() const;
 
     // Called in syscolourchanged handler and base create
     virtual wxCoord GetNativeTextIndent() const;
 
     // Called in syscolourchanged handler and base create


@@ -445,7 +457,7 @@ protected:
 
     // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate.
     // Flags are defined above.
 
     // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate.
     // Flags are defined above.

-    void DrawButton( wxDC& dc, const wxRect& rect, int flags = Button_PaintBackground );
+    virtual void DrawButton( wxDC& dc, const wxRect& rect, int flags = Button_PaintBackground );

 
     // Call if cursor is on button area or mouse is captured for the button.
     //bool HandleButtonMouseEvent( wxMouseEvent& event, bool isInside );
 
     // Call if cursor is on button area or mouse is captured for the button.
     //bool HandleButtonMouseEvent( wxMouseEvent& event, bool isInside );


@@ -521,6 +533,10 @@ protected:
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif
 
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif
 

+    // margins functions
+    virtual bool DoSetMargins(const wxPoint& pt);
+    virtual wxPoint DoGetMargins() const;
+

     // This is used when m_text is hidden (readonly).
     wxString                m_valueString;
 
     // This is used when m_text is hidden (readonly).
     wxString                m_valueString;
 


@@ -572,8 +588,8 @@ protected:
     // selection indicator.
     wxCoord                 m_widthCustomPaint;
 
     // selection indicator.
     wxCoord                 m_widthCustomPaint;
 

-    // absolute text indentation, in pixels
-    wxCoord                 m_absIndent;
+    // left margin, in pixels
+    wxCoord                 m_marginLeft;

 
     // side on which the popup is aligned
     int                     m_anchorSide;
 
     // side on which the popup is aligned
     int                     m_anchorSide;


@@ -617,7 +633,7 @@ protected:
 
     // should the focus be reset to the textctrl in idle time?
     bool                    m_resetFocus;
 
     // should the focus be reset to the textctrl in idle time?
     bool                    m_resetFocus;

-    
+

 private:
     void Init();
 
 private:
     void Init();
 


@@ -644,14 +660,16 @@ enum
     wxCP_IFLAG_CREATED      = 0x0001 // Set by wxComboCtrlBase after Create is called
 };
 
     wxCP_IFLAG_CREATED      = 0x0001 // Set by wxComboCtrlBase after Create is called
 };
 

+class WXDLLIMPEXP_FWD_CORE wxComboCtrl;

 
 

-class WXDLLEXPORT wxComboPopup
+
+class WXDLLIMPEXP_CORE wxComboPopup

 {
     friend class wxComboCtrlBase;
 public:
     wxComboPopup()
     {
 {
     friend class wxComboCtrlBase;
 public:
     wxComboPopup()
     {

-        m_combo = (wxComboCtrlBase*) NULL;
+        m_combo = NULL;

         m_iFlags = 0;
     }
 
         m_iFlags = 0;
     }
 


@@ -721,6 +739,9 @@ public:
         return (m_iFlags & wxCP_IFLAG_CREATED) ? true : false;
     }
 
         return (m_iFlags & wxCP_IFLAG_CREATED) ? true : false;
     }
 

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

     // Default PaintComboControl behaviour
     static void DefaultPaintComboControl( wxComboCtrlBase* combo,
                                           wxDC& dc,
     // Default PaintComboControl behaviour
     static void DefaultPaintComboControl( wxComboCtrlBase* combo,
                                           wxDC& dc,