4f4c5fcfdf
This is a combination of running clang-tidy with modernize-use-nullptr check for some ports (GTK, X11, OSX) and manual changes to the ports for which it couldn't be used easily (MSW, DFB) and also manually updating the docs. Also replace NULL with null or nullptr in the comments as this is more consistent with the use of nullptr in the code and makes it simpler to grep for the remaining occurrences of NULL itself. And also use null in the assert messages. Only a few occurrences of "NULL" are still left in non-C files, mostly corresponding to unclear comments or string output which it might not be safe to change.
219 lines
7.6 KiB
C++
219 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[] = nullptr,
|
|
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[] = nullptr,
|
|
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 override;
|
|
virtual wxString GetString(unsigned int n) const override;
|
|
virtual void SetString(unsigned int n, const wxString& s) override;
|
|
virtual int FindString(const wxString& s, bool bCase = false) const override;
|
|
|
|
virtual bool IsSelected(int n) const override;
|
|
virtual int GetSelection() const override;
|
|
virtual int GetSelections(wxArrayInt& aSelections) const override;
|
|
|
|
// 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) override;
|
|
|
|
virtual int GetTopItem() const override;
|
|
virtual int GetCountPerPage() const override;
|
|
|
|
// ownerdrawn wxListBox and wxCheckListBox support
|
|
#if wxUSE_OWNER_DRAWN
|
|
// override base class virtuals
|
|
virtual bool SetFont(const wxFont &font) override;
|
|
|
|
bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item) override;
|
|
bool MSWOnDraw(WXDRAWITEMSTRUCT *item) override;
|
|
|
|
// 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) override;
|
|
WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const override;
|
|
|
|
// 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() override
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual wxVisualAttributes GetDefaultAttributes() const override
|
|
{
|
|
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 override { return false; }
|
|
|
|
virtual void OnInternalIdle() override;
|
|
|
|
protected:
|
|
virtual wxSize DoGetBestClientSize() const override;
|
|
|
|
virtual void DoClear() override;
|
|
virtual void DoDeleteOneItem(unsigned int n) override;
|
|
|
|
virtual void DoSetSelection(int n, bool select) override;
|
|
|
|
virtual int DoInsertItems(const wxArrayStringsAdapter& items,
|
|
unsigned int pos,
|
|
void **clientData, wxClientDataType type) override;
|
|
|
|
virtual void DoSetFirstItem(int n) override;
|
|
virtual void DoSetItemClientData(unsigned int n, void* clientData) override;
|
|
virtual void* DoGetItemClientData(unsigned int n) const override;
|
|
|
|
// 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) override;
|
|
|
|
// 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_
|