a236aa2058
1. the main function for item insertion is now DoInsertItems() which allows for much more efficient addition of many new items at once 2. the items client data management is done entirely in wxItemContainer itself, the derived classes don't have to distinguish between void and object client data 3. many fixes for sorted controls, in particular implemented wxCB_SORT support in wxGTK combobox git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@47730 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
146 lines
4.8 KiB
C++
146 lines
4.8 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/listbox.h
|
|
// Purpose: wxListBox class interface
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 22.10.99
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) wxWidgets team
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_LISTBOX_H_BASE_
|
|
#define _WX_LISTBOX_H_BASE_
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_LISTBOX
|
|
|
|
#include "wx/ctrlsub.h" // base class
|
|
|
|
// forward declarations are enough here
|
|
class WXDLLIMPEXP_FWD_BASE wxArrayInt;
|
|
class WXDLLIMPEXP_FWD_BASE wxArrayString;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// global data
|
|
// ----------------------------------------------------------------------------
|
|
|
|
extern WXDLLEXPORT_DATA(const wxChar) wxListBoxNameStr[];
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxListBox interface is defined by the class wxListBoxBase
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxListBoxBase : public wxControlWithItems
|
|
{
|
|
public:
|
|
wxListBoxBase() { }
|
|
virtual ~wxListBoxBase();
|
|
|
|
void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos)
|
|
{ Insert(nItems, items, pos); }
|
|
void InsertItems(const wxArrayString& items, unsigned int pos)
|
|
{ Insert(items, pos); }
|
|
|
|
// multiple selection logic
|
|
virtual bool IsSelected(int n) const = 0;
|
|
virtual void SetSelection(int n) { DoSetSelection(n, true); }
|
|
void SetSelection(int n, bool select) { DoSetSelection(n, select); }
|
|
void Deselect(int n) { DoSetSelection(n, false); }
|
|
void DeselectAll(int itemToLeaveSelected = -1);
|
|
|
|
virtual bool SetStringSelection(const wxString& s, bool select);
|
|
virtual bool SetStringSelection(const wxString& s)
|
|
{
|
|
return SetStringSelection(s, true);
|
|
}
|
|
|
|
// works for single as well as multiple selection listboxes (unlike
|
|
// GetSelection which only works for listboxes with single selection)
|
|
virtual int GetSelections(wxArrayInt& aSelections) const = 0;
|
|
|
|
// set the specified item at the first visible item or scroll to max
|
|
// range.
|
|
void SetFirstItem(int n) { DoSetFirstItem(n); }
|
|
void SetFirstItem(const wxString& s);
|
|
|
|
// ensures that the given item is visible scrolling the listbox if
|
|
// necessary
|
|
virtual void EnsureVisible(int n);
|
|
|
|
// a combination of Append() and EnsureVisible(): appends the item to the
|
|
// listbox and ensures that it is visible i.e. not scrolled out of view
|
|
void AppendAndEnsureVisible(const wxString& s);
|
|
|
|
// return true if the listbox allows multiple selection
|
|
bool HasMultipleSelection() const
|
|
{
|
|
return (m_windowStyle & wxLB_MULTIPLE) ||
|
|
(m_windowStyle & wxLB_EXTENDED);
|
|
}
|
|
|
|
// override wxItemContainer::IsSorted
|
|
virtual bool IsSorted() const { return HasFlag( wxLB_SORT ); }
|
|
|
|
// emulate selecting or deselecting the item event.GetInt() (depending on
|
|
// event.GetExtraLong())
|
|
void Command(wxCommandEvent& event);
|
|
|
|
// returns the item number at a point or wxNOT_FOUND
|
|
int HitTest(const wxPoint& point) const { return DoListHitTest(point); }
|
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
|
// compatibility - these functions are deprecated, use the new ones
|
|
// instead
|
|
wxDEPRECATED( bool Selected(int n) const );
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
|
|
|
protected:
|
|
virtual void DoSetFirstItem(int n) = 0;
|
|
|
|
virtual void DoSetSelection(int n, bool select) = 0;
|
|
|
|
// there is already wxWindow::DoHitTest() so call this one differently
|
|
virtual int DoListHitTest(const wxPoint& WXUNUSED(point)) const
|
|
{ return wxNOT_FOUND; }
|
|
|
|
private:
|
|
DECLARE_NO_COPY_CLASS(wxListBoxBase)
|
|
};
|
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
|
inline bool wxListBoxBase::Selected(int n) const { return IsSelected(n); }
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// include the platform-specific class declaration
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#if defined(__WXUNIVERSAL__)
|
|
#include "wx/univ/listbox.h"
|
|
#elif defined(__WXMSW__)
|
|
#include "wx/msw/listbox.h"
|
|
#elif defined(__WXMOTIF__)
|
|
#include "wx/motif/listbox.h"
|
|
#elif defined(__WXGTK20__)
|
|
#include "wx/gtk/listbox.h"
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk1/listbox.h"
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/mac/listbox.h"
|
|
#elif defined(__WXPM__)
|
|
#include "wx/os2/listbox.h"
|
|
#elif defined(__WXCOCOA__)
|
|
#include "wx/cocoa/listbox.h"
|
|
#endif
|
|
|
|
#endif // wxUSE_LISTBOX
|
|
|
|
#endif
|
|
// _WX_LISTBOX_H_BASE_
|