/////////////////////////////////////////////////////////////////////////////
// Name: listbox.h
// Purpose: wxListBox class
-// Author: Julian Smart
+// Author: David Webster
// Modified by:
-// Created: 01/02/97
+// Created: 10/09/99
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Copyright: (c) David Webster
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_LISTBOX_H_
#define _WX_LISTBOX_H_
-#ifdef __GNUG__
-#pragma interface "listbox.h"
-#endif
-
-#include "wx/control.h"
-
-WXDLLEXPORT_DATA(extern const wxChar*) wxListBoxNameStr;
+// ----------------------------------------------------------------------------
+// simple types
+// ----------------------------------------------------------------------------
#if wxUSE_OWNER_DRAWN
class WXDLLEXPORT wxOwnerDrawn;
// define the array of list box items
#include <wx/dynarray.h>
- 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 wxChar*) wxEmptyString;
+// ----------------------------------------------------------------------------
+// List box control
+// ----------------------------------------------------------------------------
-// List box item
-class WXDLLEXPORT wxListBox : public wxControl
+class WXDLLEXPORT wxListBox : public wxListBoxBase
{
- DECLARE_DYNAMIC_CLASS(wxListBox)
-
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)
+ wxListBox( wxWindow* pParent
+ ,wxWindowID vId
+ ,const wxPoint& rPos = wxDefaultPosition
+ ,const wxSize& rSize = wxDefaultSize
+ ,int n = 0
+ ,const wxString asChoices[] = NULL
+ ,long lStyle = 0
+#if wxUSE_VALIDATORS
+ ,const wxValidator& rValidator = wxDefaultValidator
+#endif
+ ,const wxString& rsName = wxListBoxNameStr)
{
- Create(parent, id, pos, size, n, choices, style, validator, name);
+ Create( pParent
+ ,vId
+ ,rPos
+ ,rSize
+ ,n
+ ,asChoices
+ ,lStyle
+#if wxUSE_VALIDATORS
+ ,rValidator
+#endif
+ ,rsName
+ );
}
- 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);
-
- ~wxListBox();
-
- bool MSWCommand(WXUINT param, WXWORD id);
-
+ bool Create( wxWindow* pParent
+ ,wxWindowID vId
+ ,const wxPoint& rPos = wxDefaultPosition
+ ,const wxSize& rSize = wxDefaultSize
+ ,int n = 0
+ ,const wxString asChoices[] = NULL
+ ,long lStyle = 0
+#if wxUSE_VALIDATORS
+ ,const wxValidator& rValidator = wxDefaultValidator
+#endif
+ ,const wxString& rsName = wxListBoxNameStr
+ );
+
+ virtual ~wxListBox();
+
+ //
+ // Implement base class pure virtuals
+ //
+ virtual void Clear(void);
+ virtual void Delete(int n);
+
+ virtual int GetCount(void) const;
+ virtual wxString GetString(int n) const;
+ virtual void SetString( int n
+ ,const wxString& rsString
+ );
+ virtual int FindString(const wxString& rsString) const;
+
+ virtual bool IsSelected(int n) const;
+ virtual void SetSelection( int n
+ ,bool bSelect = TRUE
+ );
+ virtual int GetSelection(void) const;
+ virtual int GetSelections(wxArrayInt& raSelections) const;
+
+ virtual int DoAppend(const wxString& rsItem);
+ virtual void DoInsertItems( const wxArrayString& raItems
+ ,int rPos
+ );
+ virtual void DoSetItems( const wxArrayString& raItems
+ ,void ** ppClientData
+ );
+
+ virtual void DoSetFirstItem(int n);
+
+ virtual void DoSetItemClientData( int n
+ ,void* pClientData
+ );
+ virtual void* DoGetItemClientData(int n) const;
+ virtual void DoSetItemClientObject( int n
+ ,wxClientData* pClientData
+ );
+ 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);
+ long OS2OnMeasure(WXMEASUREITEMSTRUCT *item);
+ bool OS2OnDraw(WXDRAWITEMSTRUCT *item);
- // 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); }
+ virtual wxOwnerDrawn* CreateItem(size_t n);
+ wxOwnerDrawn* GetItem(size_t n) const { return m_aItems[n]; }
+ int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); }
#endif // wxUSE_OWNER_DRAWN
- virtual void Append(const wxString& item);
- virtual void Append(const wxString& item, void *clientData);
- virtual void Set(int n, const wxString* choices, void **clientData = NULL);
- virtual int FindString(const wxString& s) const ;
- virtual void Clear();
- virtual void SetSelection(int n, bool select = TRUE);
-
- virtual void Deselect(int n);
-
- // For single choice list item only
- virtual int GetSelection() const ;
- virtual void Delete(int n);
- virtual void *GetClientData(int n) const ;
- virtual void SetClientData(int n, void *clientData);
- virtual void SetString(int n, const wxString& s);
-
- // For single or multiple choice list item
- virtual int GetSelections(wxArrayInt& aSelections) const;
- virtual bool Selected(int n) const ;
- virtual wxString GetString(int n) const ;
-
- // Set the specified item at the first visible item
- // or scroll to max range.
- virtual void SetFirstItem(int n) ;
- virtual void SetFirstItem(const wxString& s) ;
-
- virtual void InsertItems(int nItems, const wxString items[], int pos);
-
- virtual wxString GetStringSelection() const ;
- virtual bool SetStringSelection(const wxString& s, bool flag = TRUE);
- virtual int Number() const ;
-
- void Command(wxCommandEvent& event);
+ bool OS2Command( WXUINT uParam
+ ,WXWORD wId
+ );
+ virtual void SetupColours(void);
- // 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);
+protected:
- virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
- WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+ bool HasMultipleSelection(void) const;
+ virtual wxSize DoGetBestSize(void) const;
- virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
- virtual void SetupColours();
+ int m_nNumItems;
+ int m_nSelected;
-protected:
- int m_noItems;
- int m_selected;
#if wxUSE_OWNER_DRAWN
- // control items
- wxListBoxItemsArray m_aItems;
+ //
+ // Control items
+ //
+ wxListBoxItemsArray m_aItems;
#endif
+
private:
- // Virtual function hiding warning
- virtual wxControl *CreateItem(const wxItemResource* childResource,
- const wxItemResource* parentResource,
- const wxResourceTable *table = (const wxResourceTable *) NULL)
- { return(wxWindowBase::CreateItem(childResource, parentResource, table)); }
- virtual void *GetClientData() const
- {return (wxWindowBase::GetClientData()); }
- virtual void SetClientData( void *data )
- { wxWindowBase::SetClientData(data); }
-};
+#if wxUSE_WX_RESOURCES
+# if wxUSE_OWNER_DRAWN
+ virtual wxControl* CreateItem( const wxItemResource* pChildResource
+ ,const wxItemResource* pParentResource
+ ,const wxResourceTable* pTable = (const wxResourceTable *) NULL
+ )
+ {
+ return(wxWindowBase::CreateItem( pChildResource
+ ,pParentResource
+ ,pTable
+ )
+ );
+ }
+# endif
+#endif
+ DECLARE_DYNAMIC_CLASS(wxListBox)
+}; // end of wxListBox
#endif
// _WX_LISTBOX_H_