]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/listctrl.h
Changed HWND --> WXHWND in tooltip.h so it can be included in files
[wxWidgets.git] / include / wx / generic / listctrl.h
index c18b4a781f96f1e6ed9986059f4c9fb027405c95..32f7e7098d065dadc246f6d439c752a655dfeff7 100644 (file)
@@ -49,7 +49,7 @@ class WXDLLEXPORT wxListHeaderWindow;
 class WXDLLEXPORT wxListMainWindow;
 
 class WXDLLEXPORT wxListRenameTimer;
-//class wxListTextCtrl;
+class WXDLLEXPORT wxListTextCtrl;
 
 //-----------------------------------------------------------------------------
 // types
@@ -71,7 +71,7 @@ typedef int (*wxListCtrlCompare)(long item1, long item2, long sortData);
 #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  // not supported in wxGLC
+#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
@@ -145,8 +145,8 @@ enum {
 
 // Autosize values for SetColumnWidth
 enum {
-    wxLIST_AUTOSIZE = -1,          // always 80 in wxGLC (what else?)
-    wxLIST_AUTOSIZE_USEHEADER = -2
+    wxLIST_AUTOSIZE = -1,           // width of longest item
+    wxLIST_AUTOSIZE_USEHEADER = -2  // always 80 in wxGLC
 };
 
 // Flag values for GetItemRect
@@ -187,58 +187,16 @@ class WXDLLEXPORT wxListItem: public wxObject
     int             m_format;   // left, right, centre
     int             m_width;    // width of column
 
-    wxListItem(void);
+    wxListItem();
 };
 
-//-----------------------------------------------------------------------------
-// wxListEvent
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListEvent: public wxNotifyEvent
-{
-  DECLARE_DYNAMIC_CLASS(wxListEvent)
-
- public:
-  wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
-
-  int           m_code;
-  long          m_itemIndex;
-  long          m_oldItemIndex;
-  int           m_col;
-  bool          m_cancelled;
-  wxPoint       m_pointDrag;
-
-  wxListItem    m_item;
-};
-
-typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
-
-#define EVT_LIST_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_DELETE_ITEM(id, fn) { wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) { wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_GET_INFO(id, fn) { wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_SET_INFO(id, fn) { wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_ITEM_SELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_ITEM_DESELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_KEY_DOWN(id, fn) { wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_INSERT_ITEM(id, fn) { wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_COL_CLICK(id, fn) { wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) { wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-#define EVT_LIST_ITEM_ACTIVATED(id, fn) { wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
-
 //-----------------------------------------------------------------------------
 //  wxListItemData (internal)
 //-----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxListItemData : public wxObject
 {
-  DECLARE_DYNAMIC_CLASS(wxListItemData);
-
-  public:
+public:
     wxString   m_text;
     int        m_image;
     long       m_data;
@@ -246,8 +204,8 @@ class WXDLLEXPORT wxListItemData : public wxObject
     int        m_width,m_height;
     wxColour   *m_colour;
 
-  public:
-    wxListItemData(void);
+public:
+    wxListItemData();
     wxListItemData( const wxListItem &info );
     void SetItem( const wxListItem &info );
     void SetText( const wxString &s );
@@ -256,17 +214,20 @@ class WXDLLEXPORT wxListItemData : public wxObject
     void SetPosition( int x, int y );
     void SetSize( int width, int height );
     void SetColour( wxColour *col );
-    bool HasImage(void) const;
-    bool HasText(void) const;
+    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(void) const;
-    int GetHeight(void) const;
-    int GetImage(void) const;
+    int GetWidth() const;
+    int GetHeight() const;
+    int GetImage() const;
     void GetItem( wxListItem &info );
-    wxColour *GetColour(void);
+    wxColour *GetColour();
+    
+private:
+    DECLARE_DYNAMIC_CLASS(wxListItemData);
 };
 
 //-----------------------------------------------------------------------------
@@ -287,21 +248,21 @@ class WXDLLEXPORT wxListHeaderData : public wxObject
     int       m_height;
 
   public:
-    wxListHeaderData(void);
+    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(void) const;
-    bool HasText(void) const;
+    bool HasImage() const;
+    bool HasText() const;
     bool IsHit( int x, int y ) const;
     void GetItem( wxListItem &item );
     void GetText( wxString &s );
-    int GetImage(void) const;
-    int GetWidth(void) const;
-    int GetFormat(void) const;
+    int GetImage() const;
+    int GetWidth() const;
+    int GetFormat() const;
 };
 
 //-----------------------------------------------------------------------------
