Override CreateItem so wxListBox can turn its notifications into events.

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

diff --git a/include/wx/odcombo.h b/include/wx/odcombo.h
index b5f65833d3bfa6064fcb206e1c16b0d6674a6e70..d5baadcc368bc403deaff8dba0a10f372fb2f9c8 100644 (file)
--- a/include/wx/odcombo.h
+++ b/include/wx/odcombo.h
@@ -14,11 +14,12 @@
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

-#if wxUSE_OWNERDRAWNCOMBOBOX
+#if wxUSE_ODCOMBOBOX

 
 #include "wx/combo.h"
 #include "wx/ctrlsub.h"
 #include "wx/vlbox.h"
 
 #include "wx/combo.h"
 #include "wx/ctrlsub.h"
 #include "wx/vlbox.h"

+#include "wx/timer.h"

 
 
 //
 
 
 //


@@ -37,13 +38,20 @@ enum
 
 
 //
 
 
 //

-// Callback flags
+// Callback flags (see wxOwnerDrawnComboBox::OnDrawItem)

 //
 enum
 {
     // when set, we are painting the selected item in control,
     // not in the popup
 //
 enum
 {
     // when set, we are painting the selected item in control,
     // not in the popup

-    wxCP_PAINTING_CONTROL           = 0x0001
+    wxODCB_PAINTING_CONTROL         = 0x0001,
+
+
+    // when set, we are painting an item which should have
+    // focus rectangle painted in the background. Text colour
+    // and clipping region are then appropriately set in
+    // the default OnDrawBackground implementation.
+    wxODCB_PAINTING_SELECTED        = 0x0002

 };
 
 
 };
 
 


@@ -52,14 +60,15 @@ enum
 //
 // Notes:
 //   wxOwnerDrawnComboBox uses this as its popup. However, it always derives
 //
 // Notes:
 //   wxOwnerDrawnComboBox uses this as its popup. However, it always derives

-//   from native wxComboControl. If you need to use this popup with
+//   from native wxComboCtrl. If you need to use this popup with

 //   wxGenericComboControl, then remember that vast majority of item manipulation
 //   functionality is implemented in the wxVListBoxComboPopup class itself.
 //
 // ----------------------------------------------------------------------------
 
 
 //   wxGenericComboControl, then remember that vast majority of item manipulation
 //   functionality is implemented in the wxVListBoxComboPopup class itself.
 //
 // ----------------------------------------------------------------------------
 
 

