Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/combo.h b/include/wx/combo.h
index a1ef01b2687b52a935628eff3ec2ee00912ba67b..76bf25f53276dc221cad2efcd72ba838a7ce81ec 100644 (file)
--- a/include/wx/combo.h
+++ b/include/wx/combo.h
@@ -1,8 +1,8 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/combo.h
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/combo.h

-// Purpose:     wxComboControl declaration
+// Purpose:     wxComboCtrl declaration

 // Author:      Jaakko Salli
 // Author:      Jaakko Salli

-// Modified by: 
+// Modified by:

 // Created:     Apr-30-2006
 // RCS-ID:      $Id$
 // Copyright:   (c) Jaakko Salli
 // Created:     Apr-30-2006
 // RCS-ID:      $Id$
 // Copyright:   (c) Jaakko Salli


@@ -15,7 +15,7 @@
 
 /*
    A few words about all the classes defined in this file are probably in
 
 /*
    A few words about all the classes defined in this file are probably in

-   order: why do we need extra wxComboControl and wxComboPopup classes?
+   order: why do we need extra wxComboCtrl and wxComboPopup classes?

 
    This is because a traditional combobox is a combination of a text control
    (with a button allowing to open the pop down list) with a listbox and
 
    This is because a traditional combobox is a combination of a text control
    (with a button allowing to open the pop down list) with a listbox and


@@ -23,9 +23,9 @@
    combinations - in fact, we want to allow anything at all to be used as pop
    down list, not just a wxListBox.
 
    combinations - in fact, we want to allow anything at all to be used as pop
    down list, not just a wxListBox.
 

-   So we define a base wxComboControl which can use any control as pop down
+   So we define a base wxComboCtrl which can use any control as pop down

    list and wxComboBox deriving from it which implements the standard wxWidgets
    list and wxComboBox deriving from it which implements the standard wxWidgets

-   combobox API. wxComboControl needs to be told somehow which control to use
+   combobox API. wxComboCtrl needs to be told somehow which control to use

    and this is done by SetPopupControl(). However, we need something more than
    just a wxControl in this method as, for example, we need to call
    SetSelection("initial text value") and wxControl doesn't have such method.
    and this is done by SetPopupControl(). However, we need something more than
    just a wxControl in this method as, for example, we need to call
    SetSelection("initial text value") and wxControl doesn't have such method.


@@ -40,19 +40,18 @@
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

-#if wxUSE_COMBOCONTROL
+#if wxUSE_COMBOCTRL

 
 

-
-#include "wx/textctrl.h"
-#include "wx/button.h"
-#include "wx/combobox.h"
+#include "wx/control.h"

 #include "wx/renderer.h" // this is needed for wxCONTROL_XXX flags
 #include "wx/renderer.h" // this is needed for wxCONTROL_XXX flags

+#include "wx/bitmap.h" // wxBitmap used by-value
+#include "wx/textentry.h"

 
 

-
-class WXDLLEXPORT wxComboPopup;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
+class WXDLLIMPEXP_FWD_CORE wxComboPopup;

 
 //
 
 //

-// New window styles for wxComboControlBase
+// New window styles for wxComboCtrlBase

 //
 enum
 {
 //
 enum
 {


@@ -60,16 +59,12 @@ enum
     // In wxOwnerDrawnComboBox, for instance, it cycles item.
     wxCC_SPECIAL_DCLICK             = 0x0100,
 
     // In wxOwnerDrawnComboBox, for instance, it cycles item.
     wxCC_SPECIAL_DCLICK             = 0x0100,
 

-    // Use keyboard behaviour alternate to platform default:
-    // Up an down keys will show popup instead of cycling value.
-    wxCC_ALT_KEYS                   = 0x0200,
-

     // Dropbutton acts like standard push button.
     // Dropbutton acts like standard push button.

-    wxCC_STD_BUTTON                 = 0x0400
+    wxCC_STD_BUTTON                 = 0x0200

 };
 
 
 };
 
 

-// wxComboControl internal flags
+// wxComboCtrl internal flags

 enum
 {
     // First those that can be passed to Customize.
 enum
 {
     // First those that can be passed to Customize.


@@ -81,27 +76,43 @@ enum
     wxCC_POPUP_ON_MOUSE_UP          = 0x0002,
     // All text is not automatically selected on click
     wxCC_NO_TEXT_AUTO_SELECT        = 0x0004,
     wxCC_POPUP_ON_MOUSE_UP          = 0x0002,
     // All text is not automatically selected on click
     wxCC_NO_TEXT_AUTO_SELECT        = 0x0004,

+    // Drop-button stays down as long as popup is displayed.
+    wxCC_BUTTON_STAYS_DOWN          = 0x0008,
+    // Drop-button covers the entire control.
+    wxCC_FULL_BUTTON                = 0x0010,
+    // Drop-button goes over the custom-border (used under WinVista).
+    wxCC_BUTTON_COVERS_BORDER       = 0x0020,

 
     // Internal use: signals creation is complete
     wxCC_IFLAG_CREATED              = 0x0100,
     // Internal use: really put button outside
     wxCC_IFLAG_BUTTON_OUTSIDE       = 0x0200,
 
     // Internal use: signals creation is complete
     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 successfully called
+    wxCC_IFLAG_LEFT_MARGIN_SET      = 0x0400,

     // Internal use: Set wxTAB_TRAVERSAL to parent when popup is dismissed
     // Internal use: Set wxTAB_TRAVERSAL to parent when popup is dismissed

-    wxCC_IFLAG_PARENT_TAB_TRAVERSAL = 0x0800
+    wxCC_IFLAG_PARENT_TAB_TRAVERSAL = 0x0800,
+    // Internal use: Secondary popup window type should be used (if available).
+    wxCC_IFLAG_USE_ALT_POPUP        = 0x1000,
+    // Internal use: Skip popup animation.
+    wxCC_IFLAG_DISABLE_POPUP_ANIM   = 0x2000,
+    // Internal use: Drop-button is a bitmap button or has non-default size
+    // (but can still be on either side of the control), regardless whether
+    // specified by the platform or the application.
+    wxCC_IFLAG_HAS_NONSTANDARD_BUTTON   = 0x4000

 };
 
 
 // Flags used by PreprocessMouseEvent and HandleButtonMouseEvent
 enum
 {
 };
 
 
 // Flags used by PreprocessMouseEvent and HandleButtonMouseEvent
 enum
 {

-    wxCC_MF_ON_BUTTON               =   0x0001 // cursor is on dropbutton area
+    wxCC_MF_ON_BUTTON               =   0x0001, // cursor is on dropbutton area
+    wxCC_MF_ON_CLICK_AREA           =   0x0002  // cursor is on dropbutton or other area
+                                                // that can be clicked to show the popup.

 };
 
 
 };
 
 

-// Namespace for wxComboControl feature flags
-struct wxComboControlFeatures
+// Namespace for wxComboCtrl feature flags
+struct wxComboCtrlFeatures

 {
     enum
     {
 {
     enum
     {


@@ -109,7 +120,8 @@ struct wxComboControlFeatures
         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


@@ -128,12 +140,14 @@ struct wxComboControlFeatures
 };
 
 
 };
 
 

-class WXDLLEXPORT wxComboControlBase : public wxControl
+class WXDLLIMPEXP_CORE wxComboCtrlBase : public wxControl,
+                                         public wxTextEntry

 {
     friend class wxComboPopup;
 {
     friend class wxComboPopup;

+    friend class wxComboPopupEvtHandler;

 public:
     // ctors and such
 public:
     // ctors and such

-    wxComboControlBase() : wxControl() { Init(); }
+    wxComboCtrlBase() : wxControl(), wxTextEntry() { Init(); }

 
     bool Create(wxWindow *parent,
                 wxWindowID id,
 
     bool Create(wxWindow *parent,
                 wxWindowID id,


@@ -144,24 +158,41 @@ public:
                 const wxValidator& validator,
                 const wxString& name);
 
                 const wxValidator& validator,
                 const wxString& name);
 

-    virtual ~wxComboControlBase();
+    virtual ~wxComboCtrlBase();
+
+    // Show/hide popup window (wxComboBox-compatible methods)
+    virtual void Popup();
+    virtual void Dismiss()
+    {
+        HidePopup(true);
+    }

 
 

-    // show/hide popup window
+    // Show/hide popup window.
+    // TODO: Maybe deprecate in favor of Popup()/Dismiss().
+    //       However, these functions are still called internally
+    //       so it is not straightforward.

     virtual void ShowPopup();
     virtual void ShowPopup();

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

 
     // Override for totally custom combo action
     virtual void OnButtonClick();
 
     // return true if the popup is currently shown
 
     // Override for totally custom combo action
     virtual void OnButtonClick();
 
     // return true if the popup is currently shown

-    bool IsPopupShown() const { return m_isPopupShown; }
+    bool IsPopupShown() const { return m_popupWinState == Visible; }

 
     // set interface class instance derived from wxComboPopup
     // NULL popup can be used to indicate default in a derived class
 
     // set interface class instance derived from wxComboPopup
     // NULL popup can be used to indicate default in a derived class

-    virtual void SetPopupControl( wxComboPopup* popup );
+    void SetPopupControl( wxComboPopup* popup )
+    {
+        DoSetPopupControl(popup);
+    }

 
     // get interface class instance derived from wxComboPopup
 
     // get interface class instance derived from wxComboPopup

-    wxComboPopup* GetPopupControl() const { return m_popupInterface; }
+    wxComboPopup* GetPopupControl()
+    {
+        EnsurePopupControl();
+        return m_popupInterface;
+    }

 
     // get the popup window containing the popup control
     wxWindow *GetPopupWindow() const { return m_winPopup; }
 
     // get the popup window containing the popup control
     wxWindow *GetPopupWindow() const { return m_winPopup; }


@@ -177,30 +208,71 @@ public:
     virtual bool Enable(bool enable = true);
     virtual bool Show(bool show = true);
     virtual bool SetFont(const wxFont& font);
     virtual bool Enable(bool enable = true);
     virtual bool Show(bool show = true);
     virtual bool SetFont(const wxFont& font);

-#if wxUSE_TOOLTIPS
-    virtual void DoSetToolTip( wxToolTip *tip );
-#endif

 
 

-    // wxTextCtrl methods - for readonly combo they should return
-    // without errors.
-    virtual wxString GetValue() const;
-    virtual void SetValue(const wxString& value);
+    //
+    // wxTextEntry methods
+    //
+    // NB: We basically need to override all of them because there is
+    //     no guarantee how platform-specific wxTextEntry is implemented.
+    //
+    virtual void SetValue(const wxString& value)
+        { wxTextEntryBase::SetValue(value); }
+    virtual void ChangeValue(const wxString& value)
+        { wxTextEntryBase::ChangeValue(value); }
+
+    virtual void WriteText(const wxString& text);
+    virtual void AppendText(const wxString& text)
+        { wxTextEntryBase::AppendText(text); }
+
+    virtual wxString GetValue() const
+        { return wxTextEntryBase::GetValue(); }
+
+    virtual wxString GetRange(long from, long to) const
+        { return wxTextEntryBase::GetRange(from, to); }
+
+    // Replace() and DoSetValue() need to be fully re-implemented since
+    // EventSuppressor utility class does not work with the way
+    // wxComboCtrl is implemented.
+    virtual void Replace(long from, long to, const wxString& value);
+
+    virtual void Remove(long from, long to);
+

     virtual void Copy();
     virtual void Cut();
     virtual void Paste();
     virtual void Copy();
     virtual void Cut();
     virtual void Paste();

+
+    virtual void Undo();
+    virtual void Redo();
+    virtual bool CanUndo() const;
+    virtual bool CanRedo() const;
+

     virtual void SetInsertionPoint(long pos);
     virtual void SetInsertionPoint(long pos);

-    virtual void SetInsertionPointEnd();

     virtual long GetInsertionPoint() const;
     virtual long GetLastPosition() const;
     virtual long GetInsertionPoint() const;
     virtual long GetLastPosition() const;

-    virtual void Replace(long from, long to, const wxString& value);
-    virtual void Remove(long from, long to);
+

     virtual void SetSelection(long from, long to);
     virtual void SetSelection(long from, long to);

-    virtual void Undo();
+    virtual void GetSelection(long *from, long *to) const;
+
+    virtual bool IsEditable() const;
+    virtual void SetEditable(bool editable);
+
+    virtual bool SetHint(const wxString& hint);
+    virtual wxString GetHint() const;

 
     // This method sets the text without affecting list selection
     // (ie. wxComboPopup::SetStringValue doesn't get called).
     void SetText(const wxString& value);
 
 
     // This method sets the text without affecting list selection
     // (ie. wxComboPopup::SetStringValue doesn't get called).
     void SetText(const wxString& value);
 

+    // This method sets value and also optionally sends EVT_TEXT
+    // (needed by combo popups)
+    wxDEPRECATED( void SetValueWithEvent(const wxString& value,
+                                         bool withEvent = true) );
+
+    // Changes value of the control as if user had done it by selecting an
+    // item from a combo box drop-down list. Needs to be public so that
+    // derived popup classes can call it.
+    void SetValueByUser(const wxString& value);
+

     //
     // Popup customization methods
     //
     //
     // Popup customization methods
     //


@@ -250,17 +322,19 @@ public:
     }
 
     // Set position of dropdown button.
     }
 
     // Set position of dropdown button.

-    //   width: 0 > for specific custom width, negative to adjust to smaller than default
-    //   height: 0 > for specific custom height, negative to adjust to smaller than default
+    //   width: button width. <= 0 for default.
+    //   height: button height. <= 0 for default.

     //   side: wxLEFT or wxRIGHT, indicates on which side the button will be placed.
     //   spacingX: empty space on sides of the button. Default is 0.
     // Remarks:
     //   There is no spacingY - the button will be centered vertically.
     //   side: wxLEFT or wxRIGHT, indicates on which side the button will be placed.
     //   spacingX: empty space on sides of the button. Default is 0.
     // Remarks:
     //   There is no spacingY - the button will be centered vertically.

-    void SetButtonPosition( int width = 0,
-                            int height = 0,
+    void SetButtonPosition( int width = -1,
+                            int height = -1,

                             int side = wxRIGHT,
                             int spacingX = 0 );
 
                             int side = wxRIGHT,
                             int spacingX = 0 );
 

+    // Returns current size of the dropdown button.
+    wxSize GetButtonSize();

 
     //
     // Sets dropbutton to be drawn with custom bitmaps.
 
     //
     // Sets dropbutton to be drawn with custom bitmaps.


@@ -279,25 +353,64 @@ 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
+    wxDEPRECATED( wxCoord GetTextIndent() const );
+#endif
+
+    // Returns area covered by the text field.
+    const wxRect& GetTextRect() const
+    {
+        return m_tcArea;
+    }
+
+    // Call with enable as true to use a type of popup window that guarantees ability
+    // to focus the popup control, and normal function of common native controls.
+    // This alternative popup window is usually a wxDialog, and as such it's parent
+    // frame will appear as if the focus has been lost from it.
+    void UseAltPopupWindow( bool enable = true )

     {
     {

-        return m_absIndent;
+        wxASSERT_MSG( !m_winPopup,
+                      wxT("call this only before SetPopupControl") );
+
+        if ( enable )
+            m_iFlags |= wxCC_IFLAG_USE_ALT_POPUP;
+        else
+            m_iFlags &= ~wxCC_IFLAG_USE_ALT_POPUP;
+    }
+
+    // Call with false to disable popup animation, if any.
+    void EnablePopupAnimation( bool enable = true )
+    {
+        if ( enable )
+            m_iFlags &= ~wxCC_IFLAG_DISABLE_POPUP_ANIM;
+        else
+            m_iFlags |= wxCC_IFLAG_DISABLE_POPUP_ANIM;

     }
 
     //
     // Utilies needed by the popups or native implementations
     //
 
     }
 
     //
     // Utilies needed by the popups or native implementations
     //
 

-    // Draws focus background (on combo control) in a way typical on platform.
+    // Returns true if given key combination should toggle the popup.
+    // NB: This is a separate from other keyboard handling because:
+    //     1) Replaceability.
+    //     2) Centralized code (otherwise it'd be split up between
+    //        wxComboCtrl key handler and wxVListBoxComboPopup's
+    //        key handler).
+    virtual bool IsKeyPopupToggle(const wxKeyEvent& event) const = 0;
+
+    // Prepare background of combo control or an item in a dropdown list
+    // in a way typical on platform. This includes painting the focus/disabled
+    // background and setting the clipping region.

     // Unless you plan to paint your own focus indicator, you should always call this
     // in your wxComboPopup::PaintComboControl implementation.
     // In addition, it sets pen and text colour to what looks good and proper
     // Unless you plan to paint your own focus indicator, you should always call this
     // in your wxComboPopup::PaintComboControl implementation.
     // In addition, it sets pen and text colour to what looks good and proper


@@ -305,14 +418,14 @@ public:
     // flags: wxRendererNative flags: wxCONTROL_ISSUBMENU: is drawing a list item instead of combo control
     //                                wxCONTROL_SELECTED: list item is selected
     //                                wxCONTROL_DISABLED: control/item is disabled
     // flags: wxRendererNative flags: wxCONTROL_ISSUBMENU: is drawing a list item instead of combo control
     //                                wxCONTROL_SELECTED: list item is selected
     //                                wxCONTROL_DISABLED: control/item is disabled

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

 
     // Returns true if focus indicator should be drawn in the control.
     bool ShouldDrawFocus() const
     {
         const wxWindow* curFocus = FindFocus();
 
     // Returns true if focus indicator should be drawn in the control.
     bool ShouldDrawFocus() const
     {
         const wxWindow* curFocus = FindFocus();

-        return ( !m_isPopupShown &&
-                 (curFocus == this || (m_btn && curFocus == m_btn)) &&
+        return ( IsPopupWindowState(Hidden) &&
+                 (curFocus == m_mainCtrlWnd || (m_btn && curFocus == m_btn)) &&

                  (m_windowStyle & wxCB_READONLY) );
     }
 
                  (m_windowStyle & wxCB_READONLY) );
     }
 


@@ -322,17 +435,54 @@ 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; }
 

+    // Set custom style flags for embedded wxTextCtrl. Usually must be used
+    // with two-step creation, before Create() call.
+    void SetTextCtrlStyle( int style );
+

     // Return internal flags
     wxUint32 GetInternalFlags() const { return m_iFlags; }
 
     // Return true if Create has finished
     bool IsCreated() const { return m_iFlags & wxCC_IFLAG_CREATED ? true : false; }
 
     // Return internal flags
     wxUint32 GetInternalFlags() const { return m_iFlags; }
 
     // Return true if Create has finished
     bool IsCreated() const { return m_iFlags & wxCC_IFLAG_CREATED ? true : false; }
 

+    // Need to override to return text area background colour
+    wxColour GetBackgroundColour() const;
+

     // common code to be called on popup hide/dismiss
     // common code to be called on popup hide/dismiss

-    void OnPopupDismiss();
+    void OnPopupDismiss(bool generateEvent);
+
+    // PopupShown states
+    enum
+    {
+        Hidden       = 0,
+        //Closing      = 1,
+        Animating    = 2,
+        Visible      = 3
+    };
+
+    bool IsPopupWindowState( int state ) const { return (state == m_popupWinState) ? true : false; }
+
+    wxByte GetPopupWindowState() const { return m_popupWinState; }
+
+    // Set value returned by GetMainWindowOfCompositeControl
+    void SetCtrlMainWnd( wxWindow* wnd ) { m_mainCtrlWnd = wnd; }
+
+    // This is public so we can access it from wxComboCtrlTextCtrl
+    virtual wxWindow *GetMainWindowOfCompositeControl()
+        { return m_mainCtrlWnd; }

 
 protected:
 
 
 protected:
 

+    // Returns true if hint text should be drawn in the control
+    bool ShouldUseHintText(int flags = 0) const
+    {
+        return ( !m_text &&
+                 !(flags & wxCONTROL_ISSUBMENU) &&
+                 !m_valueString.length() &&
+                 m_hintText.length() &&
+                 !ShouldDrawFocus() );
+    }
+

     //
     // Override these for customization purposes
     //
     //
     // Override these for customization purposes
     //


@@ -340,7 +490,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


@@ -348,21 +499,31 @@ protected:
 
     // Creates wxTextCtrl.
     //   extraStyle: Extra style parameters
 
     // Creates wxTextCtrl.
     //   extraStyle: Extra style parameters

-    void CreateTextCtrl( int extraStyle, const wxValidator& validator );
+    void CreateTextCtrl( int extraStyle );
+
+    // Called when text was changed programmatically
+    // (e.g. from WriteText())
+    void OnSetValue(const wxString& value);

 
     // Installs standard input handler to combo (and optionally to the textctrl)
 
     // Installs standard input handler to combo (and optionally to the textctrl)

-    void InstallInputHandlers( bool alsoTextCtrl = true );
+    void InstallInputHandlers();
+
+    // Flags for DrawButton
+    enum
+    {
+        Button_PaintBackground             = 0x0001, // Paints control background below the button
+        Button_BitmapOnly                  = 0x0002  // Only paints the bitmap
+    };

 
     // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate.
 
     // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate.

-    void DrawButton( wxDC& dc, const wxRect& rect, bool paintBg = true );
+    // Flags are defined above.
+    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 );
     bool HandleButtonMouseEvent( wxMouseEvent& event, int flags );
 
 
     // Call if cursor is on button area or mouse is captured for the button.
     //bool HandleButtonMouseEvent( wxMouseEvent& event, bool isInside );
     bool HandleButtonMouseEvent( wxMouseEvent& event, int flags );
 

-    // Conversion to double-clicks and some basic filtering

     // returns true if event was consumed or filtered (event type is also set to 0 in this case)
     // returns true if event was consumed or filtered (event type is also set to 0 in this case)

-    //bool PreprocessMouseEvent( wxMouseEvent& event, bool isOnButtonArea );

     bool PreprocessMouseEvent( wxMouseEvent& event, int flags );
 
     //
     bool PreprocessMouseEvent( wxMouseEvent& event, int flags );
 
     //


@@ -376,9 +537,21 @@ protected:
     // Creates popup window, calls interface->Create(), etc
     void CreatePopup();
 
     // Creates popup window, calls interface->Create(), etc
     void CreatePopup();
 

+    // Destroy popup window and all related constructs
+    void DestroyPopup();
+

     // override the base class virtuals involved in geometry calculations
     // override the base class virtuals involved in geometry calculations

-    virtual void DoMoveWindow(int x, int y, int width, int height);
+    // The common version only sets a default width, so the derived classes
+    // should override it and set the height and change the width as needed.

     virtual wxSize DoGetBestSize() const;
     virtual wxSize DoGetBestSize() const;

+    virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
+
+    // also set the embedded wxTextCtrl colours
+    virtual bool SetForegroundColour(const wxColour& colour);
+    virtual bool SetBackgroundColour(const wxColour& colour);
+
+    // NULL popup can be used to indicate default in a derived class
+    virtual void DoSetPopupControl(wxComboPopup* popup);

 
     // ensures there is atleast the default popup
     void EnsurePopupControl();
 
     // ensures there is atleast the default popup
     void EnsurePopupControl();


@@ -390,26 +563,60 @@ protected:
 
     // Standard textctrl positioning routine. Just give it platform-dependant
     // textctrl coordinate adjustment.
 
     // Standard textctrl positioning routine. Just give it platform-dependant
     // textctrl coordinate adjustment.

-    void PositionTextCtrl( int textCtrlXAdjust, int textCtrlYAdjust );
+    virtual void PositionTextCtrl( int textCtrlXAdjust = 0,
+                                   int textCtrlYAdjust = 0);

 
     // event handlers
     void OnSizeEvent( wxSizeEvent& event );
     void OnFocusEvent(wxFocusEvent& event);
 
     // event handlers
     void OnSizeEvent( wxSizeEvent& event );
     void OnFocusEvent(wxFocusEvent& event);

+    void OnIdleEvent(wxIdleEvent& event);

     void OnTextCtrlEvent(wxCommandEvent& event);
     void OnSysColourChanged(wxSysColourChangedEvent& event);
     void OnTextCtrlEvent(wxCommandEvent& event);
     void OnSysColourChanged(wxSysColourChangedEvent& event);

+    void OnKeyEvent(wxKeyEvent& event);
+    void OnCharEvent(wxKeyEvent& event);

 
 

-    // Set customization flags (directs how wxComboControlBase helpers behave)
+    // Set customization flags (directs how wxComboCtrlBase helpers behave)

     void Customize( wxUint32 flags ) { m_iFlags |= flags; }
 
     // Dispatches size event and refreshes
     void RecalcAndRefresh();
 
     void Customize( wxUint32 flags ) { m_iFlags |= flags; }
 
     // Dispatches size event and refreshes
     void RecalcAndRefresh();
 

-    // Used by OnPaints of derived classes
-    wxBitmap& GetBufferBitmap(const wxSize& sz) const;
+    // Flags for DoShowPopup and AnimateShow
+    enum
+    {
+        ShowBelow       = 0x0000,  // Showing popup below the control
+        ShowAbove       = 0x0001,  // Showing popup above the control
+        CanDeferShow    = 0x0002  // Can only return true from AnimateShow if this is set
+    };
+
+    // Shows and positions the popup.
+    virtual void DoShowPopup( const wxRect& rect, int flags );
+
+    // Implement in derived class to create a drop-down animation.
+    // Return true if finished immediately. Otherwise popup is only
+    // shown when the derived class call DoShowPopup.
+    // Flags are same as for DoShowPopup.
+    virtual bool AnimateShow( const wxRect& rect, int flags );
+
+#if wxUSE_TOOLTIPS
+    virtual void DoSetToolTip( wxToolTip *tip );
+#endif
+
+    // protected wxTextEntry methods
+    virtual void DoSetValue(const wxString& value, int flags);
+    virtual wxString DoGetValue() const;
+    virtual wxWindow *GetEditableWindow() { return this; }
+
+    // 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;
 

+    // This is used when control is unfocused and m_valueString is empty
+    wxString                m_hintText;
+

     // the text control and button we show all the time
     wxTextCtrl*             m_text;
     wxWindow*               m_btn;
     // the text control and button we show all the time
     wxTextCtrl*             m_text;
     wxWindow*               m_btn;


@@ -423,22 +630,22 @@ protected:
     // popup interface
     wxComboPopup*           m_popupInterface;
 
     // popup interface
     wxComboPopup*           m_popupInterface;
 

-    // this is for this control itself
-    wxEvtHandler*           m_extraEvtHandler;
-
-    // this is for text
+    // this is input etc. handler for the text control

     wxEvtHandler*           m_textEvtHandler;
 
     // this is for the top level window
     wxEvtHandler*           m_toplevEvtHandler;
 
     // this is for the control in popup
     wxEvtHandler*           m_textEvtHandler;
 
     // this is for the top level window
     wxEvtHandler*           m_toplevEvtHandler;
 
     // this is for the control in popup

-    wxEvtHandler*           m_popupExtraHandler;
+    wxEvtHandler*           m_popupEvtHandler;
+
+    // this is for the popup window
+    wxEvtHandler*           m_popupWinEvtHandler;

 
 

-    // needed for "instant" double-click handling
-    wxLongLong              m_timeLastMouseUp;
+    // main (ie. topmost) window of a composite control (default = this)
+    wxWindow*               m_mainCtrlWnd;

 
 

-    // used to prevent immediate re-popupping incase closed popup
+    // used to prevent immediate re-popupping in case closed popup

     // by clicking on the combo control (needed because of inconsistent
     // transient implementation across platforms).
     wxLongLong              m_timeCanAcceptClick;
     // by clicking on the combo control (needed because of inconsistent
     // transient implementation across platforms).
     wxLongLong              m_timeCanAcceptClick;


@@ -458,8 +665,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;


@@ -471,6 +678,9 @@ protected:
     wxRect                  m_tcArea;
     wxRect                  m_btnArea;
 
     wxRect                  m_tcArea;
     wxRect                  m_btnArea;
 

+    // Colour of the text area, in case m_text is NULL
+    wxColour                m_tcBgCol;
+

     // current button state (uses renderer flags)
     int                     m_btnState;
 
     // current button state (uses renderer flags)
     int                     m_btnState;
 


@@ -495,44 +705,57 @@ protected:
     // platform-dependant customization and other flags
     wxUint32                m_iFlags;
 
     // platform-dependant customization and other flags
     wxUint32                m_iFlags;
 

+    // custom style for m_text
+    int                     m_textCtrlStyle;
+

     // draw blank button background under bitmap?
     bool                    m_blankButtonBg;
 
     // is the popup window currenty shown?
     // draw blank button background under bitmap?
     bool                    m_blankButtonBg;
 
     // is the popup window currenty shown?

-    bool                    m_isPopupShown;
+    wxByte                  m_popupWinState;
+
+    // should the focus be reset to the textctrl in idle time?
+    bool                    m_resetFocus;

 
 

-    // Set to 1 on mouse down, 0 on mouse up. Used to eliminate down-less mouse ups.
-    bool                    m_downReceived;
+    // is the text-area background colour overridden?
+    bool                    m_hasTcBgCol;

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

+    wxByte                  m_ignoreEvtText;  // Number of next EVT_TEXTs to ignore
+
+    // Is popup window wxPopupTransientWindow, wxPopupWindow or wxDialog?
+    wxByte                  m_popupWinType;
+

     DECLARE_EVENT_TABLE()
 
     DECLARE_EVENT_TABLE()
 

-    DECLARE_ABSTRACT_CLASS(wxComboControlBase)
+    DECLARE_ABSTRACT_CLASS(wxComboCtrlBase)

 };
 
 
 // ----------------------------------------------------------------------------
 // wxComboPopup is the interface which must be implemented by a control to be
 };
 
 
 // ----------------------------------------------------------------------------
 // wxComboPopup is the interface which must be implemented by a control to be

-// used as a popup by wxComboControl
+// used as a popup by wxComboCtrl

 // ----------------------------------------------------------------------------
 
 
 // wxComboPopup internal flags
 enum
 {
 // ----------------------------------------------------------------------------
 
 
 // wxComboPopup internal flags
 enum
 {

-    wxCP_IFLAG_CREATED      = 0x0001 // Set by wxComboControlBase 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 wxComboControlBase;
+    friend class wxComboCtrlBase;

 public:
     wxComboPopup()
     {
 public:
     wxComboPopup()
     {

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

         m_iFlags = 0;
     }
 
         m_iFlags = 0;
     }
 


@@ -540,7 +763,7 @@ public:
     // variable has been initialized before the call.
     // NOTE: It is not in constructor so the derived class doesn't need to redefine
     //       a default constructor of its own.
     // variable has been initialized before the call.
     // NOTE: It is not in constructor so the derived class doesn't need to redefine
     //       a default constructor of its own.

-    virtual void Init() { };
+    virtual void Init() { }

 
     virtual ~wxComboPopup();
 
 
     virtual ~wxComboPopup();
 


@@ -548,6 +771,13 @@ public:
     // Return true for success.
     virtual bool Create(wxWindow* parent) = 0;
 
     // Return true for success.
     virtual bool Create(wxWindow* parent) = 0;
 

+    // Calls Destroy() for the popup control (i.e. one returned by
+    // GetControl()) and makes sure that 'this' is deleted at the end.
+    // Default implementation works for both cases where popup control
+    // class is multiple inherited or created on heap as a separate
+    // object.
+    virtual void DestroyPopup();
+

     // We must have an associated control which is subclassed by the combobox.
     virtual wxWindow *GetControl() = 0;
 
     // We must have an associated control which is subclassed by the combobox.
     virtual wxWindow *GetControl() = 0;
 


@@ -564,16 +794,27 @@ public:
     // Gets displayed string representation of the value.
     virtual wxString GetStringValue() const = 0;
 
     // Gets displayed string representation of the value.
     virtual wxString GetStringValue() const = 0;
 

+    // Called to check if the popup - when an item container - actually
+    // has matching item. Case-sensitivity checking etc. is up to the
+    // implementation. If the found item matched the string, but is
+    // different, it should be written back to pItem. Default implementation
+    // always return true and does not alter trueItem.
+    virtual bool FindItem(const wxString& item, wxString* trueItem=NULL);
+

     // This is called to custom paint in the combo control itself (ie. not the popup).
     // Default implementation draws value as string.
     virtual void PaintComboControl( wxDC& dc, const wxRect& rect );
 
     // This is called to custom paint in the combo control itself (ie. not the popup).
     // Default implementation draws value as string.
     virtual void PaintComboControl( wxDC& dc, const wxRect& rect );
 

-    // Receives key events from the parent wxComboControl.
+    // Receives wxEVT_KEY_DOWN key events from the parent wxComboCtrl.

     // Events not handled should be skipped, as usual.
     virtual void OnComboKeyEvent( wxKeyEvent& event );
 
     // Events not handled should be skipped, as usual.
     virtual void OnComboKeyEvent( wxKeyEvent& event );
 

+    // Receives wxEVT_CHAR key events from the parent wxComboCtrl.
+    // Events not handled should be skipped, as usual.
+    virtual void OnComboCharEvent( wxKeyEvent& event );
+

     // Implement if you need to support special action when user
     // Implement if you need to support special action when user

-    // double-clicks on the parent wxComboControl.
+    // double-clicks on the parent wxComboCtrl.

     virtual void OnComboDoubleClick();
 
     // Return final size of popup. Called on every popup, just prior to OnShow.
     virtual void OnComboDoubleClick();
 
     // Return final size of popup. Called on every popup, just prior to OnShow.


@@ -602,18 +843,21 @@ 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
     // Default PaintComboControl behaviour

-    static void DefaultPaintComboControl( wxComboControlBase* combo,
+    static void DefaultPaintComboControl( wxComboCtrlBase* combo,

                                           wxDC& dc,
                                           const wxRect& rect );
 
 protected:
                                           wxDC& dc,
                                           const wxRect& rect );
 
 protected:

-    wxComboControlBase* m_combo;
+    wxComboCtrlBase* m_combo;

     wxUint32            m_iFlags;
 
 private:
     wxUint32            m_iFlags;
 
 private:

-    // Called in wxComboControlBase::SetPopupControl
-    void InitBase(wxComboControlBase *combo)
+    // Called in wxComboCtrlBase::SetPopupControl
+    void InitBase(wxComboCtrlBase *combo)

     {
         m_combo = combo;
     }
     {
         m_combo = combo;
     }


@@ -633,7 +877,7 @@ private:
 // Any ports may need generic as an alternative
 #include "wx/generic/combo.h"
 
 // Any ports may need generic as an alternative
 #include "wx/generic/combo.h"
 

-#endif // wxUSE_COMBOCONTROL
+#endif // wxUSE_COMBOCTRL

 
 #endif
     // _WX_COMBOCONTROL_H_BASE_
 
 #endif
     // _WX_COMBOCONTROL_H_BASE_