]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/listctrl.h
don't select first hit in index if it is multi-topic entry, it causes a dialog to...
[wxWidgets.git] / include / wx / generic / listctrl.h
index cd0ced7b505648d7766ffa2b293cceb7921b4ddd..cd59781dfa6742934d980621ce5ac99bfff0a75b 100644 (file)
@@ -4,26 +4,27 @@
 // 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__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "listctrl.h"
 #endif
 
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/generic/imaglist.h"
+
 #include "wx/control.h"
 #include "wx/timer.h"
-#include "wx/textctrl.h"
 #include "wx/dcclient.h"
 #include "wx/scrolwin.h"
 #include "wx/settings.h"
+#include "wx/listbase.h"
 
 #if wxUSE_DRAG_AND_DROP
 class WXDLLEXPORT wxDropTarget;
@@ -35,7 +36,13 @@ class WXDLLEXPORT wxDropTarget;
 
 class WXDLLEXPORT wxListItem;
 class WXDLLEXPORT wxListEvent;
+
+#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
 class WXDLLEXPORT wxListCtrl;
+#define wxImageListType wxImageList
+#else
+#define wxImageListType wxGenericImageList
+#endif
 
 //-----------------------------------------------------------------------------
 // internal classes
@@ -51,347 +58,40 @@ class WXDLLEXPORT wxListMainWindow;
 class WXDLLEXPORT wxListRenameTimer;
 class WXDLLEXPORT wxListTextCtrl;
 
