]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/listctrl.h
wxListCtrl custom drawing seems to work
[wxWidgets.git] / include / wx / generic / listctrl.h
index 5d191352b2abf8285197c1ede7273a9cc6d093b8..cd0ced7b505648d7766ffa2b293cceb7921b4ddd 100644 (file)
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        listctrl.h
+// Name:        wx/generic/listctrl.h
 // Purpose:     Generic list control
 // Author:      Robert Roebling
 // Created:     01/02/97
 // Id:
 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __LISTCTRLH_G__
@@ -51,145 +51,6 @@ class WXDLLEXPORT wxListMainWindow;
 class WXDLLEXPORT wxListRenameTimer;
 class WXDLLEXPORT wxListTextCtrl;
 
-//-----------------------------------------------------------------------------
-// types
-//-----------------------------------------------------------------------------
-
-// type of compare function for wxListCtrl sort operation
-typedef int (*wxListCtrlCompare)(long item1, long item2, long sortData);
-
-//-----------------------------------------------------------------------------
-// wxListCtrl flags
-//-----------------------------------------------------------------------------
-
-#define wxLC_ICON            0x0004
-#define wxLC_SMALL_ICON      0x0008
-#define wxLC_LIST            0x0010
-#define wxLC_REPORT          0x0020
-#define wxLC_ALIGN_TOP       0x0040
-#define wxLC_ALIGN_LEFT      0x0080
-#define wxLC_AUTOARRANGE     0x0100  // not supported in wxGLC
-#define wxLC_USER_TEXT       0x0200  // not supported in wxGLC (how does it work?)
-#define wxLC_EDIT_LABELS     0x0400
-#define wxLC_NO_HEADER       0x0800
-#define wxLC_NO_SORT_HEADER  0x1000  // not supported in wxGLC
-#define wxLC_SINGLE_SEL      0x2000
-#define wxLC_SORT_ASCENDING  0x4000
-#define wxLC_SORT_DESCENDING 0x8000  // not supported in wxGLC
-
-#define wxLC_MASK_TYPE       (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
-#define wxLC_MASK_ALIGN      (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
-#define wxLC_MASK_SORT       (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
-
-// Omitted because (a) too much detail (b) not enough style flags
-// #define wxLC_NO_SCROLL
-// #define wxLC_NO_LABEL_WRAP
-// #define wxLC_OWNERDRAW_FIXED
-// #define wxLC_SHOW_SEL_ALWAYS
-
-// Mask flags to tell app/GUI what fields of wxListItem are valid
-#define wxLIST_MASK_STATE           0x0001
-#define wxLIST_MASK_TEXT            0x0002
-#define wxLIST_MASK_IMAGE           0x0004
-#define wxLIST_MASK_DATA            0x0008
-#define wxLIST_SET_ITEM             0x0010
-#define wxLIST_MASK_WIDTH           0x0020
-#define wxLIST_MASK_FORMAT          0x0040
-
-// State flags for indicating the state of an item
-#define wxLIST_STATE_DONTCARE       0x0000
-#define wxLIST_STATE_DROPHILITED    0x0001  // not supported in wxGLC
-#define wxLIST_STATE_FOCUSED        0x0002
-#define wxLIST_STATE_SELECTED       0x0004
-#define wxLIST_STATE_CUT            0x0008  // not supported in wxGLC
-
-// Hit test flags, used in HitTest // wxGLC suppots 20 and 80
-#define wxLIST_HITTEST_ABOVE            0x0001  // Above the client area.
-#define wxLIST_HITTEST_BELOW            0x0002  // Below the client area.
-#define wxLIST_HITTEST_NOWHERE          0x0004  // In the client area but below the last item.
-#define wxLIST_HITTEST_ONITEMICON       0x0020  // On the bitmap associated with an item.
-#define wxLIST_HITTEST_ONITEMLABEL      0x0080  // On the label (string) associated with an item.
-#define wxLIST_HITTEST_ONITEMRIGHT      0x0100  // In the area to the right of an item.
-#define wxLIST_HITTEST_ONITEMSTATEICON  0x0200  // On the state icon for a tree view item that is in a user-defined state.
-#define wxLIST_HITTEST_TOLEFT           0x0400  // To the right of the client area.
-#define wxLIST_HITTEST_TORIGHT          0x0800  // To the left of the client area.
-
-#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
-
-
-
-// Flags for GetNextItem  // always wxLIST_NEXT_ALL in wxGLC
-enum {
-    wxLIST_NEXT_ABOVE,          // Searches for an item above the specified item
-    wxLIST_NEXT_ALL,            // Searches for subsequent item by index
-    wxLIST_NEXT_BELOW,          // Searches for an item below the specified item
-    wxLIST_NEXT_LEFT,           // Searches for an item to the left of the specified item
-    wxLIST_NEXT_RIGHT           // Searches for an item to the right of the specified item
-};
-
-// Alignment flags for Arrange  // always wxLIST_ALIGN_LEFT in wxGLC
-enum {
-    wxLIST_ALIGN_DEFAULT,
-    wxLIST_ALIGN_LEFT,
-    wxLIST_ALIGN_TOP,
-    wxLIST_ALIGN_SNAP_TO_GRID
-};
-
-// Column format  // always wxLIST_FORMAT_LEFT in wxGLC
-enum {
-    wxLIST_FORMAT_LEFT,
-    wxLIST_FORMAT_RIGHT,
-    wxLIST_FORMAT_CENTRE,
-    wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
-};
-
-// Autosize values for SetColumnWidth
-enum {
-    wxLIST_AUTOSIZE = -1,           // width of longest item
-    wxLIST_AUTOSIZE_USEHEADER = -2  // always 80 in wxGLC
-};
-
-// Flag values for GetItemRect
-enum {
-    wxLIST_RECT_BOUNDS,
-    wxLIST_RECT_ICON,
-    wxLIST_RECT_LABEL
-};
-
-// Flag values for FindItem  // not supported by wxGLC
-enum {
-    wxLIST_FIND_UP,
-    wxLIST_FIND_DOWN,
-    wxLIST_FIND_LEFT,
-    wxLIST_FIND_RIGHT
-};
-
-//-----------------------------------------------------------------------------
-// wxListItem
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListItem: public wxObject
-{
-  DECLARE_DYNAMIC_CLASS(wxListItem)
-
-  public:
-    long            m_mask;     // Indicates what fields are valid
-    long            m_itemId;   // The zero-based item position
-    int             m_col;      // Zero-based column, if in report mode
-    long            m_state;    // The state of the item
-    long            m_stateMask; // Which flags of m_state are valid (uses same flags)
-    wxString        m_text;     // The label/header text
-    int             m_image;    // The zero-based index into an image list
-    long            m_data;     // App-defined data
-    wxColour       *m_colour;   // only wxGLC, not supported by Windows ;->
-
-    // For columns only
-    int             m_format;   // left, right, centre
-    int             m_width;    // width of column
-
-    wxListItem();
-};
-
 //-----------------------------------------------------------------------------
 //  wxListItemData (internal)
 //-----------------------------------------------------------------------------
