// 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
+#if wxUSE_LISTBOX
// ----------------------------------------------------------------------------
// simple types
// ----------------------------------------------------------------------------
#if wxUSE_OWNER_DRAWN
- class WXDLLEXPORT wxOwnerDrawn;
+ class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn;
// define the array of list box items
- #include <wx/dynarray.h>
+ #include "wx/dynarray.h"
- WX_DEFINE_EXPORTED_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray);
+ WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
#endif // wxUSE_OWNER_DRAWN
// forward decl for GetSelections()
-class wxArrayInt;
+class WXDLLIMPEXP_FWD_BASE wxArrayInt;
// ----------------------------------------------------------------------------
// List box control
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxListBox : public wxListBoxBase
+class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
{
public:
// ctors and such
- wxListBox();
+ wxListBox() { Init(); }
wxListBox(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxListBoxNameStr)
{
+ Init();
+
Create(parent, id, pos, size, n, choices, style, validator, name);
}
+ 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)
+ {
+ Init();
+
+ Create(parent, id, pos, size, choices, style, validator, name);
+ }
bool Create(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
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();
- // implement base class pure virtuals
- virtual void Clear();
- virtual void Delete(int n);
-
- virtual int GetCount() const;
- virtual wxString GetString(int n) const;
- virtual void SetString(int n, const wxString& s);
- virtual int FindString(const wxString& s) const;
+ 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 void SetSelection(int n, bool select = TRUE);
virtual int GetSelection() const;
virtual int GetSelections(wxArrayInt& aSelections) const;
- virtual int DoAppend(const wxString& item);
- virtual void DoInsertItems(const wxArrayString& items, int pos);
- virtual void DoSetItems(const wxArrayString& items, void **clientData);
-
- virtual void DoSetFirstItem(int n);
-
- virtual void DoSetClientData(int n, void* clientData);
- virtual void* DoGetClientData(int n) const;
- virtual void DoSetClientObject(int n, wxClientData* clientData);
- virtual wxClientData* DoGetClientObject(int n) 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)); }
- // wxCheckListBox support
+ // 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
- // 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.
+ // 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);
// Windows callbacks
- virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
- WXUINT message,
- WXWPARAM wParam, WXLPARAM lParam);
-
bool MSWCommand(WXUINT param, WXWORD id);
+ WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
- virtual void SetupColours();
+ // 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;
+ }
+
+ virtual wxVisualAttributes GetDefaultAttributes() const
+ {
+ return GetClassDefaultAttributes(GetWindowVariant());
+ }
+
+ static wxVisualAttributes
+ GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
+ {
+ return GetCompositeControlsDefaultAttributes(variant);
+ }
+
+ // returns true if the platform should explicitly apply a theme border
+ virtual bool CanApplyThemeBorder() const { return false; }
+
+ virtual void OnInternalIdle();
protected:
- // do we have multiple selections?
- bool HasMultipleSelection() const;
+ virtual wxSize DoGetBestClientSize() const;
+
+ virtual void DoClear();
+ virtual void DoDeleteOneItem(unsigned int n);
- int m_noItems;
- int m_selected;
+ virtual void DoSetSelection(int n, bool select);
- virtual wxSize DoGetBestSize();
+ virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+ unsigned int pos,
+ void **clientData, wxClientDataType type);
+
+ virtual void DoSetFirstItem(int n);
+ virtual void DoSetItemClientData(unsigned int n, void* clientData);
+ virtual void* DoGetItemClientData(unsigned int n) const;
+
+ // 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
#endif
private:
- DECLARE_DYNAMIC_CLASS(wxListBox)
+ // 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_