@@ -314,10 +275,10 @@ 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;
+    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;
@@ -327,7 +288,7 @@ class WXDLLEXPORT wxListLineData : public wxObject
     void DoDraw( wxDC *dc, bool hilight, bool paintBG );
 
   public:
-    wxListLineData( void ) {};
+    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 );
@@ -344,11 +305,11 @@ class WXDLLEXPORT wxListLineData : public wxObject
     int GetImage( int index );
     void GetRect( wxRect &rect );
     void Hilight( bool on );
-    void ReverseHilight( void );
+    void ReverseHilight();
     void DrawRubberBand( wxDC *dc, bool on );
     void Draw( wxDC *dc );
     bool IsInRect( int x, int y, const wxRect &rect );
-    bool IsHilighted( void );
+    bool IsHilighted();
     void AssignRect( wxRect &dest, int x, int y, int width, int height );
     void AssignRect( wxRect &dest, const wxRect &source );
 };
@@ -365,14 +326,14 @@ class WXDLLEXPORT wxListHeaderWindow : public wxWindow
     wxListMainWindow  *m_owner;
     wxCursor          *m_currentCursor;
     wxCursor          *m_resizeCursor;
-    bool               m_isDraging;
+    bool               m_isDragging;
     int                m_column;
     int                m_minX;
     int                m_currentX;
 
   public:
-    wxListHeaderWindow( void );
-    ~wxListHeaderWindow( void );
+    wxListHeaderWindow();
+    ~wxListHeaderWindow();
     wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
       long style = 0, const wxString &name = "columntitles" );
@@ -411,9 +372,10 @@ class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl
     bool               *m_accept;
     wxString           *m_res;
     wxListMainWindow   *m_owner;
+    wxString            m_startValue;
 
   public:
-    wxListTextCtrl(void) {};
+    wxListTextCtrl() {};
     wxListTextCtrl( wxWindow *parent, const wxWindowID id, 
                     bool *accept, wxString *res, wxListMainWindow *owner,
                     const wxString &value = "",
@@ -439,6 +401,7 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
     wxList               m_lines;
     wxList               m_columns;
     wxListLineData      *m_current;
+    wxListLineData      *m_currentEdit;
     int                  m_visibleLines;
     wxBrush             *m_hilightBrush;
     wxColour            *m_hilightColour;
@@ -452,18 +415,18 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
     bool                 m_usedKeys;
     bool                 m_lastOnSame;
     wxTimer             *m_renameTimer;
-//  wxListTextCtrl      *m_text;
     bool                 m_renameAccept;
     wxString             m_renameRes;
     bool                 m_isCreated;
     int                  m_dragCount;
+    wxPoint              m_dragStart;
 
   public:
-    wxListMainWindow(void);
+    wxListMainWindow();
     wxListMainWindow( wxWindow *parent, wxWindowID id,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
       long style = 0, const wxString &name = "listctrl" );
-    ~wxListMainWindow(void);
+    ~wxListMainWindow();
     void RefreshLine( wxListLineData *line );
     void OnPaint( wxPaintEvent &event );
     void HilightAll( bool on );
@@ -473,17 +436,21 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
     void SelectLine( wxListLineData *line );
     void DeselectLine( wxListLineData *line );
     void DeleteLine( wxListLineData *line );
-    void RenameLine( wxListLineData *line, const wxString &newName );
-    void StartLabelEdit( wxListLineData *line );
-    void OnRenameTimer(void);
-    void OnRenameAccept(void);
+    
+    void EditLabel( long item );
+    void Edit( long item ) { EditLabel(item); }         // deprecated
+    void OnRenameTimer();
+    void OnRenameAccept();
+    
     void OnMouse( wxMouseEvent &event );
-    void MoveToFocus( void );
+    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 DrawImage( int index, wxDC *dc, int x, int y );
     void GetImageSize( int index, int &width, int &height );
     int GetIndexOfLine( const wxListLineData *line );
@@ -496,28 +463,28 @@ class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
     void SetColumnWidth( int col, int width );
     void GetColumn( int col, wxListItem &item );
     int GetColumnWidth( int vol );
-    int GetColumnCount( void );
-    int GetCountPerPage( void );
+    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 );
+    int GetItemCount();
     void GetItemRect( long index, wxRect &rect );
-    bool GetItemPosition(long item, wxPoint& pos);
-    int GetSelectedItemCount( void );
+    bool GetItemPosition( long item, wxPoint& pos );
+    int GetSelectedItemCount();
     void SetMode( long mode );