-class WXDLLEXPORT wxVListBoxComboPopup : public wxVListBox, public wxComboPopup
+class WXDLLIMPEXP_ADV wxVListBoxComboPopup : public wxVListBox,
+                                             public wxComboPopup

 {
     friend class wxOwnerDrawnComboBox;
 public:
 {
     friend class wxOwnerDrawnComboBox;
 public:


@@ -83,20 +92,6 @@ public:
     virtual void OnComboDoubleClick();
     virtual bool LazyCreate();
 
     virtual void OnComboDoubleClick();
     virtual bool LazyCreate();
 

-    // Callbacks for drawing and measuring items. Override in a derived class for
-    // owner-drawnness.
-    // item: item index to be drawn, may be wxNOT_FOUND when painting combo control itself
-    //       and there is no valid selection
-    // flags: wxCP_PAINTING_CONTROL is set if painting to combo control instead of list
-    virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags ) const;
-
-    // Return item height
-    virtual wxCoord OnMeasureItem( size_t item ) const;
-
-    // Return item width, or -1 for calculating from text extent (default)
-    virtual wxCoord OnMeasureItemWidth( size_t item ) const;
-
-

     // Item management
     void SetSelection( int item );
     void Insert( const wxString& item, int pos );
     // Item management
     void SetSelection( int item );
     void Insert( const wxString& item, int pos );


@@ -108,7 +103,7 @@ public:
     void SetString( int item, const wxString& str );
     wxString GetString( int item ) const;
     unsigned int GetCount() const;
     void SetString( int item, const wxString& str );
     wxString GetString( int item ) const;
     unsigned int GetCount() const;

-    int FindString(const wxString& s) const;
+    int FindString(const wxString& s, bool bCase = false) const;

     int GetSelection() const;
 
     //void Populate( int n, const wxString choices[] );
     int GetSelection() const;
 
     //void Populate( int n, const wxString choices[] );


@@ -123,20 +118,44 @@ public:
 protected:
 
     // Called by OnComboDoubleClick and OnComboKeyEvent
 protected:
 
     // Called by OnComboDoubleClick and OnComboKeyEvent

-    bool HandleKey( int keycode, bool saturate );
+    bool HandleKey( int keycode, bool saturate, wxChar unicode = 0 );

 
     // sends combobox select event from the parent combo control
     void SendComboBoxEvent( int selection );
 
     // sends combobox select event from the parent combo control
     void SendComboBoxEvent( int selection );

-    
+

     // gets value, sends event and dismisses
     void DismissWithEvent();
 
     // gets value, sends event and dismisses
     void DismissWithEvent();
 

-    // Re-calculates width for given item
-    void CheckWidth( int pos );
+    // OnMeasureItemWidth will be called on next GetAdjustedSize.
+    void ItemWidthChanged(unsigned int item)
+    {
+        m_widths[item] = -1;
+        m_widthsDirty = true;
+    }

 
 

-    // wxVListBox implementation
+    // Callbacks for drawing and measuring items. Override in a derived class for
+    // owner-drawnness. Font, background and text colour have been prepared according
+    // to selection, focus and such.
+    //
+    // item: item index to be drawn, may be wxNOT_FOUND when painting combo control itself
+    //       and there is no valid selection
+    // flags: wxODCB_PAINTING_CONTROL is set if painting to combo control instead of list
+    // NOTE: If wxVListBoxComboPopup is used with wxComboCtrl class not derived from
+    //       wxOwnerDrawnComboBox, this method must be overridden.
+    virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags ) const;
+
+    // This is same as in wxVListBox
+    virtual wxCoord OnMeasureItem( size_t item ) const;
+
+    // Return item width, or -1 for calculating from text extent (default)
+    virtual wxCoord OnMeasureItemWidth( size_t item ) const;
+
+    // Draw item and combo control background. Flags are same as with OnDrawItem.
+    // NB: Can't use name OnDrawBackground because of virtual function hiding warnings.
+    virtual void OnDrawBg(wxDC& dc, const wxRect& rect, int item, int flags) const;
+
+    // Additional wxVListBox implementation (no need to override in derived classes)

     virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;
     virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;

-    //virtual wxCoord OnMeasureItem(size_t n) const;

     void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const;
 
     // filter mouse move events happening outside the list box
     void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const;
 
     // filter mouse move events happening outside the list box


@@ -146,26 +165,57 @@ protected:
     void OnKey(wxKeyEvent& event);
     void OnLeftClick(wxMouseEvent& event);
 
     void OnKey(wxKeyEvent& event);
     void OnLeftClick(wxMouseEvent& event);
 

+    // Return the widest item width (recalculating it if necessary)
+    int GetWidestItemWidth() { CalcWidths(); return m_widestWidth; }
+
+    // Return the index of the widest item (recalculating it if necessary)
+    int GetWidestItem() { CalcWidths(); return m_widestItem; }
+
+    // Stop partial completion (when some other event occurs)
+    void StopPartialCompletion();
+

     wxArrayString           m_strings;
     wxArrayPtrVoid          m_clientDatas;
     wxArrayString           m_strings;
     wxArrayPtrVoid          m_clientDatas;

-    wxArrayInt              m_widths; // cached line widths

 
     wxFont                  m_useFont;
 
     //wxString                m_stringValue; // displayed text (may be different than m_strings[m_value])
     int                     m_value; // selection
     int                     m_itemHover; // on which item the cursor is
 
     wxFont                  m_useFont;
 
     //wxString                m_stringValue; // displayed text (may be different than m_strings[m_value])
     int                     m_value; // selection
     int                     m_itemHover; // on which item the cursor is

