Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / vlbox.h

diff --git a/include/wx/vlbox.h b/include/wx/vlbox.h
index e746c8f863cf893f27b81a4af83e5157b2fcd750..7c55474b1fc8ca62c6c926ede276652243c2f87f 100644 (file)
--- a/include/wx/vlbox.h
+++ b/include/wx/vlbox.h
@@ -16,8 +16,7 @@
 #include "wx/bitmap.h"
 
 class WXDLLIMPEXP_FWD_CORE wxSelectionStore;
 #include "wx/bitmap.h"
 
 class WXDLLIMPEXP_FWD_CORE wxSelectionStore;

-
-#define wxVListBoxNameStr _T("wxVListBox")
+extern WXDLLIMPEXP_DATA_CORE(const char) wxVListBoxNameStr[];

 
 // ----------------------------------------------------------------------------
 // wxVListBox
 
 // ----------------------------------------------------------------------------
 // wxVListBox


@@ -32,7 +31,7 @@ class WXDLLIMPEXP_FWD_CORE wxSelectionStore;
     It emits the same events as wxListBox and the same event macros may be used
     with it.
  */
     It emits the same events as wxListBox and the same event macros may be used
     with it.
  */

-class WXDLLEXPORT wxVListBox : public wxVScrolledWindow
+class WXDLLIMPEXP_CORE wxVListBox : public wxVScrolledWindow

 {
 public:
     // constructors and such
 {
 public:
     // constructors and such


@@ -86,7 +85,7 @@ public:
     int GetSelection() const
     {
         wxASSERT_MSG( !HasMultipleSelection(),
     int GetSelection() const
     {
         wxASSERT_MSG( !HasMultipleSelection(),

-                        _T("GetSelection() can't be used with wxLB_MULTIPLE") );
+                        wxT("GetSelection() can't be used with wxLB_MULTIPLE") );

 
         return m_current;
     }
 
         return m_current;
     }


@@ -127,6 +126,8 @@ public:
     // get the background colour of selected cells
     const wxColour& GetSelectionBackground() const { return m_colBgSel; }
 
     // get the background colour of selected cells
     const wxColour& GetSelectionBackground() const { return m_colBgSel; }
 

+    // get the item rect, returns empty rect if the item is not visible
+    wxRect GetItemRect(size_t n) const;

 
     // operations
     // ----------
 
     // operations
     // ----------


@@ -241,12 +242,14 @@ protected:
     void OnLeftDown(wxMouseEvent& event);
     void OnLeftDClick(wxMouseEvent& event);
     void OnSetOrKillFocus(wxFocusEvent& event);
     void OnLeftDown(wxMouseEvent& event);
     void OnLeftDClick(wxMouseEvent& event);
     void OnSetOrKillFocus(wxFocusEvent& event);

+    void OnSize(wxSizeEvent& event);

 
     // common part of all ctors
     void Init();
 
 
     // common part of all ctors
     void Init();
 

-    // send the wxEVT_COMMAND_LISTBOX_SELECTED event
+    // send the wxEVT_LISTBOX event

     void SendSelectedEvent();
     void SendSelectedEvent();

+    virtual void InitEvent(wxCommandEvent& event, int n);

 
     // common implementation of SelectAll() and DeselectAll()
     bool DoSelectAll(bool select);
 
     // common implementation of SelectAll() and DeselectAll()
     bool DoSelectAll(bool select);


@@ -269,6 +272,14 @@ protected:
     // common part of keyboard and mouse handling processing code
     void DoHandleItemClick(int item, int flags);
 
     // common part of keyboard and mouse handling processing code
     void DoHandleItemClick(int item, int flags);
 

+    // paint the background of the given item using the provided colour if it's
+    // valid, otherwise just return false and do nothing (this is used by
+    // OnDrawBackground())
+    bool DoDrawSolidBackground(const wxColour& col,
+                               wxDC& dc,
+                               const wxRect& rect,
+                               size_t n) const;
+

 private:
     // the current item or wxNOT_FOUND
     //
 private:
     // the current item or wxNOT_FOUND
     //


@@ -293,7 +304,7 @@ private:
     wxColour m_colBgSel;
 
     DECLARE_EVENT_TABLE()
     wxColour m_colBgSel;
 
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxVListBox)
+    wxDECLARE_NO_COPY_CLASS(wxVListBox);

     DECLARE_ABSTRACT_CLASS(wxVListBox)
 };
 
     DECLARE_ABSTRACT_CLASS(wxVListBox)
 };