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

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

diff --git a/include/wx/odcombo.h b/include/wx/odcombo.h
index bb67677acf2497f90a13ab6f8f4fcecc94a2927e..1c803aa5a2303396328bbd87fa53b561c88ffd1a 100644 (file)
--- a/include/wx/odcombo.h
+++ b/include/wx/odcombo.h
@@ -19,6 +19,7 @@
 #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"

 
 
 //
 
 
 //


@@ -39,11 +40,18 @@ enum
 //
 // Callback flags (see wxOwnerDrawnComboBox::OnDrawItem)
 //
 //
 // Callback flags (see wxOwnerDrawnComboBox::OnDrawItem)
 //

-enum
+enum wxOwnerDrawnComboBoxPaintingFlags

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

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

 };
 
 
 };
 
 


@@ -105,12 +113,12 @@ public:
     // helpers
     int GetItemAtPosition( const wxPoint& pos ) { return HitTest(pos); }
     wxCoord GetTotalHeight() const { return EstimateTotalHeight(); }
     // helpers
     int GetItemAtPosition( const wxPoint& pos ) { return HitTest(pos); }
     wxCoord GetTotalHeight() const { return EstimateTotalHeight(); }

-    wxCoord GetLineHeight(int line) const { return OnGetLineHeight(line); }
+    wxCoord GetLineHeight(int line) const { return OnGetRowHeight(line); }

 
 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 );


@@ -118,8 +126,12 @@ protected:
     // 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;
+    }

 
     // Callbacks for drawing and measuring items. Override in a derived class for
     // owner-drawnness. Font, background and text colour have been prepared according
 
     // Callbacks for drawing and measuring items. Override in a derived class for
     // owner-drawnness. Font, background and text colour have been prepared according


@@ -128,9 +140,10 @@ protected:
     // 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
     // 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
+    //
+    // NOTE: If wxVListBoxComboPopup is used with a wxComboCtrl class not derived from

     //       wxOwnerDrawnComboBox, this method must be overridden.
     //       wxOwnerDrawnComboBox, this method must be overridden.

-    virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags ) const;
+    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;
 
     // This is same as in wxVListBox
     virtual wxCoord OnMeasureItem( size_t item ) const;


@@ -153,26 +166,59 @@ 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;
+
+    wxString                m_stringValue;
+
+#if wxUSE_TIMER
+    // Partial completion timer
+    wxTimer                 m_partialCompletionTimer;
+#endif // wxUSE_TIMER

 
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };


@@ -254,12 +300,13 @@ 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
 
     // wxControlWithItems methods

-    virtual void Clear();
-    virtual void Delete(unsigned int n);

     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);


@@ -275,9 +322,19 @@ public:
         wxComboCtrl::SetSelection(from,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(); }
+
+    virtual bool IsSorted() const { return HasFlag(wxCB_SORT); }
+

     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 
 protected:
     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 
 protected:

+    virtual void DoClear();
+    virtual void DoDeleteOneItem(unsigned int n);

 
     // Callback for drawing. Font, background and text colour have been
     // prepared according to selection, focus and such.
 
     // Callback for drawing. Font, background and text colour have been
     // prepared according to selection, focus and such.


@@ -296,18 +353,22 @@ protected:
     // OnDrawItem.
     virtual void OnDrawBackground( wxDC& dc, const wxRect& rect, int item, int flags ) const;
 
     // 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();
 

-    virtual int DoAppend(const wxString& item);
-    virtual int DoInsert(const wxString& item, unsigned int pos);
+    wxVListBoxComboPopup* GetVListBoxComboPopup() const
+    {
+        return (wxVListBoxComboPopup*) m_popupInterface;
+    }
+
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData, wxClientDataType type);

     virtual void DoSetItemClientData(unsigned int n, void* clientData);
     virtual void* DoGetItemClientData(unsigned int n) const;
     virtual void DoSetItemClientData(unsigned int n, void* clientData);
     virtual void* DoGetItemClientData(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;
 
     // temporary storage for the initial choices
     //const wxString*         m_baseChoices;