// Author: Jaakko Salli
// Modified by:
// Created: Apr-30-2006
-// RCS-ID: $Id$
// Copyright: (c) Jaakko Salli
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/defs.h"
-#if wxUSE_OWNERDRAWNCOMBOBOX
+#if wxUSE_ODCOMBOBOX
#include "wx/combo.h"
#include "wx/ctrlsub.h"
#include "wx/vlbox.h"
+#include "wx/timer.h"
//
//
-// Callback flags
+// Callback flags (see wxOwnerDrawnComboBox::OnDrawItem)
//
-enum
+enum wxOwnerDrawnComboBoxPaintingFlags
{
// 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
};
//
// 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.
//
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxVListBoxComboPopup : public wxVListBox, public wxComboPopup
+class WXDLLIMPEXP_ADV wxVListBoxComboPopup : public wxVListBox,
+ public wxComboPopup
{
friend class wxOwnerDrawnComboBox;
public:
// required virtuals
virtual void Init();
virtual bool Create(wxWindow* parent);
+ virtual void SetFocus();
virtual wxWindow *GetControl() { return this; }
virtual void SetStringValue( const wxString& value );
virtual wxString GetStringValue() const;
virtual wxSize GetAdjustedSize( int minWidth, int prefHeight, int maxHeight );
virtual void PaintComboControl( wxDC& dc, const wxRect& rect );
virtual void OnComboKeyEvent( wxKeyEvent& event );
+ virtual void OnComboCharEvent( wxKeyEvent& event );
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 width, or -1 for calculating from text extent (default)
- virtual wxCoord OnMeasureItemWidth( size_t item ) const;
-
+ virtual bool FindItem(const wxString& item, wxString* trueItem);
// Item management
void SetSelection( int item );
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[] );
// 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
- bool HandleKey( int keycode, bool saturate );
+ // Called by OnComboDoubleClick and OnCombo{Key,Char}Event
+ bool HandleKey( int keycode, bool saturate, wxChar keychar = 0 );
// sends combobox select event from the parent combo control
void SendComboBoxEvent( int selection );
-
+
// 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
- 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;
+ // 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 a wxComboCtrl class not derived from
+ // wxOwnerDrawnComboBox, this method must be overridden.
+ virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags) const;
- // Return item height
+ // 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;
+ void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const;
+
// filter mouse move events happening outside the list box
// move selection with cursor
void OnMouseMove(wxMouseEvent& event);
- void OnMouseWheel(wxMouseEvent& event);
void OnKey(wxKeyEvent& event);
+ void OnChar(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;
- 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
- 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:
+ // 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?
- 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()
};
// ----------------------------------------------------------------------------
// 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 wxWindowWithItems<wxComboCtrl, wxItemContainer>
{
- friend class wxComboPopupWindow;
- friend class wxComboControlBase;
+ //friend class wxComboPopupWindow;
+ friend class wxVListBoxComboPopup;
public:
// ctors and such
- wxOwnerDrawnComboBox() : wxComboControl() { Init(); }
+ wxOwnerDrawnComboBox() { Init(); }
wxOwnerDrawnComboBox(wxWindow *parent,
wxWindowID id,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxComboBoxNameStr)
- : wxComboControl()
{
Init();
wxOwnerDrawnComboBox(wxWindow *parent,
wxWindowID id,
- const wxString& value,
- const wxPoint& pos,
- const wxSize& size,
- const wxArrayString& choices,
+ const wxString& value = wxEmptyString,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ const wxArrayString& choices = wxArrayString(),
long style = 0,
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);
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();
- 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 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;
- void SetSelection(int n) { Select(n); }
- wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
+ // Override these just to maintain consistency with virtual methods
+ // between classes.
+ virtual void Clear();
+ virtual void GetSelection(long *from, long *to) const;
+
+ 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(); }
+
+ virtual bool IsSorted() const { return HasFlag(wxCB_SORT); }
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.
+ // 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;
+
+ // override base implementation so we can return the size for the
+ // largest item
+ virtual wxSize DoGetBestSize() 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();
- 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 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;
};
-#endif // wxUSE_OWNERDRAWNCOMBOBOX
+#endif // wxUSE_ODCOMBOBOX
+
#endif
// _WX_ODCOMBO_H_
projects / wxWidgets.git / blobdiff