Better markup.

[wxWidgets.git] / include / wx / generic / listctrl.h

diff --git a/include/wx/generic/listctrl.h b/include/wx/generic/listctrl.h
index 5c745a1c819d895d8e05c3417629d6a26d07537d..cd59781dfa6742934d980621ce5ac99bfff0a75b 100644 (file)
--- a/include/wx/generic/listctrl.h
+++ b/include/wx/generic/listctrl.h
@@ -4,14 +4,14 @@
 // Author:      Robert Roebling
 // Created:     01/02/97
 // Id:
 // Author:      Robert Roebling
 // Created:     01/02/97
 // Id:

-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Robert Roebling and Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __LISTCTRLH_G__
 #define __LISTCTRLH_G__
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __LISTCTRLH_G__
 #define __LISTCTRLH_G__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "listctrl.h"
 #endif
 
 #pragma interface "listctrl.h"
 #endif
 


@@ -36,7 +36,13 @@ class WXDLLEXPORT wxDropTarget;
 
 class WXDLLEXPORT wxListItem;
 class WXDLLEXPORT wxListEvent;
 
 class WXDLLEXPORT wxListItem;
 class WXDLLEXPORT wxListEvent;

+
+#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)

 class WXDLLEXPORT wxListCtrl;
 class WXDLLEXPORT wxListCtrl;

+#define wxImageListType wxImageList
+#else
+#define wxImageListType wxGenericImageList
+#endif

 
 //-----------------------------------------------------------------------------
 // internal classes
 
 //-----------------------------------------------------------------------------
 // internal classes


