- DECLARE_DYNAMIC_CLASS(wxListCtrl)
- public:
- /*
- * Public interface
- */
-
- wxListCtrl();
-
- inline wxListCtrl(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "listCtrl")
- {
- Create(parent, id, pos, size, style, validator, name);
- }
- ~wxListCtrl();
-
- bool Create(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString& name = "wxListCtrl");
-
-
- // Attributes
- ////////////////////////////////////////////////////////////////////////////
-
- // Sets the background colour (GetBackgroundColour already implicit in
- // wxWindow class)
- bool SetBackgroundColour(const wxColour& col);
-
- // Gets information about this column
- bool GetColumn(int col, wxListItem& item) const;
-
- // Sets information about this column
- bool SetColumn(int col, wxListItem& item) ;
-
- // Gets the column width
- int GetColumnWidth(int col) const;
-
- // Sets the column width
- bool SetColumnWidth(int col, int width) ;
-
- // Gets the number of items that can fit vertically in the
- // visible area of the list control (list or report view)
- // or the total number of items in the list control (icon
- // or small icon view)
- int GetCountPerPage() const;
-
- // Gets the edit control for editing labels.
- wxTextCtrl* GetEditControl() const;
-
- // Gets information about the item
- bool GetItem(wxListItem& info) const ;
-
- // Sets information about the item
- bool SetItem(wxListItem& info) ;
-
- // Sets a string field at a particular column
- long SetItem(long index, int col, const wxString& label, int imageId = -1);
-
- // Gets the item state
- int GetItemState(long item, long stateMask) const ;
-
- // Sets the item state
- bool SetItemState(long item, long state, long stateMask) ;
-
- // Sets the item image
- bool SetItemImage(long item, int image, int selImage) ;
-
- // Gets the item text
- wxString GetItemText(long item) const ;
-
- // Sets the item text
- void SetItemText(long item, const wxString& str) ;
-
- // Gets the item data
- long GetItemData(long item) const ;
-
- // Sets the item data
- bool SetItemData(long item, long data) ;
-
- // Gets the item rectangle
- bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
-
- // Gets the item position
- bool GetItemPosition(long item, wxPoint& pos) const ;
-
- // Sets the item position
- bool SetItemPosition(long item, const wxPoint& pos) ;
-
- // Gets the number of items in the list control
- int GetItemCount() const;
-
- // Gets the number of columns in the list control
- int GetColumnCount() const;
-
- // Retrieves the spacing between icons in pixels.
- // If small is TRUE, gets the spacing for the small icon
- // view, otherwise the large icon view.
- int GetItemSpacing(bool isSmall) const;
-
- // Gets the number of selected items in the list control
- int GetSelectedItemCount() const;
-
- // Gets the text colour of the listview
- wxColour GetTextColour() const;
-
- // Sets the text colour of the listview
- void SetTextColour(const wxColour& col);
-
- // Gets the index of the topmost visible item when in
- // list or report view
- long GetTopItem() const ;
-
- // Add or remove a single window style
- void SetSingleStyle(long style, bool add = TRUE) ;
-
- // Set the whole window style
- void SetWindowStyleFlag(long style) ;
-
- // Searches for an item, starting from 'item'.
- // item can be -1 to find the first item that matches the
- // specified flags.
- // Returns the item or -1 if unsuccessful.
- long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
-
- // Implementation: converts wxWindows style to OS2 style.
- // Can be a single style flag or a bit list.
- // oldStyle is 'normalised' so that it doesn't contain
- // conflicting styles.
- long ConvertToOS2Style(long& oldStyle, long style) const;
-
- // Gets one of the three image lists
- wxImageList *GetImageList(int which) const ;
-
- // Sets the image list
- // N.B. There's a quirk in the Win95 list view implementation.
- // If in wxLC_LIST mode, it'll *still* display images by the labels if
- // there's a small-icon image list set for the control - even though you
- // haven't specified wxLIST_MASK_IMAGE when inserting.
- // So you have to set a NULL small-icon image list to be sure that
- // the wxLC_LIST mode works without icons. Of course, you may want icons...
- void SetImageList(wxImageList *imageList, int which) ;
-
- // Operations
- ////////////////////////////////////////////////////////////////////////////
-
- // Arranges the items
- bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
-
- // Deletes an item
- bool DeleteItem(long item);
-
- // Deletes all items
- bool DeleteAllItems() ;
-
- // Deletes a column
- bool DeleteColumn(int col);
-
- // Deletes all columns
- bool DeleteAllColumns();
-
- // Clears items, and columns if there are any.
- void ClearAll();
-
- // Edit the label
- wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
-
- // End label editing, optionally cancelling the edit
- bool EndEditLabel(bool cancel);
-
- // Ensures this item is visible
- bool EnsureVisible(long item) ;
-
- // Find an item whose label matches this string, starting from the item after 'start'
- // or the beginning if 'start' is -1.
- long FindItem(long start, const wxString& str, bool partial = FALSE);
-
- // Find an item whose data matches this data, starting from the item after 'start'
- // or the beginning if 'start' is -1.
- long FindItem(long start, long data);
-
- // Find an item nearest this position in the specified direction, starting from
- // the item after 'start' or the beginning if 'start' is -1.
- long FindItem(long start, const wxPoint& pt, int direction);
-
- // Determines which item (if any) is at the specified point,
- // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
- long HitTest(const wxPoint& point, int& flags);
-
- // Inserts an item, returning the index of the new item if successful,
- // -1 otherwise.
- // TOD: Should also have some further convenience functions
- // which don't require setting a wxListItem object
- long InsertItem(wxListItem& info);
-
- // Insert a string item
- long InsertItem(long index, const wxString& label);
-
- // Insert an image item
- long InsertItem(long index, int imageIndex);
-
- // Insert an image/string item
- long InsertItem(long index, const wxString& label, int imageIndex);
-
- // For list view mode (only), inserts a column.
- long InsertColumn(long col, wxListItem& info);
-
- long InsertColumn(long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
- int width = -1);
-
- // Scrolls the list control. If in icon, small icon or report view mode,
- // x specifies the number of pixels to scroll. If in list view mode, x
- // specifies the number of columns to scroll.
- // If in icon, small icon or list view mode, y specifies the number of pixels
- // to scroll. If in report view mode, y specifies the number of lines to scroll.
- bool ScrollList(int dx, int dy);
-
- // Sort items.
-
- // fn is a function which takes 3 long arguments: item1, item2, data.
- // item1 is the long data associated with a first item (NOT the index).
- // item2 is the long data associated with a second item (NOT the index).
- // data is the same value as passed to SortItems.
- // The return value is a negative number if the first item should precede the second
- // item, a positive number of the second item should precede the first,
- // or zero if the two items are equivalent.
-
- // data is arbitrary data to be passed to the sort function.
- bool SortItems(wxListCtrlCompare fn, long data);
-
- // IMPLEMENTATION
- virtual bool OS2Command(WXUINT param, WXWORD id);
- virtual bool OS2OnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+public:
+ wxListCtrl() { Init(); }
+ wxListCtrl( wxWindow* pParent
+ ,wxWindowID vId = -1
+ ,const wxPoint& rPos = wxDefaultPosition
+ ,const wxSize& rSize = wxDefaultSize
+ ,long lStyle = wxLC_ICON
+ ,const wxValidator& rValidator = wxDefaultValidator
+ ,const wxString& rsName = wxListCtrlNameStr)
+ {
+ Init();
+ Create( pParent
+ ,vId
+ ,rPos
+ ,rSize
+ ,lStyle
+ ,rValidator
+ ,rsName
+ );
+ }
+ virtual ~wxListCtrl();
+
+ bool Create( wxWindow* pParent
+ ,wxWindowID vId = -1
+ ,const wxPoint& rPos = wxDefaultPosition
+ ,const wxSize& rSize = wxDefaultSize
+ ,long lStyle = wxLC_ICON
+ ,const wxValidator& rValidator = wxDefaultValidator
+ ,const wxString& rsName = wxListCtrlNameStr
+ );
+
+
+ // Attributes
+ ////////////////////////////////////////////////////////////////////////////
+ //
+
+ //
+ // Set the control colours
+ //
+ bool SetForegroundColour(const wxColour& rCol);
+ bool SetBackgroundColour(const wxColour& rCol);
+
+ //
+ // Information about this column
+ //
+ bool GetColumn( int nCol
+ ,wxListItem& rItem
+ ) const;
+ bool SetColumn( int nCol
+ ,wxListItem& rItem
+ );
+
+ //
+ // Column width
+ //
+ int GetColumnWidth(int nCol) const;
+ bool SetColumnWidth( int nCol
+ ,int nWidth
+ );
+
+ //
+ // Gets the number of items that can fit vertically in the
+ // visible area of the list control (list or report view)
+ // or the total number of items in the list control (icon
+ // or small icon view)
+ //
+ int GetCountPerPage(void) const;
+
+ wxRect GetViewRect() const;
+ //
+ // Gets the edit control for editing labels.
+ //
+ wxTextCtrl* GetEditControl(void) const;
+
+ //
+ // Information about the item
+ //
+ bool GetItem(wxListItem& rInfo) const;
+ bool SetItem(wxListItem& rInfo);
+
+ //
+ // Sets a string field at a particular column
+ //
+ long SetItem( long lIndex
+ ,int nCol
+ ,const wxString& rsLabel
+ ,int nImageId = -1
+ );
+
+ //
+ // Item state
+ //
+ int GetItemState( long lItem
+ ,long lStateMask
+ ) const;
+ bool SetItemState( long lItem
+ ,long lState
+ ,long lStateMask
+ );
+
+ //
+ // Sets the item image
+ //
+ bool SetItemImage( long lItem
+ ,int nImage
+ ,int lSelImage
+ );
+ bool SetItemColumnImage( long lItem
+ ,long lColumn
+ ,int nImage
+ );
+
+ //
+ // Item text
+ //
+ wxString GetItemText(long lItem) const;
+ void SetItemText( long lItem
+ ,const wxString& rsStr
+ );
+
+ //
+ // Item data
+ //
+ long GetItemData(long lItem) const;
+ bool SetItemData( long lItem
+ ,long lData
+ );
+
+ //
+ // Gets the item rectangle
+ //
+ bool GetItemRect( long lItem
+ ,wxRect& rRect
+ ,int nCode = wxLIST_RECT_BOUNDS
+ ) const;
+
+ //
+ // Item position
+ //
+ bool GetItemPosition( long lItem
+ ,wxPoint& rPos
+ ) const;
+ bool SetItemPosition( long lItem
+ ,const wxPoint& rPos
+ );
+
+ //
+ // Gets the number of items in the list control
+ //
+ int GetItemCount(void) const;
+
+ //
+ // Gets the number of columns in the list control
+ //
+ inline int GetColumnCount(void) const { return m_nColCount; }
+
+ //
+ // Retrieves the spacing between icons in pixels.
+ // If bIsSmall is true, gets the spacing for the small icon
+ // view, otherwise the large icon view.
+ //
+ int GetItemSpacing(bool bIsSmall) const;
+
+ //
+ // Foreground colour of an item.
+ //
+ wxColour GetItemTextColour(long lItem) const;
+ void SetItemTextColour( long lItem
+ ,const wxColour& rCol
+ );
+
+ //
+ // Background colour of an item.
+ //
+ wxColour GetItemBackgroundColour(long lItem ) const;
+ void SetItemBackgroundColour( long lItem
+ ,const wxColour& rCol
+ );
+
+ //
+ // Gets the number of selected items in the list control
+ //
+ int GetSelectedItemCount(void) const;
+
+ //
+ // Text colour of the listview
+ //
+ wxColour GetTextColour(void) const;
+ void SetTextColour(const wxColour& rCol);
+
+ //
+ // Gets the index of the topmost visible item when in
+ // list or report view
+ //
+ long GetTopItem(void) const;
+
+ //
+ // Add or remove a single window style
+ void SetSingleStyle( long lStyle
+ ,bool bAdd = true
+ );
+
+ //
+ // Set the whole window style
+ //
+ void SetWindowStyleFlag(long lStyle);
+
+ //
+ // Searches for an item, starting from 'item'.
+ // item can be -1 to find the first item that matches the
+ // specified flags.
+ // Returns the item or -1 if unsuccessful.
+ long GetNextItem( long lItem
+ ,int nGeometry = wxLIST_NEXT_ALL
+ ,int lState = wxLIST_STATE_DONTCARE
+ ) const;
+
+ //
+ // Gets one of the three image lists
+ //
+ wxImageList* GetImageList(int nWhich) const;
+
+ //
+ // Sets the image list
+ //
+ void SetImageList( wxImageList* pImageList
+ ,int nWhich
+ );
+ void AssignImageList( wxImageList* pImageList
+ ,int nWhich
+ );
+
+ //
+ // Returns true if it is a virtual list control
+ //
+ inline bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; }
+
+ //
+ // Refresh items selectively (only useful for virtual list controls)
+ //
+ void RefreshItem(long lItem);
+ void RefreshItems( long lItemFrom
+ ,long lItemTo
+ );
+
+ //
+ // Operations
+ ////////////////////////////////////////////////////////////////////////////
+ //
+
+ //
+ // Arranges the items
+ //
+ bool Arrange(int nFlag = wxLIST_ALIGN_DEFAULT);
+
+ //
+ // Deletes an item
+ //
+ bool DeleteItem(long lItem);
+
+ //
+ // Deletes all items
+ bool DeleteAllItems(void);
+
+ //
+ // Deletes a column
+ //
+ bool DeleteColumn(int nCol);
+
+ //
+ // Deletes all columns
+ //
+ bool DeleteAllColumns(void);
+
+ //
+ // Clears items, and columns if there are any.
+ //
+ void ClearAll(void);
+
+ //
+ // Edit the label
+ //
+ wxTextCtrl* EditLabel( long lItem
+ ,wxClassInfo* pTextControlClass = CLASSINFO(wxTextCtrl)
+ );
+
+ //
+ // End label editing, optionally cancelling the edit
+ //
+ bool EndEditLabel(bool bCancel);
+
+ //
+ // Ensures this item is visible
+ //
+ bool EnsureVisible(long lItem);
+
+ //
+ // Find an item whose label matches this string, starting from the item after 'start'
+ // or the beginning if 'start' is -1.
+ //
+ long FindItem( long lStart
+ ,const wxString& rsStr
+ ,bool bPartial = false
+ );
+
+ //
+ // Find an item whose data matches this data, starting from the item after 'start'
+ // or the beginning if 'start' is -1.
+ //
+ long FindItem( long lStart
+ ,long lData
+ );
+
+ //
+ // Find an item nearest this position in the specified direction, starting from
+ // the item after 'start' or the beginning if 'start' is -1.
+ //
+ long FindItem( long lStart
+ ,const wxPoint& rPoint
+ ,int lDirection
+ );
+
+ //
+ // Determines which item (if any) is at the specified point,
+ // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
+ //
+ long HitTest( const wxPoint& rPoint
+ ,int& rFlags
+ );
+
+ //
+ // Inserts an item, returning the index of the new item if successful,
+ // -1 otherwise.
+ //
+ long InsertItem(wxListItem& rInfo);
+
+ //
+ // Insert a string item
+ //
+ long InsertItem( long lIndex
+ ,const wxString& rsLabel
+ );
+
+ //
+ // Insert an image item
+ //
+ long InsertItem( long lIndex
+ ,int nImageIndex
+ );
+
+ //
+ // Insert an image/string item
+ //
+ long InsertItem( long lIndex
+ ,const wxString& rsLabel
+ ,int nImageIndex
+ );
+
+ //
+ // For list view mode (only), inserts a column.
+ //
+ long InsertColumn( long lCol
+ ,wxListItem& rInfo
+ );
+
+ long InsertColumn( long lCol
+ ,const wxString& rsHeading
+ ,int nFormat = wxLIST_FORMAT_LEFT
+ ,int lWidth = -1
+ );
+
+ //
+ // set the number of items in a virtual list control
+ //
+ void SetItemCount(long lCount);
+
+ //
+ // Scrolls the list control. If in icon, small icon or report view mode,
+ // x specifies the number of pixels to scroll. If in list view mode, x
+ // specifies the number of columns to scroll.
+ // If in icon, small icon or list view mode, y specifies the number of pixels
+ // to scroll. If in report view mode, y specifies the number of lines to scroll.
+ //
+ bool ScrollList( int nDx
+ ,int nDy
+ );
+
+ // Sort items.
+
+ //
+ // fn is a function which takes 3 long arguments: item1, item2, data.
+ // item1 is the long data associated with a first item (NOT the index).
+ // item2 is the long data associated with a second item (NOT the index).
+ // data is the same value as passed to SortItems.
+ // The return value is a negative number if the first item should precede the second
+ // item, a positive number of the second item should precede the first,
+ // or zero if the two items are equivalent.
+ //
+ // data is arbitrary data to be passed to the sort function.
+ //
+ bool SortItems( wxListCtrlCompare fn
+ ,long lData
+ );
+
+ //
+ // IMPLEMENTATION
+ // --------------
+ //
+ virtual bool OS2Command( WXUINT uParam
+ ,WXWORD wId
+ );
+ //
+ // Bring the control in sync with current m_windowStyle value
+ //
+ void UpdateStyle(void);
+
+ //
+ // Implementation: converts wxWidgets style to MSW style.
+ // Can be a single style flag or a bit list.
+ // oldStyle is 'normalised' so that it doesn't contain
+ // conflicting styles.
+ //
+ long ConvertToOS2Style( long& lOldStyle
+ ,long lStyle
+ ) const;
+ long ConvertArrangeToOS2Style(long lStyle);
+ long ConvertViewToOS2Style(long lStyle);
+
+ virtual MRESULT OS2WindowProc( WXUINT uMsg
+ ,WXWPARAM wParam
+ ,WXLPARAM lParam
+ );
+
+ // Event handlers
+ ////////////////////////////////////////////////////////////////////////////
+ // Necessary for drawing hrules and vrules, if specified
+ void OnPaint(wxPaintEvent& rEvent);
projects / wxWidgets.git / blobdiff