-    long GetMode( void ) const;
-    void CalculatePositions( void );
-    void RealizeChanges(void);
+    long GetMode() const;
+    void CalculatePositions();
+    void RealizeChanges();
     long GetNextItem( long item, int geometry, int state );
     void DeleteItem( long index );
-    void DeleteAllItems( void );
+    void DeleteAllItems();
     void DeleteColumn( int col );
-    void DeleteEverything( void );
+    void DeleteEverything();
     void EnsureVisible( long index );
-    long FindItem(long start, const wxString& str, bool partial = FALSE );
-    long FindItem(long start, long data);
+    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 );
@@ -537,8 +504,7 @@ class WXDLLEXPORT wxListCtrl: public wxControl
   DECLARE_DYNAMIC_CLASS(wxListCtrl);
 
   public:
-
-    wxListCtrl(void);
+    wxListCtrl();
     wxListCtrl( wxWindow *parent, wxWindowID id = -1,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
       long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
@@ -546,7 +512,7 @@ class WXDLLEXPORT wxListCtrl: public wxControl
     {
       Create(parent, id, pos, size, style, validator, name);
     }
-    ~wxListCtrl(void);
+    ~wxListCtrl();
     bool Create( wxWindow *parent, wxWindowID id = -1,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
       long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
@@ -556,8 +522,7 @@ class WXDLLEXPORT wxListCtrl: public wxControl
     bool SetColumn( int col, wxListItem& item );
     int GetColumnWidth( int col ) const;
     bool SetColumnWidth( int col, int width);
-    int GetCountPerPage(void) const; // not the same in wxGLC as in Windows, I think
-//  wxText& GetEditControl(void) const; // not supported in wxGLC
+    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 );
@@ -571,42 +536,46 @@ class WXDLLEXPORT wxListCtrl: public wxControl
     bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
     bool GetItemPosition( long item, wxPoint& pos ) const;
     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
-    int GetItemCount(void) const;
-    int GetColumnCount(void) const;
+    int GetItemCount() const;
+    int GetColumnCount() const;
     void SetItemSpacing( int spacing, bool isSmall = FALSE );
     int GetItemSpacing( bool isSmall ) const;
-    int GetSelectedItemCount(void) const;
-//  wxColour GetTextColour(void) const; // wxGLC has colours for every Item (see wxListItem)
+    int GetSelectedItemCount() const;
+//  wxColour GetTextColour() const; // wxGLC has colours for every Item (see wxListItem)
 //  void SetTextColour(const wxColour& col);
-    long GetTopItem(void) const;
+    long GetTopItem() const;
     void SetSingleStyle( long style, bool add = TRUE ) ;
-    void SetWindowStyleFlag(long style);
-    void RecreateWindow(void) {};
-    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) ;
+    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 );
     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
+    
     void ClearAll();
     bool DeleteItem( long item );
-    bool DeleteAllItems(void);
-    bool DeleteAllColumns(void);
+    bool DeleteAllItems();
+    bool DeleteAllColumns();
     bool DeleteColumn( int col );
-//  wxText& Edit(long item) ;  // not supported in wxGLC
+    
+    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, 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, 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 InsertItem(wxListItem& info);
-    long InsertItem(long index, const wxString& label);
-    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);
-    bool ScrollList(int dx, int dy);
-    bool SortItems(wxListCtrlCompare fn, long data);
-    bool Update(long item);
+    long InsertItem( long index, const wxString& label );
+    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 );
+    bool ScrollList( int dx, int dy );
+    bool SortItems( wxListCtrlCompare fn, long data );
+    bool Update( long item );
     void OnIdle( wxIdleEvent &event );
     
     // We have to hand down a few functions
@@ -628,14 +597,13 @@ class WXDLLEXPORT wxListCtrl: public wxControl
       { return m_mainWin ? m_mainWin->GetBackgroundColour() : wxColour(); }
     wxColour GetForegroundColour() const
       { return m_mainWin ? m_mainWin->GetForegroundColour() : wxColour(); }
-    bool PopupMenu( wxMenu *menu, int x, int y )
+    bool DoPopupMenu( wxMenu *menu, int x, int y )
       { return m_mainWin->PopupMenu( menu, x, y ); }
     void SetFocus()
       { m_mainWin->SetFocus(); }
 
   // implementation
-
-//  wxListTextCtrl       m_textCtrl;
+  
     wxImageList         *m_imageListNormal;
     wxImageList         *m_imageListSmall;
     wxImageList         *m_imageListState;  // what's that ?