@@ -61,30 +67,31 @@ class WXDLLEXPORT wxGenericListCtrl: public wxControl
 public:
     wxGenericListCtrl();
     wxGenericListCtrl( wxWindow *parent,
 public:
     wxGenericListCtrl();
     wxGenericListCtrl( wxWindow *parent,

-                wxWindowID id = -1,
+                wxWindowID winid = wxID_ANY,

                 const wxPoint &pos = wxDefaultPosition,
                 const wxSize &size = wxDefaultSize,
                 long style = wxLC_ICON,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxPoint &pos = wxDefaultPosition,
                 const wxSize &size = wxDefaultSize,
                 long style = wxLC_ICON,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString &name = "listctrl" )
+                const wxString &name = wxT("listctrl") )

     {
     {

-        Create(parent, id, pos, size, style, validator, name);
+        Create(parent, winid, pos, size, style, validator, name);

     }
     ~wxGenericListCtrl();
 
     bool Create( wxWindow *parent,
     }
     ~wxGenericListCtrl();
 
     bool Create( wxWindow *parent,

-                 wxWindowID id = -1,
+                 wxWindowID winid = wxID_ANY,

                  const wxPoint &pos = wxDefaultPosition,
                  const wxSize &size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,
                  const wxPoint &pos = wxDefaultPosition,
                  const wxSize &size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,

-                 const wxString &name = "listctrl" );
+                 const wxString &name = wxT("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 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

+    wxRect GetViewRect() const;

 
     bool GetItem( wxListItem& info ) const;
     bool SetItem( wxListItem& info ) ;
 
     bool GetItem( wxListItem& info ) const;
     bool SetItem( wxListItem& info ) ;


@@ -101,8 +108,8 @@ public:
     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
     int GetItemCount() const;
     int GetColumnCount() const;
     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
     int GetItemCount() const;
     int GetColumnCount() const;

-    void SetItemSpacing( int spacing, bool isSmall = FALSE );
-    int GetItemSpacing( bool isSmall ) const;
+    void SetItemSpacing( int spacing, bool isSmall = false );
+    wxSize GetItemSpacing() const;

     void SetItemTextColour( long item, const wxColour& col);
     wxColour GetItemTextColour( long item ) const;
     void SetItemBackgroundColour( long item, const wxColour &col);
     void SetItemTextColour( long item, const wxColour& col);
     wxColour GetItemTextColour( long item ) const;
     void SetItemBackgroundColour( long item, const wxColour &col);


@@ -112,13 +119,13 @@ public:
     void SetTextColour(const wxColour& col);
     long GetTopItem() const;
 
     void SetTextColour(const wxColour& col);
     long GetTopItem() const;
 

-    void SetSingleStyle( long style, bool add = TRUE ) ;
+    void SetSingleStyle( long style, bool add = true ) ;

     void SetWindowStyleFlag( long style );
     void RecreateWindow() {}
     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
     void SetWindowStyleFlag( long style );
     void RecreateWindow() {}
     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;

-    wxGenericImageList *GetImageList( int which ) const;
-    void SetImageList( wxGenericImageList *imageList, int which );
-    void AssignImageList( wxGenericImageList *imageList, int which );
+    wxImageListType *GetImageList( int which ) const;
+    void SetImageList( wxImageListType *imageList, int which );
+    void AssignImageList( wxImageListType *imageList, int which );

     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 
     void ClearAll();
     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 
     void ClearAll();


@@ -133,7 +140,7 @@ public:
     void Edit( long item );
 
     bool EnsureVisible( long item );
     void Edit( long item );
 
     bool EnsureVisible( long item );

-    long FindItem( long start, const wxString& str, bool partial = FALSE );
+    long FindItem( long start, const wxString& str, bool partial = false );

     long FindItem( long start, long data );
     long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC
     long HitTest( const wxPoint& point, int& flags);
     long FindItem( long start, long data );
     long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC
     long HitTest( const wxPoint& point, int& flags);


@@ -142,26 +149,47 @@ public:
     long InsertItem( long index, int imageIndex );
     long InsertItem( long index, const wxString& label, int imageIndex );
     long InsertColumn( long col, wxListItem& info );
     long InsertItem( long index, int imageIndex );
     long InsertItem( long index, const wxString& label, int imageIndex );
     long InsertColumn( long col, wxListItem& info );

-    long InsertColumn( long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
-      int width = -1 );
+    long InsertColumn( long col, const wxString& heading,
+                       int format = wxLIST_FORMAT_LEFT, int width = -1 );

     bool ScrollList( int dx, int dy );
     bool SortItems( wxListCtrlCompare fn, long data );
     bool Update( long item );
 
     bool ScrollList( int dx, int dy );
     bool SortItems( wxListCtrlCompare fn, long data );
     bool Update( long item );
 

-    // returns true if it is a virtual list control
-    bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; }
+    // are we in report mode?
+    bool InReportView() const { return HasFlag(wxLC_REPORT); }
+
+    // are we in virtual report mode?
+    bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
+
+    // do we have a header window?
+    bool HasHeader() const
+        { return InReportView() && !HasFlag(wxLC_NO_HEADER); }

 
     // refresh items selectively (only useful for virtual list controls)
     void RefreshItem(long item);
     void RefreshItems(long itemFrom, long itemTo);
 
 
     // refresh items selectively (only useful for virtual list controls)
     void RefreshItem(long item);
     void RefreshItems(long itemFrom, long itemTo);
 

+    // obsolete, don't use
+    wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
+
+
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 

-    void OnIdle( wxIdleEvent &event );
+    void OnInternalIdle( );

     void OnSize( wxSizeEvent &event );
 
     // We have to hand down a few functions
     void OnSize( wxSizeEvent &event );
 
     // We have to hand down a few functions

+    virtual void Refresh(bool eraseBackground = true,
+                         const wxRect *rect = NULL);

 
     virtual void Freeze();
     virtual void Thaw();
 
     virtual void Freeze();
     virtual void Thaw();


@@ -180,19 +208,21 @@ public:
 
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 
 
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 

+    virtual bool ShouldInheritColours() const { return false; }

     virtual void SetFocus();
 
     // implementation
     // --------------
 
     virtual void SetFocus();
 
     // implementation
     // --------------
 

-    wxGenericImageList         *m_imageListNormal;
-    wxGenericImageList         *m_imageListSmall;
-    wxGenericImageList         *m_imageListState;  // what's that ?
+    wxImageListType         *m_imageListNormal;
+    wxImageListType         *m_imageListSmall;
+    wxImageListType         *m_imageListState;  // what's that ?

     bool                 m_ownsImageListNormal,
                          m_ownsImageListSmall,
                          m_ownsImageListState;
     wxListHeaderWindow  *m_headerWin;
     wxListMainWindow    *m_mainWin;
     bool                 m_ownsImageListNormal,
                          m_ownsImageListSmall,
                          m_ownsImageListState;
     wxListHeaderWindow  *m_headerWin;
     wxListMainWindow    *m_mainWin;

+    wxCoord              m_headerHeight;

 
 protected:
     // return the text for the given column of the given item
 
 protected:
     // return the text for the given column of the given item


@@ -214,6 +244,9 @@ private:
     // create the header window
     void CreateHeaderWindow();
 
     // create the header window
     void CreateHeaderWindow();
 

+    // calculate and set height of the header
+    void CalculateAndSetHeaderHeight();
+

     // reposition the header and the main window in the report view depending
     // on whether it should be shown or not
     void ResizeReportView(bool showHeader);
     // reposition the header and the main window in the report view depending
     // on whether it should be shown or not
     void ResizeReportView(bool showHeader);


@@ -222,7 +255,7 @@ private:
     DECLARE_DYNAMIC_CLASS(wxGenericListCtrl);
 };
 
     DECLARE_DYNAMIC_CLASS(wxGenericListCtrl);
 };
 

-#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__)
+#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)

 /*
  * wxListCtrl has to be a real class or we have problems with
  * the run-time information.
 /*
  * wxListCtrl has to be a real class or we have problems with
  * the run-time information.


@@ -235,16 +268,16 @@ class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
 public:
     wxListCtrl() {}
 
 public:
     wxListCtrl() {}
 

-    wxListCtrl(wxWindow *parent, wxWindowID id = -1,
+    wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY,

                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_ICON,
                const wxValidator &validator = wxDefaultValidator,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_ICON,
                const wxValidator &validator = wxDefaultValidator,

-               const wxString &name = "listctrl" )
-    : wxGenericListCtrl(parent, id, pos, size, style, validator, name)
+               const wxString &name = wxT("listctrl") )
+    : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)

     {
     }
 };
     {
     }
 };

-#endif // !__WXMSW__ || __WIN16__ || __WXUNIVERSAL__
+#endif // !__WXMSW__ || __WXUNIVERSAL__

 
 #endif // __LISTCTRLH_G__
 
 #endif // __LISTCTRLH_G__