@@ -236,9 +97,7 @@ private:
 
 class WXDLLEXPORT wxListHeaderData : public wxObject
 {
-  DECLARE_DYNAMIC_CLASS(wxListHeaderData);
-
-  protected:
+protected:
     long      m_mask;
     int       m_image;
     wxString  m_text;
@@ -247,7 +106,7 @@ class WXDLLEXPORT wxListHeaderData : public wxObject
     int       m_xpos,m_ypos;
     int       m_height;
 
-  public:
+public:
     wxListHeaderData();
     wxListHeaderData( const wxListItem &info );
     void SetItem( const wxListItem &item );
@@ -263,6 +122,9 @@ class WXDLLEXPORT wxListHeaderData : public wxObject
     int GetImage() const;
     int GetWidth() const;
     int GetFormat() const;
+    
+private:
+    DECLARE_DYNAMIC_CLASS(wxListHeaderData);
 };
 
 //-----------------------------------------------------------------------------
@@ -271,9 +133,7 @@ class WXDLLEXPORT wxListHeaderData : public wxObject
 
 class WXDLLEXPORT wxListLineData : public wxObject
 {
-  DECLARE_DYNAMIC_CLASS(wxListLineData);
-
-  public:
+public:
     wxList              m_items;
     wxRect              m_bound_all;
     wxRect              m_bound_label;
@@ -287,8 +147,8 @@ class WXDLLEXPORT wxListLineData : public wxObject
 
     void DoDraw( wxDC *dc, bool hilight, bool paintBG );
 
-  public:
-    wxListLineData() {};
+public:
+    wxListLineData() {}
     wxListLineData( wxListMainWindow *owner, int mode, wxBrush *hilightBrush );
     void CalculateSize( wxDC *dc, int spacing );
     void SetPosition( wxDC *dc, int x, int y,  int window_width );
@@ -312,6 +172,9 @@ class WXDLLEXPORT wxListLineData : public wxObject
     bool IsHilighted();
     void AssignRect( wxRect &dest, int x, int y, int width, int height );
     void AssignRect( wxRect &dest, const wxRect &source );
+    
+private:
+    DECLARE_DYNAMIC_CLASS(wxListLineData);
 };
 
 //-----------------------------------------------------------------------------
