]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/listbox.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / os2 / listbox.h
index d95db4379b0a72abd9bacc25851f2b4d7d1657f3..b3160b9286e9ac7967dea9bf05f8e325f7ac231c 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        listbox.h
+// Name:        wx/os2/listbox.h
 // Purpose:     wxListBox class
 // Purpose:     wxListBox class
-// Author:      AUTHOR
+// Author:      David Webster
 // Modified by:
 // Modified by:
-// Created:     ??/??/98
+// Created:     10/09/99
 // RCS-ID:      $Id$
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) David Webster
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_LISTBOX_H_
 #define _WX_LISTBOX_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_LISTBOX_H_
 #define _WX_LISTBOX_H_
 
-#ifdef __GNUG__
-#pragma interface "listbox.h"
-#endif
+// ----------------------------------------------------------------------------
+// simple types
+// ----------------------------------------------------------------------------
+
+#if wxUSE_OWNER_DRAWN
+    class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn;
 
 
-#include "wx/control.h"
+    // define the array of list box items
+    #include  "wx/dynarray.h"
 
 
-WXDLLEXPORT_DATA(extern const char*) wxListBoxNameStr;
+    WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
+#endif // wxUSE_OWNER_DRAWN
 
 // forward decl for GetSelections()
 
 // forward decl for GetSelections()
-class WXDLLEXPORT wxArrayInt;
+class wxArrayInt;
 
 
-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+// ----------------------------------------------------------------------------
+// List box control
+// ----------------------------------------------------------------------------
 
 
-// List box item
-class WXDLLEXPORT wxListBox: public wxControl
+class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
 {
 {
-  DECLARE_DYNAMIC_CLASS(wxListBox)
- public:
-
-  wxListBox();
-  inline 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);
-
-  ~wxListBox();
-
-  virtual void Append(const wxString& item);
-  virtual void Append(const wxString& item, char *clientData);
-  virtual void Set(int n, const wxString* choices, char **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 char *GetClientData(int n) const ;
-  virtual void SetClientData(int n, char *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 ;
-  virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-
-  // 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);
-
- protected:
-  int       m_noItems;
-  int       m_selected;
-};
-
+public:
+    // ctors and such
+    wxListBox();
+    wxListBox( wxWindow*          pParent
+              ,wxWindowID         vId
+              ,const wxPoint&     rPos = wxDefaultPosition
+              ,const wxSize&      rSize = wxDefaultSize
+              ,int                n = 0
+              ,const wxString     asChoices[] = NULL
+              ,long               lStyle = 0
+              ,const wxValidator& rValidator = wxDefaultValidator
+              ,const wxString&    rsName = wxListBoxNameStr)
+    {
+        Create( pParent
+               ,vId
+               ,rPos
+               ,rSize
+               ,n
+               ,asChoices
+               ,lStyle
+               ,rValidator
+               ,rsName
+              );
+    }
+    wxListBox( wxWindow*            pParent
+              ,wxWindowID           vId
+              ,const wxPoint&       rPos
+              ,const wxSize&        rSize
+              ,const wxArrayString& asChoices
+              ,long                 lStyle = 0
+              ,const wxValidator&   rValidator = wxDefaultValidator
+              ,const wxString&      rsName = wxListBoxNameStr)
+    {
+        Create( pParent
+               ,vId
+               ,rPos
+               ,rSize
+               ,asChoices
+               ,lStyle
+               ,rValidator
+               ,rsName
+              );
+    }
+
+    bool Create( wxWindow*          pParent
+                ,wxWindowID         vId
+                ,const wxPoint&     rPos = wxDefaultPosition
+                ,const wxSize&      rSize = wxDefaultSize
+                ,int                n = 0
+                ,const wxString     asChoices[] = NULL
+                ,long               lStyle = 0
+                ,const wxValidator& rValidator = wxDefaultValidator
+                ,const wxString&    rsName = wxListBoxNameStr
+               );
+    bool Create( wxWindow*            pParent
+                ,wxWindowID           vId
+                ,const wxPoint&       rPos
+                ,const wxSize&        rSize
+                ,const wxArrayString& asChoices
+                ,long                 lStyle = 0
+                ,const wxValidator&   rValidator = wxDefaultValidator
+                ,const wxString&      rsName = wxListBoxNameStr
+               );
+
+    virtual ~wxListBox();
+
+    //
+    // Implement base class pure virtuals
+    //
+    virtual void          DoClear(void);
+    virtual void          DoDeleteOneItem(unsigned int n);
+
+    virtual unsigned int  GetCount() const;
+    virtual wxString      GetString(unsigned int n) const;
+    virtual void          SetString(unsigned int n, const wxString& rsString);
+
+    virtual bool          IsSelected(int n) const;
+    virtual void          DoSetSelection(int  n, bool bSelect);
+    virtual int           GetSelection(void) const;
+    virtual int           GetSelections(wxArrayInt& raSelections) const;
+
+    virtual void          DoSetFirstItem(int n);
+
+    virtual void          DoSetItemClientData(unsigned int n, void* pClientData);
+    virtual void*         DoGetItemClientData(unsigned int n) const;
+
+    //
+    // wxCheckListBox support
+    //
+#if wxUSE_OWNER_DRAWN
+    long                  OS2OnMeasure(WXMEASUREITEMSTRUCT *item);
+    bool                  OS2OnDraw(WXDRAWITEMSTRUCT *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
+
+    bool                  OS2Command( WXUINT uParam
+                                     ,WXWORD wId
+                                    );
+    virtual void          SetupColours(void);
+
+protected:
+
+    bool                  HasMultipleSelection(void) const;
+    virtual wxSize        DoGetBestSize(void) const;
+
+    unsigned int          m_nNumItems;
+    int                   m_nSelected;
+
+#if wxUSE_OWNER_DRAWN
+    //
+    // Control items
+    //
+    wxListBoxItemsArray             m_aItems;
 #endif
 #endif
-    // _WX_LISTBOX_H_
+
+    //
+    // Implement base wxItemContainer virtuals
+    //
+    virtual int           DoInsertItems(const wxArrayStringsAdapter& items,
+                                        unsigned int pos,
+                                        void **clientData,
+                                        wxClientDataType type);
+
+    DECLARE_DYNAMIC_CLASS(wxListBox)
+}; // end of wxListBox
+
+#endif // _WX_LISTBOX_H_