X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/39ca6d790b4629bdacd5ea15e0169aa17fb1d53f..51623cc53f350935337e57930eaaf1afe9a48c3b:/include/wx/msw/listbox.h diff --git a/include/wx/msw/listbox.h b/include/wx/msw/listbox.h index edcff1b9ec..b687aac8d7 100644 --- a/include/wx/msw/listbox.h +++ b/include/wx/msw/listbox.h @@ -1,51 +1,44 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: listbox.h +// Name: wx/msw/listbox.h // Purpose: wxListBox class // Author: Julian Smart // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) Julian Smart -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_LISTBOX_H_ #define _WX_LISTBOX_H_ -#ifdef __GNUG__ -#pragma interface "listbox.h" -#endif - -#include "wx/control.h" +#if wxUSE_LISTBOX -WXDLLEXPORT_DATA(extern const char*) wxListBoxNameStr; +// ---------------------------------------------------------------------------- +// simple types +// ---------------------------------------------------------------------------- #if wxUSE_OWNER_DRAWN - class WXDLLEXPORT wxOwnerDrawn; + class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn; // define the array of list box items - #include - - #undef WXDLLEXPORTLOCAL - #define WXDLLEXPORTLOCAL WXDLLEXPORT - WX_DEFINE_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray); - #undef WXDLLEXPORTLOCAL - #define WXDLLEXPORTLOCAL + #include "wx/dynarray.h" -#endif + WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray); +#endif // wxUSE_OWNER_DRAWN // forward decl for GetSelections() -class wxArrayInt; +class WXDLLIMPEXP_FWD_BASE wxArrayInt; -WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; +// ---------------------------------------------------------------------------- +// List box control +// ---------------------------------------------------------------------------- -// List box item -class WXDLLEXPORT wxListBox : public wxControl +class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase { - DECLARE_DYNAMIC_CLASS(wxListBox) - public: - wxListBox(); + // ctors and such + wxListBox() { Init(); } wxListBox(wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, @@ -54,94 +47,156 @@ public: const wxValidator& validator = wxDefaultValidator, const wxString& name = wxListBoxNameStr) { + Init(); + Create(parent, id, pos, size, n, choices, style, validator, name); } - - bool Create(wxWindow *parent, wxWindowID id, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - int n = 0, const wxString choices[] = NULL, + wxListBox(wxWindow *parent, wxWindowID id, + const wxPoint& pos, + const wxSize& size, + const wxArrayString& choices, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxListBoxNameStr); + const wxString& name = wxListBoxNameStr) + { + Init(); - ~wxListBox(); + Create(parent, id, pos, size, choices, style, validator, name); + } - bool MSWCommand(WXUINT param, WXWORD id); + bool Create(wxWindow *parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int n = 0, const wxString choices[] = NULL, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxListBoxNameStr); + bool Create(wxWindow *parent, wxWindowID id, + const wxPoint& pos, + const wxSize& size, + const wxArrayString& choices, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxListBoxNameStr); + + virtual ~wxListBox(); + + 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, bool bCase = false) const; + + virtual bool IsSelected(int n) const; + virtual int GetSelection() const; + virtual int GetSelections(wxArrayInt& aSelections) const; + // return the index of the item at this position or wxNOT_FOUND + int HitTest(const wxPoint& pt) const { return DoHitTestList(pt); } + int HitTest(wxCoord x, wxCoord y) const { return DoHitTestList(wxPoint(x, y)); } + + // ownerdrawn wxListBox and wxCheckListBox support #if wxUSE_OWNER_DRAWN + // override base class virtuals + virtual bool SetFont(const wxFont &font); + bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item); bool MSWOnDraw(WXDRAWITEMSTRUCT *item); // plug-in for derived classes - virtual wxOwnerDrawn *CreateItem(size_t n); + virtual wxOwnerDrawn *CreateLboxItem(size_t n); // allows to get the item and use SetXXX functions to set it's appearance wxOwnerDrawn *GetItem(size_t n) const { return m_aItems[n]; } // get the index of the given item int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); } + + // get rect of the given item index + bool GetItemRect(size_t n, wxRect& rect) const; + + // redraw the given item + bool RefreshItem(size_t n); #endif // wxUSE_OWNER_DRAWN - virtual void Append(const wxString& item); - virtual void Append(const wxString& item, char *clientData); - virtual void Set(int n, const wxString* choices, char **clientData = NULL); - virtual int FindString(const wxString& s) const ; - virtual void Clear(); - virtual void SetSelection(int n, bool select = TRUE); + // Windows-specific code to update the horizontal extent of the listbox, if + // necessary. If s is non-empty, the horizontal extent is increased to the + // length of this string if it's currently too short, otherwise the maximum + // extent of all strings is used. In any case calls InvalidateBestSize() + virtual void SetHorizontalExtent(const wxString& s = wxEmptyString); - virtual void Deselect(int n); + // Windows callbacks + bool MSWCommand(WXUINT param, WXWORD id); + WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const; - // For single choice list item only - virtual int GetSelection() const ; - virtual void Delete(int n); - virtual char *GetClientData(int n) const ; - virtual void SetClientData(int n, char *clientData); - virtual void SetString(int n, const wxString& s); + // under XP when using "transition effect for menus and tooltips" if we + // return true for WM_PRINTCLIENT here then it causes noticable slowdown + virtual bool MSWShouldPropagatePrintChild() + { + return false; + } - // For single or multiple choice list item - virtual int GetSelections(wxArrayInt& aSelections) const; - virtual bool Selected(int n) const ; - virtual wxString GetString(int n) const ; + virtual wxVisualAttributes GetDefaultAttributes() const + { + return GetClassDefaultAttributes(GetWindowVariant()); + } + + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL) + { + return GetCompositeControlsDefaultAttributes(variant); + } - // Set the specified item at the first visible item - // or scroll to max range. - virtual void SetFirstItem(int n) ; - virtual void SetFirstItem(const wxString& s) ; + // returns true if the platform should explicitly apply a theme border + virtual bool CanApplyThemeBorder() const { return false; } - virtual void InsertItems(int nItems, const wxString items[], int pos); + virtual void OnInternalIdle(); - virtual wxString GetStringSelection() const ; - virtual bool SetStringSelection(const wxString& s, bool flag = TRUE); - virtual int Number() const ; +protected: + virtual wxSize DoGetBestClientSize() const; - void Command(wxCommandEvent& event); + virtual void DoClear(); + virtual void DoDeleteOneItem(unsigned int n); - // Windows-specific code to set the horizontal extent of - // the listbox, if necessary. If s is non-NULL, it's - // used to calculate the horizontal extent. - // Otherwise, all strings are used. - virtual void SetHorizontalExtent(const wxString& s = wxEmptyString); + virtual void DoSetSelection(int n, bool select); - virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor, - WXUINT message, WXWPARAM wParam, WXLPARAM lParam); + virtual int DoInsertItems(const wxArrayStringsAdapter& items, + unsigned int pos, + void **clientData, wxClientDataType type); - virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); - virtual void SetupColours(); + virtual void DoSetFirstItem(int n); + virtual void DoSetItemClientData(unsigned int n, void* clientData); + virtual void* DoGetItemClientData(unsigned int n) const; -protected: - int m_noItems; - int m_selected; + // this can't be called DoHitTest() because wxWindow already has this method + virtual int DoHitTestList(const wxPoint& point) const; + + // free memory (common part of Clear() and dtor) + void Free(); + + unsigned int m_noItems; #if wxUSE_OWNER_DRAWN // control items wxListBoxItemsArray m_aItems; #endif - virtual void DoSetSize(int x, int y, - int width, int height, - int sizeFlags = wxSIZE_AUTO); +private: + // common part of all ctors + void Init(); + + // call this when items are added to or deleted from the listbox or an + // items text changes + void MSWOnItemsChanged(); + + // flag indicating whether the max horizontal extent should be updated, + // i.e. if we need to call SetHorizontalExtent() from OnInternalIdle() + bool m_updateHorizontalExtent; + + + DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox) }; +#endif // wxUSE_LISTBOX + #endif // _WX_LISTBOX_H_