@@ -320,9 +183,7 @@ class WXDLLEXPORT wxListLineData : public wxObject
 
 class WXDLLEXPORT wxListHeaderWindow : public wxWindow
 {
-  DECLARE_DYNAMIC_CLASS(wxListHeaderWindow)
-
-  protected:
+protected:
     wxListMainWindow  *m_owner;
     wxCursor          *m_currentCursor;
     wxCursor          *m_resizeCursor;
@@ -331,7 +192,7 @@ class WXDLLEXPORT wxListHeaderWindow : public wxWindow
     int                m_minX;
     int                m_currentX;
 
-  public:
+public:
     wxListHeaderWindow();
     ~wxListHeaderWindow();
     wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner,
@@ -343,7 +204,9 @@ class WXDLLEXPORT wxListHeaderWindow : public wxWindow
     void OnMouse( wxMouseEvent &event );
     void OnSetFocus( wxFocusEvent &event );
 
-  DECLARE_EVENT_TABLE()
+private:
+    DECLARE_DYNAMIC_CLASS(wxListHeaderWindow)
+    DECLARE_EVENT_TABLE()
 };
 
 //-----------------------------------------------------------------------------
@@ -352,12 +215,12 @@ class WXDLLEXPORT wxListHeaderWindow : public wxWindow
 
 class WXDLLEXPORT wxListRenameTimer: public wxTimer
 {
- private:
-   wxListMainWindow   *m_owner;
+private:
+    wxListMainWindow   *m_owner;
 
- public:
-   wxListRenameTimer( wxListMainWindow *owner );
-   void Notify();
+public:
+    wxListRenameTimer( wxListMainWindow *owner );
+    void Notify();
 };
 
 //-----------------------------------------------------------------------------
