QGIS/python/core/composer/qgscomposertexttable.sip
Nyall Dawson dc905accac [FEATURE][composer] Rework attribute tables to make tables more flexible.
- Add support for reordering columns in a table (fix #5942)
- Add support for expression based columns
- Add support for setting column alignment (fix #2957)
- Add support for setting column header alignment
- Make sorting in tables correctly handle nulls, dates, times, locale aware string sorting
This work also paves the way for future expansion of attribute tables to allow for setting column widths, column colors, etc.
2014-05-15 12:06:32 +10:00

43 lines
1.6 KiB
Plaintext

/**A text table item that reads text from string lists*/
class QgsComposerTextTable: QgsComposerTable
{
%TypeHeaderCode
#include <qgscomposertexttable.h>
%End
public:
QgsComposerTextTable( QgsComposition* c );
~QgsComposerTextTable();
/** return correct graphics item type. Added in v1.7 */
virtual int type() const;
/**Sets the text to use for the header row for the table
* @param labels list of strings to use for each column's header row
* @see headerLabels
*/
void setHeaderLabels( const QStringList& labels );
/**Adds a row to the table
* @param row list of strings to use for each cell's value in the newly added row
* @note If row is shorter than the number of columns in the table than blank cells
* will be inserted at the end of the row. If row contains more strings then the number
* of columns in the table then these extra strings will be ignored.
*/
void addRow( const QStringList& row );
/**Writes properties specific to text tables
* @param elem an existing QDomElement in which to store the text table's properties.
* @param doc QDomDocument for the destination xml.
* @see readXML
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/**Reads the properties specific to a text table from xml.
* @param itemElem a QDomElement holding the text table's desired properties.
* @param doc QDomDocument for the source xml.
* @see writeXML
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
};