-//-----------------------------------------------------------------------------
-//  wxListItemData (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListItemData : public wxObject
-{
-public:
-    wxString   m_text;
-    int        m_image;
-    long       m_data;
-    int        m_xpos,m_ypos;
-    int        m_width,m_height;
-    wxColour   *m_colour;
-
-public:
-    wxListItemData();
-    wxListItemData( const wxListItem &info );
-    void SetItem( const wxListItem &info );
-    void SetText( const wxString &s );
-    void SetImage( int image );
-    void SetData( long data );
-    void SetPosition( int x, int y );
-    void SetSize( int width, int height );
-    void SetColour( wxColour *col );
-    bool HasImage() const;
-    bool HasText() const;
-    bool IsHit( int x, int y ) const;
-    void GetText( wxString &s );
-    int GetX( void ) const;
-    int GetY( void ) const;
-    int GetWidth() const;
-    int GetHeight() const;
-    int GetImage() const;
-    void GetItem( wxListItem &info );
-    wxColour *GetColour();
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxListItemData);
-};
-
-//-----------------------------------------------------------------------------
-//  wxListHeaderData (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListHeaderData : public wxObject
-{
-protected:
-    long      m_mask;
-    int       m_image;
-    wxString  m_text;
-    int       m_format;
-    int       m_width;
-    int       m_xpos,m_ypos;
-    int       m_height;
-
-public:
-    wxListHeaderData();
-    wxListHeaderData( const wxListItem &info );
-    void SetItem( const wxListItem &item );
-    void SetPosition( int x, int y );
-    void SetWidth( int w );
-    void SetFormat( int format );
-    void SetHeight( int h );
-    bool HasImage() const;
-    bool HasText() const;
-    bool IsHit( int x, int y ) const;
-    void GetItem( wxListItem &item );
-    void GetText( wxString &s );
-    int GetImage() const;
-    int GetWidth() const;
-    int GetFormat() const;
-    
-private:
-    DECLARE_DYNAMIC_CLASS(wxListHeaderData);
-};
-
-//-----------------------------------------------------------------------------
-//  wxListLineData (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListLineData : public wxObject
-{
-public:
-    wxList              m_items;
-    wxRect              m_bound_all;
-    wxRect              m_bound_label;
-    wxRect              m_bound_icon;
-    wxRect              m_bound_hilight;
-    int                 m_mode;
-    bool                m_hilighted;
-    wxBrush            *m_hilightBrush;
-    int                 m_spacing;
-    wxListMainWindow   *m_owner;
-
-    void DoDraw( wxDC *dc, bool hilight, bool paintBG );
-
-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 );
-    void SetColumnPosition( int index, int x );
-    void GetSize( int &width, int &height );
-    void GetExtent( int &x, int &y, int &width, int &height );
-    void GetLabelExtent( int &x, int &y, int &width, int &height );
-    long IsHit( int x, int y );
-    void InitItems( int num );
-    void SetItem( int index, const wxListItem &info );
-    void GetItem( int index, wxListItem &info );
-    void GetText( int index, wxString &s );
-    void SetText( int index, const wxString s );
-    int GetImage( int index );
-    void GetRect( wxRect &rect );
-    void Hilight( bool on );
-    void ReverseHilight();
-    void DrawRubberBand( wxDC *dc, bool on );
-    void Draw( wxDC *dc );
-    bool IsInRect( int x, int y, const wxRect &rect );
-    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);
-};
-
-//-----------------------------------------------------------------------------
-//  wxListHeaderWindow (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListHeaderWindow : public wxWindow
-{
-protected:
-    wxListMainWindow  *m_owner;
-    wxCursor          *m_currentCursor;
-    wxCursor          *m_resizeCursor;
-    bool               m_isDragging;
-    int                m_column;
-    int                m_minX;
-    int                m_currentX;
-
-public:
-    wxListHeaderWindow();
-    ~wxListHeaderWindow();
-    wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner,
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      long style = 0, const wxString &name = "columntitles" );
-    void DoDrawRect( wxDC *dc, int x, int y, int w, int h );
-    void OnPaint( wxPaintEvent &event );
-    void DrawCurrent();
-    void OnMouse( wxMouseEvent &event );
-    void OnSetFocus( wxFocusEvent &event );
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxListHeaderWindow)
-    DECLARE_EVENT_TABLE()
-};
-
-//-----------------------------------------------------------------------------
-// wxListRenameTimer (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListRenameTimer: public wxTimer
-{
-private:
-    wxListMainWindow   *m_owner;
-
-public:
-    wxListRenameTimer( wxListMainWindow *owner );
-    void Notify();
-};
-
-//-----------------------------------------------------------------------------
-//  wxListTextCtrl (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl
-{
-private:
-    bool               *m_accept;
-    wxString           *m_res;
-    wxListMainWindow   *m_owner;
-    wxString            m_startValue;
-
-public:
-    wxListTextCtrl() {}
-    wxListTextCtrl( wxWindow *parent, const wxWindowID id,
-                    bool *accept, wxString *res, wxListMainWindow *owner,
-                    const wxString &value = "",
-                    const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-#if wxUSE_VALIDATORS
-                    int style = 0, const wxValidator& validator = wxDefaultValidator,
-#endif
-                    const wxString &name = "wxListTextCtrlText" );
-    void OnChar( wxKeyEvent &event );
-    void OnKillFocus( wxFocusEvent &event );
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxListTextCtrl);
-    DECLARE_EVENT_TABLE()
-};
-
-//-----------------------------------------------------------------------------
-//  wxListMainWindow (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
-{
-public:
-    long                 m_mode;
-    wxList               m_lines;
-    wxList               m_columns;
-    wxListLineData      *m_current;
-    wxListLineData      *m_currentEdit;
-    int                  m_visibleLines;
-    wxBrush             *m_hilightBrush;
-    wxColour            *m_hilightColour;
-    int                  m_xScroll,m_yScroll;
-    bool                 m_dirty;
-    wxImageList         *m_small_image_list;
-    wxImageList         *m_normal_image_list;
-    int                  m_small_spacing;
-    int                  m_normal_spacing;
-    bool                 m_hasFocus;
-    bool                 m_usedKeys;
-    bool                 m_lastOnSame;
-    wxTimer             *m_renameTimer;
-    bool                 m_renameAccept;
-    wxString             m_renameRes;
-    bool                 m_isCreated;
-    int                  m_dragCount;
-    wxPoint              m_dragStart;
-
-public:
-    wxListMainWindow();
-    wxListMainWindow( wxWindow *parent, wxWindowID id,
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      long style = 0, const wxString &name = "listctrl" );
-    ~wxListMainWindow();
-    void RefreshLine( wxListLineData *line );
-    void OnPaint( wxPaintEvent &event );
-    void HilightAll( bool on );
-    void SendNotify( wxListLineData *line, wxEventType command );
-    void FocusLine( wxListLineData *line );
-    void UnfocusLine( wxListLineData *line );
-    void SelectLine( wxListLineData *line );
-    void DeselectLine( wxListLineData *line );
-    void DeleteLine( wxListLineData *line );
-
-    void EditLabel( long item );
-    void Edit( long item ) { EditLabel(item); }         // deprecated
-    void OnRenameTimer();
-    void OnRenameAccept();
-
-    void OnMouse( wxMouseEvent &event );
-    void MoveToFocus();
-    void OnArrowChar( wxListLineData *newCurrent, bool shiftDown );
-    void OnChar( wxKeyEvent &event );
-    void OnKeyDown( wxKeyEvent &event );
-    void OnSetFocus( wxFocusEvent &event );
-    void OnKillFocus( wxFocusEvent &event );
-    void OnSize( wxSizeEvent &event );
-       void OnScroll(wxScrollWinEvent& event) ;
-       
-    void DrawImage( int index, wxDC *dc, int x, int y );
-    void GetImageSize( int index, int &width, int &height );
-    int GetIndexOfLine( const wxListLineData *line );
-    int GetTextLength( wxString &s );  // should be const
-
-    void SetImageList( wxImageList *imageList, int which );
-    void SetItemSpacing( int spacing, bool isSmall = FALSE );
-    int GetItemSpacing( bool isSmall = FALSE );
-    void SetColumn( int col, wxListItem &item );
-    void SetColumnWidth( int col, int width );
-    void GetColumn( int col, wxListItem &item );
-    int GetColumnWidth( int vol );
-    int GetColumnCount();
-    int GetCountPerPage();
-    void SetItem( wxListItem &item );
-    void GetItem( wxListItem &item );
-    void SetItemState( long item, long state, long stateMask );
-    int GetItemState( long item, long stateMask );
-    int GetItemCount();
-    void GetItemRect( long index, wxRect &rect );
-    bool GetItemPosition( long item, wxPoint& pos );
-    int GetSelectedItemCount();
-    void SetMode( long mode );
-    long GetMode() const;
-    void CalculatePositions();
-    void RealizeChanges();
-    long GetNextItem( long item, int geometry, int state );
-    void DeleteItem( long index );
-    void DeleteAllItems();
-    void DeleteColumn( int col );
-    void DeleteEverything();
-    void EnsureVisible( long index );
-    long FindItem( long start, const wxString& str, bool partial = FALSE );
-    long FindItem( long start, long data);
-    long HitTest( int x, int y, int &flags );
-    void InsertItem( wxListItem &item );
-//    void AddItem( wxListItem &item );
-    void InsertColumn( long col, wxListItem &item );
-//    void AddColumn( wxListItem &item );
-    void SortItems( wxListCtrlCompare fn, long data );
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxListMainWindow);
-    DECLARE_EVENT_TABLE()
-};
-
 //-----------------------------------------------------------------------------
 // wxListCtrl
 //-----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxListCtrl: public wxControl