@@ -366,16 +229,14 @@ class WXDLLEXPORT wxListRenameTimer: public wxTimer
 
 class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl
 {
-  DECLARE_DYNAMIC_CLASS(wxListTextCtrl);
-
-  private:
+private:
     bool               *m_accept;
     wxString           *m_res;
     wxListMainWindow   *m_owner;
     wxString            m_startValue;
 
-  public:
-    wxListTextCtrl() {};
+public:
+    wxListTextCtrl() {}
     wxListTextCtrl( wxWindow *parent, const wxWindowID id,
                     bool *accept, wxString *res, wxListMainWindow *owner,
                     const wxString &value = "",
@@ -387,7 +248,9 @@ class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl
     void OnChar( wxKeyEvent &event );
     void OnKillFocus( wxFocusEvent &event );
 
-  DECLARE_EVENT_TABLE()
+private:
+    DECLARE_DYNAMIC_CLASS(wxListTextCtrl);
+    DECLARE_EVENT_TABLE()
 };
 
 //-----------------------------------------------------------------------------
@@ -396,9 +259,7 @@ class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl
 
 class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
 {
-  DECLARE_DYNAMIC_CLASS(wxListMainWindow);
-
-  public:
+public:
     long                 m_mode;
     wxList               m_lines;
     wxList               m_columns;
@@ -423,7 +284,7 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
     int                  m_dragCount;
     wxPoint              m_dragStart;
 
-  public:
+public:
     wxListMainWindow();
     wxListMainWindow( wxWindow *parent, wxWindowID id,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
@@ -495,7 +356,9 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
 //    void AddColumn( wxListItem &item );
     void SortItems( wxListCtrlCompare fn, long data );
 
-  DECLARE_EVENT_TABLE()
+private:
+    DECLARE_DYNAMIC_CLASS(wxListMainWindow);
+    DECLARE_EVENT_TABLE()
 };
 
 //-----------------------------------------------------------------------------
@@ -504,9 +367,7 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
 
 class WXDLLEXPORT wxListCtrl: public wxControl
 {
-  DECLARE_DYNAMIC_CLASS(wxListCtrl);
-
-  public:
+public:
     wxListCtrl();
     wxListCtrl( wxWindow *parent, wxWindowID id = -1,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
@@ -515,21 +376,23 @@ class WXDLLEXPORT wxListCtrl: public wxControl
 #endif
        const wxString &name = "listctrl" )
     {
-      Create(parent, id, pos, size, style, validator, name);
+        Create(parent, id, pos, size, style, validator, name);
     }
     ~wxListCtrl();
+    
     bool Create( wxWindow *parent, wxWindowID id = -1,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 #if wxUSE_VALIDATORS
       long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
 #endif
-       const wxString &name = "listctrl" );
-    void OnSize( wxSizeEvent &event );
+      const wxString &name = "listctrl" );
+
     bool GetColumn( int col, wxListItem& item ) const;
     bool SetColumn( int col, wxListItem& item );
     int GetColumnWidth( int col ) const;
     bool SetColumnWidth( int col, int width);
     int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think
+
     bool GetItem( wxListItem& info ) const;
     bool SetItem( wxListItem& info ) ;
     long SetItem( long index, int col, const wxString& label, int imageId = -1 );
@@ -551,6 +414,7 @@ class WXDLLEXPORT wxListCtrl: public wxControl
 //  wxColour GetTextColour() const; // wxGLC has colours for every Item (see wxListItem)
 //  void SetTextColour(const wxColour& col);
     long GetTopItem() const;
+
     void SetSingleStyle( long style, bool add = TRUE ) ;
     void SetWindowStyleFlag( long style );
     void RecreateWindow() {}
@@ -583,7 +447,9 @@ class WXDLLEXPORT wxListCtrl: public wxControl
     bool ScrollList( int dx, int dy );
     bool SortItems( wxListCtrlCompare fn, long data );
     bool Update( long item );
+    
     void OnIdle( wxIdleEvent &event );
+    void OnSize( wxSizeEvent &event );
 
     // We have to hand down a few functions
 
@@ -607,9 +473,15 @@ class WXDLLEXPORT wxListCtrl: public wxControl
     bool DoPopupMenu( wxMenu *menu, int x, int y )
       { return m_mainWin->PopupMenu( menu, x, y ); }
     void SetFocus()
-      { m_mainWin->SetFocus(); }
+      {
+          /* The test in window.cpp fails as we are a composite
+             window, so it checks against "this", but not m_mainWin. */
+          if (FindFocus() != this)
+              m_mainWin->SetFocus();
+      }
 
-  // implementation
+    // implementation
+    // --------------
 
     wxImageList         *m_imageListNormal;
     wxImageList         *m_imageListSmall;
@@ -617,8 +489,9 @@ class WXDLLEXPORT wxListCtrl: public wxControl
     wxListHeaderWindow  *m_headerWin;
     wxListMainWindow    *m_mainWin;
 
-  DECLARE_EVENT_TABLE()
-
+private:
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxListCtrl);
 };