-    int                     m_widestWidth; // width of widest item thus far
-    int                     m_avgCharWidth;
-    int                     m_baseImageWidth; // how much per item drawn in addition to text

     int                     m_itemHeight; // default item height (calculate from font size
                                           // and used in the absence of callback)
     wxClientDataType        m_clientDataItemsType;
 
 private:
 
     int                     m_itemHeight; // default item height (calculate from font size
                                           // and used in the absence of callback)
     wxClientDataType        m_clientDataItemsType;
 
 private:
 

+    // Cached item widths (in pixels).
+    wxArrayInt              m_widths;
+
+    // Width of currently widest item.
+    int                     m_widestWidth;
+
+    // Index of currently widest item.
+    int                     m_widestItem;
+
+    // Measure some items in next GetAdjustedSize?
+    bool                    m_widthsDirty;
+
+    // Find widest item in next GetAdjustedSize?
+    bool                    m_findWidest;
+

     // has the mouse been released on this control?
     // has the mouse been released on this control?

-    bool m_clicked;
+    bool                    m_clicked;
+
+    // Recalculate widths if they are dirty
+    void CalcWidths();
+
+    // Partial completion string
+    wxString                m_partialCompletionString;
+
+#if wxUSE_TIMER
+    // Partial completion timer
+    wxTimer                 m_partialCompletionTimer;
+#endif // wxUSE_TIMER

 
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };


@@ -174,17 +224,18 @@ private:
 // ----------------------------------------------------------------------------
 // wxOwnerDrawnComboBox: a generic wxComboBox that allows custom paint items
 // in addition to many other types of customization already allowed by
 // ----------------------------------------------------------------------------
 // wxOwnerDrawnComboBox: a generic wxComboBox that allows custom paint items
 // in addition to many other types of customization already allowed by

