QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
QgsComposerAttributeTableColumnModel Class Reference

A model for displaying columns shown in a QgsComposerAttributeTable. More...

#include <qgscomposerattributetablemodel.h>

Public Types

enum  ShiftDirection { ShiftUp, ShiftDown }

Public Member Functions

 QgsComposerAttributeTableColumnModel (QgsComposerAttributeTable *composerTable, QObject *parent=0)
 Constructor for QgsComposerAttributeTableColumnModel.
virtual ~QgsComposerAttributeTableColumnModel ()
virtual int rowCount (const QModelIndex &parent=QModelIndex()) const
int columnCount (const QModelIndex &parent=QModelIndex()) const
virtual QVariant data (const QModelIndex &index, int role) const
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
virtual bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
Qt::ItemFlags flags (const QModelIndex &index) const
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
bool insertRows (int row, int count, const QModelIndex &parent=QModelIndex())
QModelIndex index (int row, int column, const QModelIndex &parent) const
QModelIndex parent (const QModelIndex &child) const
bool moveRow (int row, ShiftDirection direction)
 Moves the specified row up or down in the model.
void resetToLayer ()
 Resets the attribute table's columns to match the source layer's fields.
QgsComposerTableColumncolumnFromIndex (const QModelIndex &index) const
 Returns the QgsComposerTableColumn corresponding to an index in the model.
QModelIndex indexFromColumn (QgsComposerTableColumn *column)
 Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.
void setColumnAsSorted (QgsComposerTableColumn *column, Qt::SortOrder order)
 Sets a specified column as a sorted column in the QgsComposerAttributeTable.
void setColumnAsUnsorted (QgsComposerTableColumn *column)
 Sets a specified column as an unsorted column in the QgsComposerAttributeTable.
bool moveColumnInSortRank (QgsComposerTableColumn *column, ShiftDirection direction)
 Moves a column up or down in the sort rank for the QgsComposerAttributeTable.

Detailed Description

A model for displaying columns shown in a QgsComposerAttributeTable.

Member Enumeration Documentation

Controls whether a row/column is shifted up or down

Enumerator:
ShiftUp 

shift the row/column up

ShiftDown 

shift the row/column down

Constructor & Destructor Documentation

QgsComposerAttributeTableColumnModel::QgsComposerAttributeTableColumnModel ( QgsComposerAttributeTable composerTable,
QObject *  parent = 0 
)

Constructor for QgsComposerAttributeTableColumnModel.

Parameters
composerTableQgsComposerAttributeTable the model is attached to
parentoptional parent
QgsComposerAttributeTableColumnModel::~QgsComposerAttributeTableColumnModel ( )
virtual

Member Function Documentation

int QgsComposerAttributeTableColumnModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const
QgsComposerTableColumn * QgsComposerAttributeTableColumnModel::columnFromIndex ( const QModelIndex &  index) const

Returns the QgsComposerTableColumn corresponding to an index in the model.

Returns
QgsComposerTableColumn for specified index
Parameters
indexa QModelIndex
Note
added in 2.3
See Also
indexFromColumn
QVariant QgsComposerAttributeTableColumnModel::data ( const QModelIndex &  index,
int  role 
) const
virtual
Qt::ItemFlags QgsComposerAttributeTableColumnModel::flags ( const QModelIndex &  index) const
QVariant QgsComposerAttributeTableColumnModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
QModelIndex QgsComposerAttributeTableColumnModel::index ( int  row,
int  column,
const QModelIndex &  parent 
) const
QModelIndex QgsComposerAttributeTableColumnModel::indexFromColumn ( QgsComposerTableColumn column)

Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.

Returns
QModelIndex for specified QgsComposerTableColumn
Parameters
columna QgsComposerTableColumn
Note
added in 2.3
See Also
columnFromIndex
bool QgsComposerAttributeTableColumnModel::insertRows ( int  row,
int  count,
const QModelIndex &  parent = QModelIndex() 
)
bool QgsComposerAttributeTableColumnModel::moveColumnInSortRank ( QgsComposerTableColumn column,
ShiftDirection  direction 
)

Moves a column up or down in the sort rank for the QgsComposerAttributeTable.

Parameters
columna QgsComposerTableColumn
directiondirection to move the column in the sort rank list
Note
added in 2.3
See Also
setColumnAsSorted
bool QgsComposerAttributeTableColumnModel::moveRow ( int  row,
ShiftDirection  direction 
)

Moves the specified row up or down in the model.

Used for rearranging the attribute tables columns.

Returns
true if the move is allowed
Parameters
rowrow in model representing attribute table column to move
directiondirection to move the attribute table column
Note
added in 2.3
QModelIndex QgsComposerAttributeTableColumnModel::parent ( const QModelIndex &  child) const
bool QgsComposerAttributeTableColumnModel::removeRows ( int  row,
int  count,
const QModelIndex &  parent = QModelIndex() 
)
void QgsComposerAttributeTableColumnModel::resetToLayer ( )

Resets the attribute table's columns to match the source layer's fields.

Remove all existing attribute table columns and column customisations.

Note
added in 2.3
int QgsComposerAttributeTableColumnModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
virtual
void QgsComposerAttributeTableColumnModel::setColumnAsSorted ( QgsComposerTableColumn column,
Qt::SortOrder  order 
)

Sets a specified column as a sorted column in the QgsComposerAttributeTable.

The column will be added to the end of the sort rank list, ie it will take the next largest available sort rank.

Parameters
columna QgsComposerTableColumn
ordersort order for column
Note
added in 2.3
See Also
removeColumnFromSort
moveColumnInSortRank
void QgsComposerAttributeTableColumnModel::setColumnAsUnsorted ( QgsComposerTableColumn column)

Sets a specified column as an unsorted column in the QgsComposerAttributeTable.

The column will be removed from the sort rank list.

Parameters
columna QgsComposerTableColumn
Note
added in 2.3
See Also
setColumnAsSorted
bool QgsComposerAttributeTableColumnModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role = Qt::EditRole 
)
virtual

The documentation for this class was generated from the following files: