220 lines
7.6 KiB
C++
220 lines
7.6 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/msw/listbox.h
|
|
// Purpose: wxListBox class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_LISTBOX_H_
|
|
#define _WX_LISTBOX_H_
|
|
|
|
#if wxUSE_LISTBOX
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// simple types
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#if wxUSE_OWNER_DRAWN
|
|
class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn;
|
|
|
|
// define the array of list box items
|
|
#include "wx/dynarray.h"
|
|
|
|
WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
|
|
#endif // wxUSE_OWNER_DRAWN
|
|
|
|
// forward declaration for GetSelections()
|
|
class WXDLLIMPEXP_FWD_BASE wxArrayInt;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// List box control
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
|
|
{
|
|
public:
|
|
// ctors and such
|
|
wxListBox() { Init(); }
|
|
wxListBox(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 = wxASCII_STR(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 = wxASCII_STR(wxListBoxNameStr))
|
|
{
|
|
Init();
|
|
|
|
Create(parent, id, pos, size, 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,
|
|
long style = 0,
|
|
const wxValidator& validator = wxDefaultValidator,
|
|
const wxString& name = wxASCII_STR(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 = wxASCII_STR(wxListBoxNameStr));
|
|
|
|
virtual ~wxListBox();
|
|
|
|
virtual unsigned int GetCount() const wxOVERRIDE;
|
|
virtual wxString GetString(unsigned int n) const wxOVERRIDE;
|
|
virtual void SetString(unsigned int n, const wxString& s) wxOVERRIDE;
|
|
virtual int FindString(const wxString& s, bool bCase = false) const wxOVERRIDE;
|
|
|
|
virtual bool IsSelected(int n) const wxOVERRIDE;
|
|
virtual int GetSelection() const wxOVERRIDE;
|
|
virtual int GetSelections(wxArrayInt& aSelections) const wxOVERRIDE;
|
|
|
|
// 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)); }
|
|
|
|
virtual void EnsureVisible(int n) wxOVERRIDE;
|
|
|
|
virtual int GetTopItem() const wxOVERRIDE;
|
|
virtual int GetCountPerPage() const wxOVERRIDE;
|
|
|
|
// ownerdrawn wxListBox and wxCheckListBox support
|
|
#if wxUSE_OWNER_DRAWN
|
|
// override base class virtuals
|
|
virtual bool SetFont(const wxFont &font) wxOVERRIDE;
|
|
|
|
bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item) wxOVERRIDE;
|
|
bool MSWOnDraw(WXDRAWITEMSTRUCT *item) wxOVERRIDE;
|
|
|
|
// plug-in for derived classes
|
|
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 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);
|
|
|
|
// This is a wrapper for LB_SETTABSTOPS message and takes tab stops in
|
|
// dialog units, with the same conventions as LB_SETTABSTOPS uses.
|
|
virtual bool MSWSetTabStops(const wxVector<int>& tabStops);
|
|
|
|
// Windows callbacks
|
|
bool MSWCommand(WXUINT param, WXWORD id) wxOVERRIDE;
|
|
WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const wxOVERRIDE;
|
|
|
|
// under XP when using "transition effect for menus and tooltips" if we
|
|
// return true for WM_PRINTCLIENT here then it causes noticeable slowdown
|
|
virtual bool MSWShouldPropagatePrintChild() wxOVERRIDE
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual wxVisualAttributes GetDefaultAttributes() const wxOVERRIDE
|
|
{
|
|
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 wxOVERRIDE { return false; }
|
|
|
|
virtual void OnInternalIdle() wxOVERRIDE;
|
|
|
|
protected:
|
|
virtual wxSize DoGetBestClientSize() const wxOVERRIDE;
|
|
|
|
virtual void DoClear() wxOVERRIDE;
|
|
virtual void DoDeleteOneItem(unsigned int n) wxOVERRIDE;
|
|
|
|
virtual void DoSetSelection(int n, bool select) wxOVERRIDE;
|
|
|
|
virtual int DoInsertItems(const wxArrayStringsAdapter& items,
|
|
unsigned int pos,
|
|
void **clientData, wxClientDataType type) wxOVERRIDE;
|
|
|
|
virtual void DoSetFirstItem(int n) wxOVERRIDE;
|
|
virtual void DoSetItemClientData(unsigned int n, void* clientData) wxOVERRIDE;
|
|
virtual void* DoGetItemClientData(unsigned int n) const wxOVERRIDE;
|
|
|
|
// this can't be called DoHitTest() because wxWindow already has this method
|
|
virtual int DoHitTestList(const wxPoint& point) const;
|
|
|
|
// This is a hook for wxCheckListBox, which uses it to add the checkbox
|
|
// width to the item width and to make it at least as tall as the checkbox.
|
|
virtual wxSize MSWGetFullItemSize(int w, int h) const
|
|
{
|
|
return wxSize(w, h);
|
|
}
|
|
|
|
virtual void MSWUpdateFontOnDPIChange(const wxSize& newDPI) wxOVERRIDE;
|
|
|
|
// free memory (common part of Clear() and dtor)
|
|
void Free();
|
|
|
|
unsigned int m_noItems;
|
|
|
|
#if wxUSE_OWNER_DRAWN
|
|
// control items
|
|
wxListBoxItemsArray m_aItems;
|
|
#endif
|
|
|
|
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;
|
|
|
|
|
|
wxDECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox);
|
|
};
|
|
|
|
#endif // wxUSE_LISTBOX
|
|
|
|
#endif
|
|
// _WX_LISTBOX_H_
|