+class WXDLLEXPORT wxGenericListCtrl: public wxControl
 {
 public:
-    wxListCtrl();
-    wxListCtrl( 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" )
+    wxGenericListCtrl();
+    wxGenericListCtrl( wxWindow *parent,
+                wxWindowID winid = wxID_ANY,
+                const wxPoint &pos = wxDefaultPosition,
+                const wxSize &size = wxDefaultSize,
+                long style = wxLC_ICON,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString &name = wxT("listctrl") )
     {
-        Create(parent, id, pos, size, style, validator, name);
+        Create(parent, winid, 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" );
+    ~wxGenericListCtrl();
+
+    bool Create( wxWindow *parent,
+                 wxWindowID winid = wxID_ANY,
+                 const wxPoint &pos = wxDefaultPosition,
+                 const wxSize &size = wxDefaultSize,
+                 long style = wxLC_ICON,
+                 const wxValidator& validator = wxDefaultValidator,
+                 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
+    wxRect GetViewRect() const;
 
     bool GetItem( wxListItem& info ) const;
     bool SetItem( wxListItem& info ) ;
@@ -408,19 +108,24 @@ public:
     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);
+    wxColour GetItemBackgroundColour( long item ) const;
     int GetSelectedItemCount() const;
-//  wxColour GetTextColour() const; // wxGLC has colours for every Item (see wxListItem)
-//  void SetTextColour(const wxColour& col);
+    wxColour GetTextColour() 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;
-    wxImageList *GetImageList( int which ) const;
-    void SetImageList( wxImageList *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();
@@ -429,11 +134,13 @@ public:
     bool DeleteAllColumns();
     bool DeleteColumn( int col );
 
+    void SetItemCount(long count);
+
     void EditLabel( long item ) { Edit(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);
@@ -442,57 +149,135 @@ public:
     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 );
-    
-    void OnIdle( wxIdleEvent &event );
+
+    // 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);
+
+    // 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
+    // -------------------------------
+
+    void OnInternalIdle( );
     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();
 
-    bool SetBackgroundColour( const wxColour &colour );
-    bool SetForegroundColour( const wxColour &colour );
-    bool SetFont( const wxFont &font );
+    virtual bool SetBackgroundColour( const wxColour &colour );
+    virtual bool SetForegroundColour( const wxColour &colour );
+    virtual wxColour GetBackgroundColour() const;
+    virtual wxColour GetForegroundColour() const;
+    virtual bool SetFont( const wxFont &font );
+    virtual bool SetCursor( const wxCursor &cursor );
 
 #if wxUSE_DRAG_AND_DROP
-    void SetDropTarget( wxDropTarget *dropTarget )
-      { m_mainWin->SetDropTarget( dropTarget ); }
-    wxDropTarget *GetDropTarget() const
-      { return m_mainWin->GetDropTarget(); }
+    virtual void SetDropTarget( wxDropTarget *dropTarget );
+    virtual wxDropTarget *GetDropTarget() const;
 #endif
 
-    bool SetCursor( const wxCursor &cursor )
-      { return m_mainWin ? m_mainWin->wxWindow::SetCursor(cursor) : FALSE; }
-    wxColour GetBackgroundColour() const
-      { return m_mainWin ? m_mainWin->GetBackgroundColour() : wxColour(); }
-    wxColour GetForegroundColour() const
-      { return m_mainWin ? m_mainWin->GetForegroundColour() : wxColour(); }
-    bool DoPopupMenu( wxMenu *menu, int x, int y )
-      { return m_mainWin->PopupMenu( menu, x, y ); }
-    void 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();
-      }
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+
+    virtual bool ShouldInheritColours() const { return false; }
+    virtual void SetFocus();
 
     // implementation
     // --------------
 
-    wxImageList         *m_imageListNormal;
-    wxImageList         *m_imageListSmall;
-    wxImageList         *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;
+    wxCoord              m_headerHeight;
+
+protected:
+    // return the text for the given column of the given item
+    virtual wxString OnGetItemText(long item, long column) const;
+
+    // return the icon for the given item
+    virtual int OnGetItemImage(long item) const;
+
+    // return the attribute for the item (may return NULL if none)
+    virtual wxListItemAttr *OnGetItemAttr(long item) const;
+
+    // it calls our OnGetXXX() functions
+    friend class WXDLLEXPORT wxListMainWindow;
 
 private:
+    // Virtual function hiding supression
+    virtual void Update() { wxWindow::Update(); }
+
+    // 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);
+
     DECLARE_EVENT_TABLE()
-    DECLARE_DYNAMIC_CLASS(wxListCtrl);
+    DECLARE_DYNAMIC_CLASS(wxGenericListCtrl);
 };
 
+#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
+/*
+ * wxListCtrl has to be a real class or we have problems with
+ * the run-time information.
+ */
+
+class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
+{
+    DECLARE_DYNAMIC_CLASS(wxListCtrl)
+
+public:
+    wxListCtrl() {}
+
+    wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = wxLC_ICON,
+               const wxValidator &validator = wxDefaultValidator,
+               const wxString &name = wxT("listctrl") )
+    : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
+    {
+    }
+};
+#endif // !__WXMSW__ || __WXUNIVERSAL__
 
 #endif // __LISTCTRLH_G__