X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f17c6dbbf70365eda8effec5ad68dab70ed78f8..de6019fb157459e7e7610e3ff813ad8c4a3225cf:/include/wx/msw/listbox.h diff --git a/include/wx/msw/listbox.h b/include/wx/msw/listbox.h index 1b6f0001df..edebfe9907 100644 --- a/include/wx/msw/listbox.h +++ b/include/wx/msw/listbox.h @@ -1,137 +1,141 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifndef __LISTBOXH__ -#define __LISTBOXH__ +#ifndef _WX_LISTBOX_H_ +#define _WX_LISTBOX_H_ #ifdef __GNUG__ -#pragma interface "listbox.h" + #pragma interface "listbox.h" #endif -#include "wx/control.h" +// ---------------------------------------------------------------------------- +// simple types +// ---------------------------------------------------------------------------- -WXDLLEXPORT_DATA(extern const char*) wxListBoxNameStr; -WXDLLEXPORT_DATA(extern const char*) wxListBoxNameStr; - -#if USE_OWNER_DRAWN +#if wxUSE_OWNER_DRAWN class WXDLLEXPORT wxOwnerDrawn; // define the array of list box items #include - WX_DEFINE_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray); -#endif + + WX_DEFINE_EXPORTED_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray); +#endif // wxUSE_OWNER_DRAWN // forward decl for GetSelections() class wxArrayInt; -WXDLLEXPORT_DATA(extern const char*) wxEmptyString; +// ---------------------------------------------------------------------------- +// List box control +// ---------------------------------------------------------------------------- -// List box item -class WXDLLEXPORT wxListBox: public wxControl +class WXDLLEXPORT wxListBox : public wxListBoxBase { - DECLARE_DYNAMIC_CLASS(wxListBox) - public: - - wxListBox(void); - inline wxListBox(wxWindow *parent, const wxWindowID id, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - const int n = 0, const wxString choices[] = NULL, - const long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxListBoxNameStr) - { - Create(parent, id, pos, size, n, choices, style, validator, name); - } - - bool Create(wxWindow *parent, const wxWindowID id, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - const int n = 0, const wxString choices[] = NULL, - const long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxListBoxNameStr); - - ~wxListBox(); - - bool MSWCommand(const WXUINT param, const WXWORD id); - -#if USE_OWNER_DRAWN - bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item); - bool MSWOnDraw(WXDRAWITEMSTRUCT *item); - - // plug-in for derived classes - virtual wxOwnerDrawn *CreateItem(uint n); - - // allows to get the item and use SetXXX functions to set it's appearance - wxOwnerDrawn *GetItem(uint n) const { return m_aItems[n]; } -#endif - - virtual void Append(const wxString& item); - virtual void Append(const wxString& item, char *clientData); - virtual void Set(const int n, const wxString* choices, char **clientData = NULL); - virtual int FindString(const wxString& s) const ; - virtual void Clear(void); - virtual void SetSelection(const int n, const bool select = TRUE); - - virtual void Deselect(const int n); - - // For single choice list item only - virtual int GetSelection() const ; - virtual void Delete(const int n); - virtual char *GetClientData(const int n) const ; - virtual void SetClientData(const int n, char *clientData); - virtual void SetString(const int n, const wxString& s); - - // For single or multiple choice list item - virtual int GetSelections(wxArrayInt& aSelections) const; - virtual bool Selected(const int n) const ; - virtual wxString GetString(const int n) const ; - virtual void SetSize(const int x, const int y, const int width, const int height, const int sizeFlags = wxSIZE_AUTO); - - // Set the specified item at the first visible item - // or scroll to max range. - virtual void SetFirstItem(const int n) ; - virtual void SetFirstItem(const wxString& s) ; - - virtual void InsertItems(const int nItems, const wxString items[], const int pos); - - virtual wxString GetStringSelection(void) const ; - virtual bool SetStringSelection(const wxString& s, const bool flag = TRUE); - virtual int Number(void) const ; - - void Command(wxCommandEvent& event); - - // 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 WXHBRUSH OnCtlColor(const WXHDC pDC, const WXHWND pWnd, const WXUINT nCtlColor, - WXUINT message, WXWPARAM wParam, WXLPARAM lParam); - - virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); - virtual void SetupColours(void); - - protected: - int m_noItems; - int m_selected; - -#if USE_OWNER_DRAWN - // control items - wxListBoxItemsArray m_aItems; +public: + // ctors and such + wxListBox(); + 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 = wxListBoxNameStr) + { + 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, + 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 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 DoSetItemClientData(int n, void* clientData); + virtual void* DoGetItemClientData(int n) const; + virtual void DoSetItemClientObject(int n, wxClientData* clientData); + virtual wxClientData* DoGetItemClientObject(int n) const; + + // wxCheckListBox support +#if wxUSE_OWNER_DRAWN + bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item); + bool MSWOnDraw(WXDRAWITEMSTRUCT *item); + + // plug-in for derived classes + virtual wxOwnerDrawn *CreateItem(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); } +#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. + 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); + + virtual void SetupColours(); + +protected: + // do we have multiple selections? + bool HasMultipleSelection() const; + + // free memory (common part of Clear() and dtor) + void Free(); + + int m_noItems; + int m_selected; + + virtual wxSize DoGetBestSize(); + +#if wxUSE_OWNER_DRAWN + // control items + wxListBoxItemsArray m_aItems; #endif +private: + DECLARE_DYNAMIC_CLASS(wxListBox) }; #endif - // __LISTBOXH__ + // _WX_LISTBOX_H_