Bring AddActionTrigger() doc string up to date with the interface

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

diff --git a/include/wx/listbase.h b/include/wx/listbase.h
index ef640effcbcf39a5d9c71558eb167697f50261e5..df07401a0e319f6e8027d64ed7abdef33d9639d8 100644 (file)
--- a/include/wx/listbase.h
+++ b/include/wx/listbase.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        wx/listctrl.h
+// Name:        wx/listbase.h

 // Purpose:     wxListCtrl class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxListCtrl class
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -12,16 +12,9 @@
 #ifndef _WX_LISTBASE_H_BASE_
 #define _WX_LISTBASE_H_BASE_
 
 #ifndef _WX_LISTBASE_H_BASE_
 #define _WX_LISTBASE_H_BASE_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-//    #pragma interface "listctrlbase.h"
-#endif
-
-#if wxUSE_LISTCTRL
-

 #include "wx/colour.h"
 #include "wx/font.h"
 #include "wx/gdicmn.h"
 #include "wx/colour.h"
 #include "wx/font.h"
 #include "wx/gdicmn.h"

-

 #include "wx/event.h"
 
 // ----------------------------------------------------------------------------
 #include "wx/event.h"
 
 // ----------------------------------------------------------------------------


@@ -29,7 +22,8 @@
 // ----------------------------------------------------------------------------
 
 // type of compare function for wxListCtrl sort operation
 // ----------------------------------------------------------------------------
 
 // type of compare function for wxListCtrl sort operation

-typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);
+typedef
+int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, wxIntPtr sortData);

 
 // ----------------------------------------------------------------------------
 // wxListCtrl constants
 
 // ----------------------------------------------------------------------------
 // wxListCtrl constants


@@ -106,6 +100,9 @@ typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortDat
 
 #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
 
 
 #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
 

