]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/listbox.h
synchronize GTK2 minimum version in docs
[wxWidgets.git] / include / wx / os2 / listbox.h
index 790d8606ace147463705851002482013bf4281b3..b3160b9286e9ac7967dea9bf05f8e325f7ac231c 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        listbox.h
+// Name:        wx/os2/listbox.h
 // Purpose:     wxListBox class
 // Author:      David Webster
 // Modified by:
 // ----------------------------------------------------------------------------
 
 #if wxUSE_OWNER_DRAWN
-  class WXDLLEXPORT wxOwnerDrawn;
+    class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn;
 
-  // define the array of list box items
-  #include  <wx/dynarray.h>
+    // define the array of list box items
+    #include  "wx/dynarray.h"
 
-  WX_DEFINE_EXPORTED_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray);
+    WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
 #endif // wxUSE_OWNER_DRAWN
 
 // forward decl for GetSelections()
@@ -32,115 +32,135 @@ class wxArrayInt;
 // List box control
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxListBox : public wxListBoxBase
+class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
 {
 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,
-#if wxUSE_VALIDATORS
-            const wxValidator& validator = wxDefaultValidator,
-#endif
-            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
+              ,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(parent, id, pos, size, n, choices, style, validator, name);
+        Create( pParent
+               ,vId
+               ,rPos
+               ,rSize
+               ,asChoices
+               ,lStyle
+               ,rValidator
+               ,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,
-#if wxUSE_VALIDATORS
-                const wxValidator& validator = wxDefaultValidator,
-#endif
-                const wxString& name = wxListBoxNameStr);
+    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 Clear();
-    virtual void Delete(int n);
+    //
+    // Implement base class pure virtuals
+    //
+    virtual void          DoClear(void);
+    virtual void          DoDeleteOneItem(unsigned 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 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 SetSelection(int n, bool select = TRUE);
-    virtual int GetSelection() const;
-    virtual int GetSelections(wxArrayInt& aSelections) const;
+    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 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 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;
+    virtual void          DoSetItemClientData(unsigned int n, void* pClientData);
+    virtual void*         DoGetItemClientData(unsigned int n) const;
 
+    //
     // wxCheckListBox support
+    //
 #if wxUSE_OWNER_DRAWN
-    bool OS2OnMeasure(WXMEASUREITEMSTRUCT *item);
-    bool OS2OnDraw(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]; }
+    long                  OS2OnMeasure(WXMEASUREITEMSTRUCT *item);
+    bool                  OS2OnDraw(WXDRAWITEMSTRUCT *item);
 
-    // 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
 
-    // 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 OS2Command(WXUINT param, WXWORD id);
-
-    virtual void SetupColours();
+    bool                  OS2Command( WXUINT uParam
+                                     ,WXWORD wId
+                                    );
+    virtual void          SetupColours(void);
 
 protected:
-    // do we have multiple selections?
-    bool HasMultipleSelection() const;
 
-    int m_noItems;
-    int m_selected;
+    bool                  HasMultipleSelection(void) const;
+    virtual wxSize        DoGetBestSize(void) const;
 
-    virtual wxSize DoGetBestSize() const;
+    unsigned int          m_nNumItems;
+    int                   m_nSelected;
 
 #if wxUSE_OWNER_DRAWN
-    // control items
-    wxListBoxItemsArray m_aItems;
+    //
+    // Control items
+    //
+    wxListBoxItemsArray             m_aItems;
 #endif
 
-private:
-#if wxUSE_WX_RESOURCES
-#  if wxUSE_OWNER_DRAWN
-    virtual wxControl *CreateItem(const wxItemResource* childResource,
-                                  const wxItemResource* parentResource,
-                                  const wxResourceTable *table = (const wxResourceTable *) NULL)
-    { return(wxWindowBase::CreateItem(childResource, parentResource, table)); }
-#  endif
-#endif
+    //
+    // 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_
+#endif // _WX_LISTBOX_H_