wxDataViewCtrl is a control to display data either in a tree like fashion or
in a tabular form or both.
+
If you only need to display a simple tree structure with an API more like the
older wxTreeCtrl class, then the specialized wxDataViewTreeCtrl can be used.
+ Likewise, if you only want to display simple table structure you can use
+ the specialized wxDataViewListCtrl class. Both wxDataViewTreeCtrl and
+ wxDataViewListCtrl can be used without defining your own wxDataViewModel.
A wxDataViewItem is used to represent a (visible) item in the control.
Process a wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
@event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
Process a wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
+ @event{EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG event.
+ @event{EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE event.
+ @event{EVT_DATAVIEW_ITEM_DROP(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_DROP event.
@endEventTable
@library{wxadv}
*/
virtual bool DeleteColumn(wxDataViewColumn* column);
+ /**
+ Enable drag operations using the given @a format.
+ */
+ virtual bool EnableDragSource( const wxDataFormat &format );
+
+ /**
+ Enable drop operations using the given @a format.
+ */
+ virtual bool EnableDropTarget( const wxDataFormat &format );
+
/**
Call this to ensure that the given item is visible.
*/
/**
The flags used by wxDataViewColumn.
+ Can be combined together.
*/
enum wxDataViewColumnFlags
{
class wxDataViewColumn : public wxHeaderColumn
{
public:
- //@{
/**
- Constructors.
+ Constructs a text column.
+
+ @param title
+ The title of the column.
+ @param renderer
+ The class which will render the contents of this column.
+ @param model_column
+ The index of the model's column which is associated with this object.
+ @param width
+ The width of the column.
+ The @c wxDVC_DEFAULT_WIDTH value is the fixed default value.
+ @param align
+ The alignment of the column title.
+ @param flags
+ One or more flags of the ::wxDataViewColumnFlags enumeration.
*/
wxDataViewColumn(const wxString& title,
wxDataViewRenderer* renderer,
int width = wxDVC_DEFAULT_WIDTH,
wxAlignment align = wxALIGN_CENTER,
int flags = wxDATAVIEW_COL_RESIZABLE);
+
+ /**
+ Constructs a bitmap column.
+
+ @param bitmap
+ The bitmap of the column.
+ @param renderer
+ The class which will render the contents of this column.
+ @param model_column
+ The index of the model's column which is associated with this object.
+ @param width
+ The width of the column.
+ The @c wxDVC_DEFAULT_WIDTH value is the fixed default value.
+ @param align
+ The alignment of the column title.
+ @param flags
+ One or more flags of the ::wxDataViewColumnFlags enumeration.
+ */
wxDataViewColumn(const wxBitmap& bitmap,
wxDataViewRenderer* renderer,
unsigned int model_column,
int width = wxDVC_DEFAULT_WIDTH,
wxAlignment align = wxALIGN_CENTER,
int flags = wxDATAVIEW_COL_RESIZABLE);
- //@}
/**
Returns the index of the column of the model, which this
+/**
+ @class wxDataViewListCtrl
+
+ This class is a wxDataViewCtrl which internally uses a wxDataViewListStore
+ and forwards most of its API to that class.
+
+ The purpose of this class is to offer a simple way to display and
+ edit a small table of data without having to write your own wxDataViewModel.
+
+ @code
+ wxDataViewListCtrl *listctrl = new wxDataViewListCtrl( parent, -1 );
+
+ listctrl->AppendToggleColumn( "Toggle" );
+ listctrl->AppendTextColumn( "Text" );
+
+ wxVector<wxVariant> data;
+ data.push_back( true );
+ data.push_back( "row 1" );
+ listctrl->AppendItem( data );
+
+ data.clear();
+ data.push_back( false );
+ data.push_back( "row 3" );
+ listctrl->AppendItem( data );
+ @endcode
+
+
+ @library{wxadv}
+ @category{ctrl,dvc}
+*/
+class wxDataViewListCtrl: public wxDataViewCtrl
+{
+public:
+ /**
+ Default ctor.
+ */
+ wxDataViewListCtrl();
+
+ /**
+ Constructor. Calls Create().
+ */
+ wxDataViewListCtrl( wxWindow *parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize, long style = wxDV_ROW_LINES,
+ const wxValidator& validator = wxDefaultValidator );
+
+ /**
+ Destructor. Deletes the image list if any.
+ */
+ ~wxDataViewListCtrl();
+
+ /**
+ Creates the control and a wxDataViewListStore as its internal model.
+ */
+ bool Create( wxWindow *parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize, long style = wxDV_ROW_LINES,
+ const wxValidator& validator = wxDefaultValidator );
+
+ //@{
+ /**
+ Returns the store.
+ */
+ wxDataViewListStore *GetStore();
+ const wxDataViewListStore *GetStore() const;
+ //@}
+
+ /**
+ Appends a column to the control and additonally appends a
+ column to the store with the type @a varianttype.
+ */
+ void AppendColumn( wxDataViewColumn *column, const wxString &varianttype );
+
+ /**
+ Prepends a column to the control and additonally prepends a
+ column to the store with the type @a varianttype.
+ */
+ void PrependColumn( wxDataViewColumn *column, const wxString &varianttype );
+
+ /**
+ Inserts a column to the control and additonally inserts a
+ column to the store with the type @a varianttype.
+ */
+ void InsertColumn( unsigned int pos, wxDataViewColumn *column, const wxString &varianttype );
+
+ /**
+ Overridden from wxDataViewCtrl
+
+ Appends a column to the control and additonally appends a
+ column to the store with the type string.
+ */
+ virtual void AppendColumn( wxDataViewColumn *column );
+
+ /**
+ Overridden from wxDataViewCtrl
+
+ Prepends a column to the control and additonally prepends a
+ column to the store with the type string.
+ */
+ virtual void PrependColumn( wxDataViewColumn *column );
+
+ /**
+ Overridden from wxDataViewCtrl
+
+ Inserts a column to the control and additonally inserts a
+ column to the store with the type string.
+ */
+ virtual void InsertColumn( unsigned int pos, wxDataViewColumn *column );
+
+ /**
+ Inserts a text column to the control and the store.
+ */
+ wxDataViewColumn *AppendTextColumn( const wxString &label,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
+
+ /**
+ Inserts a toggle column to the control and the store.
+ */
+ wxDataViewColumn *AppendToggleColumn( const wxString &label,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
+ int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
+
+ /**
+ Inserts a progress column to the control and the store.
+ */
+ wxDataViewColumn *AppendProgressColumn( const wxString &label,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
+
+ /**
+ Inserts a icon and text column to the control and the store.
+ */
+ wxDataViewColumn *AppendIconTextColumn( const wxString &label,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
+
+ /**
+ Appends an item (=row) to the control and store.
+ */
+ void AppendItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
+
+ /**
+ Prepends an item (=row) to the control and store.
+ */
+ void PrependItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
+
+ /**
+ Inserts an item (=row) to the control and store.
+ */
+ void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxClientData *data = NULL );
+
+ /**
+ Delete the row at position @a row.
+ */
+ void DeleteItem( unsigned row );
+
+ /**
+ Delete all items (= all rows).
+ */
+ void DeleteAllItems();
+
+ /**
+ Sets the value in the store and update the control.
+ */
+ void SetValue( const wxVariant &value, unsigned int row, unsigned int col );
+
+ /**
+ Returns the value from the store.
+ */
+ void GetValue( wxVariant &value, unsigned int row, unsigned int col );
+
+ /**
+ Sets the value in the store and update the control.
+
+ This method assumes that the a string is stored in respective
+ column.
+ */
+ void SetTextValue( const wxString &value, unsigned int row, unsigned int col );
+
+ /**
+ Returns the value from the store.
+
+ This method assumes that the a string is stored in respective
+ column.
+ */
+ wxString GetTextValue( unsigned int row, unsigned int col ) const;
+
+ /**
+ Sets the value in the store and update the control.
+
+ This method assumes that the a boolean value is stored in
+ respective column.
+ */
+ void SetToggleValue( bool value, unsigned int row, unsigned int col );
+
+ /**
+ Returns the value from the store.
+
+ This method assumes that the a boolean value is stored in
+ respective column.
+ */
+ bool GetToggleValue( unsigned int row, unsigned int col ) const;
+};
+
+
/**
@class wxDataViewTreeCtrl
virtual ~wxDataViewTreeCtrl();
/**
- @todo docme
+ Appends a container to the given @a parent.
*/
wxDataViewItem AppendContainer(const wxDataViewItem& parent,
const wxString& text,
wxClientData* data = NULL);
/**
- @todo docme
+ Appends an item to the given @a parent.
*/
wxDataViewItem AppendItem(const wxDataViewItem& parent,
const wxString& text,
its data is be accessed by row (i.e. by index) instead of only
by wxDataViewItem.
- This class actually stores the values (therefore its name)
+ This class actually stores the values (therefore its name)
and implements all virtual methods from the base classes so it can be
- used directly without having to derive any class from it, but it is
+ used directly without having to derive any class from it, but it is
mostly used from within wxDataViewListCtrl.
@library{wxadv}
{
public:
/**
- Constructor
+ Constructor
*/
wxDataViewListStore();
-
+
/**
- Destructor
+ Destructor
*/
~wxDataViewListStore();
/**
- Prepends a data column.
-
- @a variantype indicates the type of values store in the column.
-
- This does not automatically fill in any (default) values in
- rows which exist in the store already.
+ Prepends a data column.
+
+ @a variantype indicates the type of values store in the column.
+
+ This does not automatically fill in any (default) values in
+ rows which exist in the store already.
*/
void PrependColumn( const wxString &varianttype );
/**
- Inserts a data column before @a pos.
-
- @a variantype indicates the type of values store in the column.
-
- This does not automatically fill in any (default) values in
- rows which exist in the store already.
+ Inserts a data column before @a pos.
+
+ @a variantype indicates the type of values store in the column.
+
+ This does not automatically fill in any (default) values in
+ rows which exist in the store already.
*/
void InsertColumn( unsigned int pos, const wxString &varianttype );
/**
- Apppends a data column.
-
- @a variantype indicates the type of values store in the column.
-
- This does not automatically fill in any (default) values in
- rows which exist in the store already.
+ Appends a data column.
+
+ @a variantype indicates the type of values store in the column.
+
+ This does not automatically fill in any (default) values in
+ rows which exist in the store already.
*/
void AppendColumn( const wxString &varianttype );
-
+
/**
Appends an item (=row) and fills it with @a values.
-
+
The values must match the values specifies in the column
in number and type. No (default) values are filled in
automatically.
*/
void AppendItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
-
+
/**
Prepends an item (=row) and fills it with @a values.
-
+
The values must match the values specifies in the column
in number and type. No (default) values are filled in
automatically.
*/
void PrependItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
-
+
/**
Inserts an item (=row) and fills it with @a values.
-
+
The values must match the values specifies in the column
in number and type. No (default) values are filled in
automatically.
*/
void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxClientData *data = NULL );
-
+
/**
Delete the item (=row) at position @a pos.
*/
void DeleteItem( unsigned pos );
-
+
/**
Delete all item (=all rows) in the store.
*/
wxDataViewTreeStore is a specialised wxDataViewModel for stroing simple
trees very much like wxTreeCtrl does and it offers a similar API.
- This class actually stores the entire tree and the values (therefore its name)
+ This class actually stores the entire tree and the values (therefore its name)
and implements all virtual methods from the base class so it can be used directly
without having to derive any class from it, but it is mostly used from within
wxDataViewTreeCtrl.
class wxDataViewEvent : public wxNotifyEvent
{
public:
- //@{
/**
Constructor. Typically used by wxWidgets internals only.
*/
wxDataViewEvent(wxEventType commandType = wxEVT_NULL,
int winid = 0);
- wxDataViewEvent(const wxDataViewEvent& event);
- //@}
/**
Returns the position of the column in the control or -1
Sets the value associated with this event.
*/
void SetValue(const wxVariant& value);
+
+ /**
+ Set wxDataObject for data transfer within a drag operation.
+ */
+ void SetDataObject( wxDataObject *obj );
+
+ /**
+ Used internally. Gets associated wxDataObject for data transfer
+ within a drag operation.
+ */
+ wxDataObject *GetDataObject() const;
+
+ /**
+ Used internally. Sets the wxDataFormat during a drop operation.
+ */
+ void SetDataFormat( const wxDataFormat &format );
+
+ /**
+ Gets the wxDataFormat during a drop operation.
+ */
+ wxDataFormat GetDataFormat() const;
+
+ /**
+ Used internally. Sets the data size for a drop data transfer.
+ */
+ void SetDataSize( size_t size );
+
+ /**
+ Gets the data size for a drop data transfer.
+ */
+ size_t GetDataSize() const;
+
+ /**
+ Used internally. Sets the data buffer for a drop data transfer.
+ */
+ void SetDataBuffer( void* buf );
+
+ /**
+ Gets the data buffer for a drop data transfer.
+ */
+ void *GetDataBuffer() const;
};
projects / wxWidgets.git / blobdiff