+// GetSubItemRect constants
+#define wxLIST_GETSUBITEMRECT_WHOLEITEM -1l
+

 // Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
 enum
 {
 // Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
 enum
 {


@@ -162,7 +159,10 @@ enum
 // wxListItemAttr: a structure containing the visual attributes of an item
 // ----------------------------------------------------------------------------
 
 // wxListItemAttr: a structure containing the visual attributes of an item
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListItemAttr
+// TODO: this should be renamed to wxItemAttr or something general like this
+//       and used as base class for wxTextAttr which duplicates this class
+//       entirely currently
+class WXDLLIMPEXP_CORE wxListItemAttr

 {
 public:
     // ctors
 {
 public:
     // ctors


@@ -170,7 +170,12 @@ public:
     wxListItemAttr(const wxColour& colText,
                    const wxColour& colBack,
                    const wxFont& font)
     wxListItemAttr(const wxColour& colText,
                    const wxColour& colBack,
                    const wxFont& font)

-        : m_colText(colText), m_colBack(colBack), m_font(font) { }
+        : m_colText(colText), m_colBack(colBack), m_font(font)
+    {
+    }
+
+    // default copy ctor, assignment operator and dtor are ok
+

 
     // setters
     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 
     // setters
     void SetTextColour(const wxColour& colText) { m_colText = colText; }


@@ -186,6 +191,19 @@ public:
     const wxColour& GetBackgroundColour() const { return m_colBack; }
     const wxFont& GetFont() const { return m_font; }
 
     const wxColour& GetBackgroundColour() const { return m_colBack; }
     const wxFont& GetFont() const { return m_font; }
 

+
+    // this is almost like assignment operator except it doesn't overwrite the
+    // fields unset in the source attribute
+    void AssignFrom(const wxListItemAttr& source)
+    {
+        if ( source.HasTextColour() )
+            SetTextColour(source.GetTextColour());
+        if ( source.HasBackgroundColour() )
+            SetBackgroundColour(source.GetBackgroundColour());
+        if ( source.HasFont() )
+            SetFont(source.GetFont());
+    }
+

 private:
     wxColour m_colText,
              m_colBack;
 private:
     wxColour m_colText,
              m_colBack;


@@ -196,7 +214,7 @@ private:
 // wxListItem: the item or column info, used to exchange data with wxListCtrl
 // ----------------------------------------------------------------------------
 
 // wxListItem: the item or column info, used to exchange data with wxListCtrl
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListItem : public wxObject
+class WXDLLIMPEXP_CORE wxListItem : public wxObject

 {
 public:
     wxListItem() { Init(); m_attr = NULL; }
 {
 public:
     wxListItem() { Init(); m_attr = NULL; }


@@ -215,9 +233,30 @@ public:
           m_attr(NULL)
     {
         // copy list item attributes
           m_attr(NULL)
     {
         // copy list item attributes

-        if( item.HasAttributes() )
+        if ( item.HasAttributes() )

             m_attr = new wxListItemAttr(*item.GetAttributes());
     }
             m_attr = new wxListItemAttr(*item.GetAttributes());
     }

+
+    wxListItem& operator=(const wxListItem& item)
+    {
+        if ( &item != this )
+        {
+            m_mask = item.m_mask;
+            m_itemId = item.m_itemId;
+            m_col = item.m_col;
+            m_state = item.m_state;
+            m_stateMask = item.m_stateMask;
+            m_text = item.m_text;
+            m_image = item.m_image;
+            m_data = item.m_data;
+            m_format = item.m_format;
+            m_width = item.m_width;
+            m_attr = item.m_attr ? new wxListItemAttr(*item.m_attr) : NULL;
+        }
+
+        return *this;
+    }
+

     virtual ~wxListItem() { delete m_attr; }
 
     // resetting
     virtual ~wxListItem() { delete m_attr; }
 
     // resetting


@@ -319,7 +358,7 @@ protected:
         m_col = 0;
         m_state = 0;
         m_stateMask = 0;
         m_col = 0;
         m_state = 0;
         m_stateMask = 0;

-        m_image = 0;
+        m_image = -1;

         m_data = 0;
 
         m_format = wxLIST_FORMAT_CENTRE;
         m_data = 0;
 
         m_format = wxLIST_FORMAT_CENTRE;


@@ -329,9 +368,6 @@ protected:
     wxListItemAttr *m_attr;     // optional pointer to the items style
 
 private:
     wxListItemAttr *m_attr;     // optional pointer to the items style
 
 private:

-    // VZ: this is strange, we have a copy ctor but not operator=(), why?
-    wxListItem& operator=(const wxListItem& item);
-

     DECLARE_DYNAMIC_CLASS(wxListItem)
 };
 
     DECLARE_DYNAMIC_CLASS(wxListItem)
 };
 


@@ -339,15 +375,15 @@ private:
 // wxListEvent - the event class for the wxListCtrl notifications
 // ----------------------------------------------------------------------------
 
 // wxListEvent - the event class for the wxListCtrl notifications
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListEvent : public wxNotifyEvent
+class WXDLLIMPEXP_CORE wxListEvent : public wxNotifyEvent

 {
 public:
     wxListEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
         : wxNotifyEvent(commandType, winid)
 {
 public:
     wxListEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
         : wxNotifyEvent(commandType, winid)

-        , m_code(0)
-        , m_oldItemIndex(0)
-        , m_itemIndex(0)
-        , m_col(0)
+        , m_code(-1)
+        , m_oldItemIndex(-1)
+        , m_itemIndex(-1)
+        , m_col(-1)

         , m_pointDrag()
         , m_item()
         , m_editCancelled(false)
         , m_pointDrag()
         , m_item()
         , m_editCancelled(false)


@@ -371,7 +407,7 @@ public:
     const wxString& GetLabel() const { return m_item.m_text; }
     const wxString& GetText() const { return m_item.m_text; }
     int GetImage() const { return m_item.m_image; }
     const wxString& GetLabel() const { return m_item.m_text; }
     const wxString& GetText() const { return m_item.m_text; }
     int GetImage() const { return m_item.m_image; }

-    long GetData() const { return m_item.m_data; }
+    long GetData() const { return static_cast<long>(m_item.m_data); }

     long GetMask() const { return m_item.m_mask; }
     const wxListItem& GetItem() const { return m_item; }
 
     long GetMask() const { return m_item.m_mask; }
     const wxListItem& GetItem() const { return m_item; }
 


@@ -383,15 +419,6 @@ public:
     bool IsEditCancelled() const { return m_editCancelled; }
     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 
     bool IsEditCancelled() const { return m_editCancelled; }
     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 

-#if WXWIN_COMPATIBILITY_2_2
-    // these methods don't do anything at all
-    long GetOldIndex() const { return 0; }
-    long GetOldItem() const { return 0; }
-
-    // this one is superseded by GetKeyCode()
-    int GetCode() const { return GetKeyCode(); }
-#endif // WXWIN_COMPATIBILITY_2_2
-

     virtual wxEvent *Clone() const { return new wxListEvent(*this); }
 
 //protected: -- not for backwards compatibility
     virtual wxEvent *Clone() const { return new wxListEvent(*this); }
 
 //protected: -- not for backwards compatibility


@@ -414,37 +441,32 @@ private:
 // wxListCtrl event macros
 // ----------------------------------------------------------------------------
 
 // wxListCtrl event macros
 // ----------------------------------------------------------------------------
 

-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG, 700)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG, 701)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, 702)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT, 703)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM, 704)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, 705)
-#if WXWIN_COMPATIBILITY_2_4
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO, 706)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO, 707)
-#endif
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED, 708)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED, 709)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN, 710)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM, 711)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK, 712)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, 713)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 714)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED, 715)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT, 716)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, 717)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, 718)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING, 719)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG, 720)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED, 721)
-END_DECLARE_EVENT_TYPES()
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_BEGIN_DRAG, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_BEGIN_RDRAG, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_END_LABEL_EDIT, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_DELETE_ITEM, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, wxListEvent );
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_ITEM_SELECTED, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_ITEM_DESELECTED, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_KEY_DOWN, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_INSERT_ITEM, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_COL_CLICK, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_ITEM_ACTIVATED, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_CACHE_HINT, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_COL_DRAGGING, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_COL_END_DRAG, wxListEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LIST_ITEM_FOCUSED, wxListEvent );

 
 typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 
 #define wxListEventHandler(func) \
 
 typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 
 #define wxListEventHandler(func) \