-// the wxComboControl.
+// the wxComboCtrl.

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxOwnerDrawnComboBox : public wxComboControl, public wxItemContainer
+class WXDLLIMPEXP_ADV wxOwnerDrawnComboBox : public wxComboCtrl,
+                                             public wxItemContainer

 {
 {

-    friend class wxComboPopupWindow;
-    friend class wxComboControlBase;
+    //friend class wxComboPopupWindow;
+    friend class wxVListBoxComboPopup;

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

-    wxOwnerDrawnComboBox() : wxComboControl() { Init(); }
+    wxOwnerDrawnComboBox() : wxComboCtrl() { Init(); }

 
     wxOwnerDrawnComboBox(wxWindow *parent,
                          wxWindowID id,
 
     wxOwnerDrawnComboBox(wxWindow *parent,
                          wxWindowID id,


@@ -196,7 +247,7 @@ public:
                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = wxComboBoxNameStr)
                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = wxComboBoxNameStr)

-        : wxComboControl()
+        : wxComboCtrl()

     {
         Init();
 
     {
         Init();
 


@@ -219,17 +270,17 @@ public:
                          const wxPoint& pos,
                          const wxSize& size,
                          const wxArrayString& choices,
                          const wxPoint& pos,
                          const wxSize& size,
                          const wxArrayString& choices,

-                         long style = 0,
+                         long style,

                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = wxComboBoxNameStr);
 
     bool Create(wxWindow *parent,
                 wxWindowID id,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = wxComboBoxNameStr);
 
     bool Create(wxWindow *parent,
                 wxWindowID id,

-                const wxString& value = wxEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                int n = 0,
-                const wxString choices[] = (const wxString *) NULL,
+                const wxString& value,
+                const wxPoint& pos,
+                const wxSize& size,
+                int n,
+                const wxString choices[],

                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxComboBoxNameStr);
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxComboBoxNameStr);


@@ -246,8 +297,11 @@ public:
 
     virtual ~wxOwnerDrawnComboBox();
 
 
     virtual ~wxOwnerDrawnComboBox();
 

-    // NULL popup can be used to indicate default interface
-    virtual void SetPopupControl( wxComboPopup* popup );
+    // Prevent app from using wxComboPopup
+    void SetPopupControl(wxVListBoxComboPopup* popup)
+    {
+        DoSetPopupControl(popup);
+    }

 
     // wxControlWithItems methods
     virtual void Clear();
 
     // wxControlWithItems methods
     virtual void Clear();


@@ -255,18 +309,56 @@ public:
     virtual unsigned int GetCount() const;
     virtual wxString GetString(unsigned int n) const;
     virtual void SetString(unsigned int n, const wxString& s);
     virtual unsigned int GetCount() const;
     virtual wxString GetString(unsigned int n) const;
     virtual void SetString(unsigned int n, const wxString& s);

-    virtual int FindString(const wxString& s) const;
+    virtual int FindString(const wxString& s, bool bCase = false) const;

     virtual void Select(int n);
     virtual int GetSelection() const;
     virtual void Select(int n);
     virtual int GetSelection() const;

-    void SetSelection(int n) { Select(n); }
+    virtual void SetSelection(int n) { Select(n); }
+
+
+    // Prevent a method from being hidden
+    virtual void SetSelection(long from, long to)
+    {
+        wxComboCtrl::SetSelection(from,to);
+    }
+
+    // Return the widest item width (recalculating it if necessary)
+    virtual int GetWidestItemWidth() { EnsurePopupControl(); return GetVListBoxComboPopup()->GetWidestItemWidth(); }
+
+    // Return the index of the widest item (recalculating it if necessary)
+    virtual int GetWidestItem() { EnsurePopupControl(); return GetVListBoxComboPopup()->GetWidestItem(); }

 
     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 
 protected:
 
 
     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 
 protected:
 

+    // Callback for drawing. Font, background and text colour have been
+    // prepared according to selection, focus and such.
+    // item: item index to be drawn, may be wxNOT_FOUND when painting combo control itself
+    //       and there is no valid selection
+    // flags: wxODCB_PAINTING_CONTROL is set if painting to combo control instead of list
+    virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags ) const;
+
+    // Callback for item height, or -1 for default
+    virtual wxCoord OnMeasureItem( size_t item ) const;
+
+    // Callback for item width, or -1 for default/undetermined
+    virtual wxCoord OnMeasureItemWidth( size_t item ) const;
+
+    // Callback for background drawing. Flags are same as with
+    // OnDrawItem.
+    virtual void OnDrawBackground( wxDC& dc, const wxRect& rect, int item, int flags ) const;
+
+    // NULL popup can be used to indicate default interface
+    virtual void DoSetPopupControl(wxComboPopup* popup);
+

     // clears all allocated client datas
     void ClearClientDatas();
 
     // clears all allocated client datas
     void ClearClientDatas();
 

+    wxVListBoxComboPopup* GetVListBoxComboPopup() const
+    {
+        return (wxVListBoxComboPopup*) m_popupInterface;
+    }
+

     virtual int DoAppend(const wxString& item);
     virtual int DoInsert(const wxString& item, unsigned int pos);
     virtual void DoSetItemClientData(unsigned int n, void* clientData);
     virtual int DoAppend(const wxString& item);
     virtual int DoInsert(const wxString& item, unsigned int pos);
     virtual void DoSetItemClientData(unsigned int n, void* clientData);


@@ -274,9 +366,6 @@ protected:
     virtual void DoSetItemClientObject(unsigned int n, wxClientData* clientData);
     virtual wxClientData* DoGetItemClientObject(unsigned int n) const;
 
     virtual void DoSetItemClientObject(unsigned int n, wxClientData* clientData);
     virtual wxClientData* DoGetItemClientObject(unsigned int n) const;
 

-    // overload m_popupInterface member so we can access specific popup interface easier
-    wxVListBoxComboPopup*   m_popupInterface;
-

     // temporary storage for the initial choices
     //const wxString*         m_baseChoices;
     //int                     m_baseChoicesCount;
     // temporary storage for the initial choices
     //const wxString*         m_baseChoices;
     //int                     m_baseChoicesCount;


@@ -291,6 +380,7 @@ private:
 };
 
 
 };
 
 

-#endif // wxUSE_OWNERDRAWNCOMBOBOX
+#endif // wxUSE_ODCOMBOBOX
+

 #endif
     // _WX_ODCOMBO_H_
 #endif
     // _WX_ODCOMBO_H_