show native-looking (with 3D shadow) help tooltips for context help, if possible...

[wxWidgets.git] / include / wx / msw / listbox.h

diff --git a/include/wx/msw/listbox.h b/include/wx/msw/listbox.h
index ac0efc056fbc51340a2fcbbf5707da80ed9d2d8c..bd32aa84017f6cb9e58af8e8a207832023d83055 100644 (file)
--- a/include/wx/msw/listbox.h
+++ b/include/wx/msw/listbox.h
@@ -1,142 +1,167 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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
 // Purpose:     wxListBox class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart

-// Licence:    wxWindows licence
+// 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
-
-#include "wx/control.h"
+#if wxUSE_LISTBOX

 
 

-WXDLLEXPORT_DATA(extern const char*) wxListBoxNameStr;
+// ----------------------------------------------------------------------------
+// simple types
+// ----------------------------------------------------------------------------

 
 #if wxUSE_OWNER_DRAWN
   class WXDLLEXPORT wxOwnerDrawn;
 
   // define the array of list box items
 
 #if wxUSE_OWNER_DRAWN
   class WXDLLEXPORT wxOwnerDrawn;
 
   // define the array of list box items

-  #include  <wx/dynarray.h>
-
-  #undef WXDLLEXPORTLOCAL
-  #define WXDLLEXPORTLOCAL WXDLLEXPORT
-  WX_DEFINE_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray);
-  #undef  WXDLLEXPORTLOCAL
-  #define WXDLLEXPORTLOCAL
+  #include  "wx/dynarray.h"

 
 

-#endif
+  WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
+#endif // wxUSE_OWNER_DRAWN

 
 // forward decl for GetSelections()
 
 // forward decl for GetSelections()

-class wxArrayInt;
+class WXDLLIMPEXP_BASE 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, 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();
-
-  bool MSWCommand(WXUINT param, WXWORD id);
-
+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);
+    }
+    wxListBox(wxWindow *parent, wxWindowID id,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxListBoxNameStr)
+    {
+        Create(parent, id, pos, size, 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);
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
+
+    virtual ~wxListBox();
+
+    // implement base class pure virtuals
+    virtual void Clear();
+    virtual void Delete(unsigned int n);
+
+    virtual unsigned int GetCount() const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& s);
+    virtual int FindString(const wxString& s, bool bCase = false) const;
+
+    virtual bool IsSelected(int n) const;
+    virtual int GetSelection() const;
+    virtual int GetSelections(wxArrayInt& aSelections) const;
+
+    // wxCheckListBox support

 #if wxUSE_OWNER_DRAWN
 #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]; }
-#endif
-
-  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(void);
-  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(void) const ;
-  virtual bool SetStringSelection(const wxString& s, 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(WXHDC pDC, WXHWND pWnd, 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;
+    bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item);
+    bool MSWOnDraw(WXDRAWITEMSTRUCT *item);
+
+    // plug-in for derived classes
+    virtual wxOwnerDrawn *CreateLboxItem(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
+    bool MSWCommand(WXUINT param, WXWORD id);
+    WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+    // under XP when using "transition effect for menus and tooltips" if we
+    // return true for WM_PRINTCLIENT here then it causes noticable slowdown
+    virtual bool MSWShouldPropagatePrintChild()
+    {
+        return false;
+    }
+
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
+    {
+        return GetCompositeControlsDefaultAttributes(variant);
+    }
+
+protected:
+    virtual void DoSetSelection(int n, bool select);
+    virtual int DoAppend(const wxString& item);
+    virtual void DoInsertItems(const wxArrayString& items, unsigned int pos);
+    virtual void DoSetItems(const wxArrayString& items, void **clientData);
+    virtual void DoSetFirstItem(int n);
+    virtual void DoSetItemClientData(unsigned int n, void* clientData);
+    virtual void* DoGetItemClientData(unsigned int n) const;
+    virtual void DoSetItemClientObject(unsigned int n, wxClientData* clientData);
+    virtual wxClientData* DoGetItemClientObject(unsigned int n) const;
+    virtual int DoListHitTest(const wxPoint& point) const;
+
+    // free memory (common part of Clear() and dtor)
+    void Free();
+
+    unsigned int m_noItems;
+    int m_selected;
+
+    virtual wxSize DoGetBestSize() const;

 
 #if wxUSE_OWNER_DRAWN
 
 #if wxUSE_OWNER_DRAWN

-  // control items
-  wxListBoxItemsArray m_aItems;
+    // control items
+    wxListBoxItemsArray m_aItems;

 #endif
 
 #endif
 

+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox)

 };
 
 };
 

+#endif // wxUSE_LISTBOX
+

 #endif
     // _WX_LISTBOX_H_
 #endif
     // _WX_LISTBOX_H_