-    (wxObjectEventFunction)wxStaticCastEvent(wxListEventFunction, &func)
+    wxEVENT_HANDLER_CAST(wxListEventFunction, func)

 
 #define wx__DECLARE_LISTEVT(evt, id, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_LIST_ ## evt, id, wxListEventHandler(fn))
 
 #define wx__DECLARE_LISTEVT(evt, id, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_LIST_ ## evt, id, wxListEventHandler(fn))


@@ -474,12 +496,5 @@ typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 #define EVT_LIST_CACHE_HINT(id, fn) wx__DECLARE_LISTEVT(CACHE_HINT, id, fn)
 
 
 #define EVT_LIST_CACHE_HINT(id, fn) wx__DECLARE_LISTEVT(CACHE_HINT, id, fn)
 
 

-#if WXWIN_COMPATIBILITY_2_4
-#define EVT_LIST_GET_INFO(id, fn) wx__DECLARE_LISTEVT(GET_INFO, id, fn)
-#define EVT_LIST_SET_INFO(id, fn) wx__DECLARE_LISTEVT(SET_INFO, id, fn)
-#endif
-
-#endif // wxUSE_LISTCTRL
-

 #endif
     // _WX_LISTCTRL_H_BASE_
 #endif
     // _WX_LISTCTRL_H_BASE_