use wxSizerFlags and updated CreateButtonSizer() in all generic dialogs

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

diff --git a/include/wx/combo.h b/include/wx/combo.h
index 32437b05cdf9181a54c8e1ab8d9547021596a602..4de8d8aa3de663d00595a7c6d27814df25cb5f94 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,20 +40,17 @@
 
 #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/bitmap.h" // wxBitmap used by-value
 
 #include "wx/renderer.h" // this is needed for wxCONTROL_XXX flags
 #include "wx/bitmap.h" // wxBitmap used by-value
 

-
+class WXDLLIMPEXP_CORE wxTextCtrl;

 class WXDLLEXPORT wxComboPopup;
 
 //
 class WXDLLEXPORT wxComboPopup;
 
 //

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

 //
 enum
 {
 //
 enum
 {


@@ -61,16 +58,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.


@@ -97,12 +90,14 @@ enum
 // 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
     {


@@ -129,12 +124,12 @@ struct wxComboControlFeatures
 };
 
 
 };
 
 

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

 {
     friend class wxComboPopup;
 public:
     // ctors and such
 {
     friend class wxComboPopup;
 public:
     // ctors and such

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

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


@@ -145,7 +140,7 @@ public:
                 const wxValidator& validator,
                 const wxString& name);
 
                 const wxValidator& validator,
                 const wxString& name);
 

-    virtual ~wxComboControlBase();
+    virtual ~wxComboCtrlBase();

 
     // show/hide popup window
     virtual void ShowPopup();
 
     // show/hide popup window
     virtual void ShowPopup();


@@ -159,10 +154,17 @@ public:
 
     // 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; }


@@ -199,6 +201,10 @@ public:
     // (ie. wxComboPopup::SetStringValue doesn't get called).
     void SetText(const wxString& value);
 
     // (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)
+    void SetValueWithEvent(const wxString& value, bool withEvent = true);
+

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


@@ -248,17 +254,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.


@@ -291,11 +299,27 @@ public:
         return m_absIndent;
     }
 
         return m_absIndent;
     }
 

+    // Returns area covered by the text field.
+    const wxRect& GetTextRect() const
+    {
+        return m_tcArea;
+    }
+

     //
     // 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


@@ -303,7 +327,7 @@ 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
 
     // Returns true if focus indicator should be drawn in the control.
     bool ShouldDrawFocus() const


@@ -349,7 +373,7 @@ protected:
     void CreateTextCtrl( int extraStyle, const wxValidator& validator );
 
     // Installs standard input handler to combo (and optionally to the textctrl)
     void CreateTextCtrl( int extraStyle, const wxValidator& validator );
 
     // Installs standard input handler to combo (and optionally to the textctrl)

-    void InstallInputHandlers( bool alsoTextCtrl = true );
+    void InstallInputHandlers();

 
     // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate.
     void DrawButton( wxDC& dc, const wxRect& rect, bool paintBg = true );
 
     // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate.
     void DrawButton( wxDC& dc, const wxRect& rect, bool paintBg = true );


@@ -358,9 +382,7 @@ protected:
     //bool HandleButtonMouseEvent( wxMouseEvent& event, bool isInside );
     bool HandleButtonMouseEvent( wxMouseEvent& event, int flags );
 
     //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 );
 
     //


@@ -374,10 +396,15 @@ 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);

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

+    // 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();
 


@@ -395,8 +422,9 @@ protected:
     void OnFocusEvent(wxFocusEvent& event);
     void OnTextCtrlEvent(wxCommandEvent& event);
     void OnSysColourChanged(wxSysColourChangedEvent& event);
     void OnFocusEvent(wxFocusEvent& event);
     void OnTextCtrlEvent(wxCommandEvent& event);
     void OnSysColourChanged(wxSysColourChangedEvent& event);

+    void OnKeyEvent(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 Customize( wxUint32 flags ) { m_iFlags |= flags; }
 
     // Dispatches size event and refreshes


@@ -406,9 +434,6 @@ protected:
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif
 
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif
 

-    // Used by OnPaints of derived classes
-    wxBitmap& GetBufferBitmap(const wxSize& sz) 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;
 


@@ -425,10 +450,7 @@ 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_textEvtHandler;
 
     // this is for the top level window


@@ -437,9 +459,6 @@ protected:
     // this is for the control in popup
     wxEvtHandler*           m_popupExtraHandler;
 
     // this is for the control in popup
     wxEvtHandler*           m_popupExtraHandler;
 

-    // needed for "instant" double-click handling
-    wxLongLong              m_timeLastMouseUp;
-

     // used to prevent immediate re-popupping incase closed popup
     // by clicking on the combo control (needed because of inconsistent
     // transient implementation across platforms).
     // used to prevent immediate re-popupping incase closed popup
     // by clicking on the combo control (needed because of inconsistent
     // transient implementation across platforms).


@@ -503,38 +522,37 @@ protected:
     // is the popup window currenty shown?
     bool                    m_isPopupShown;
 
     // is the popup window currenty shown?
     bool                    m_isPopupShown;
 

-    // Set to 1 on mouse down, 0 on mouse up. Used to eliminate down-less mouse ups.
-    bool                    m_downReceived;
-

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

+    wxByte                  m_ignoreEvtText;  // Number of next EVT_TEXTs to ignore
+

     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 WXDLLEXPORT wxComboPopup
 {
 };
 
 
 class WXDLLEXPORT wxComboPopup
 {

-    friend class wxComboControlBase;
+    friend class wxComboCtrlBase;

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

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

         m_iFlags = 0;
     }
 
         m_iFlags = 0;
     }
 


@@ -570,12 +588,12 @@ public:
     // Default implementation draws value as string.
     virtual void PaintComboControl( wxDC& dc, const wxRect& rect );
 
     // Default implementation draws value as string.
     virtual void PaintComboControl( wxDC& dc, const wxRect& rect );
 

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

     // Events not handled should be skipped, as usual.
     virtual void OnComboKeyEvent( wxKeyEvent& event );
 
     // Implement if you need to support special action when user
     // Events not handled should be skipped, as usual.
     virtual void OnComboKeyEvent( wxKeyEvent& event );
 
     // 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.


@@ -605,17 +623,17 @@ public:
     }
 
     // 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;
     }


@@ -635,7 +653,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_