QGIS API Documentation 3.29.0-Master (53715c36dc)
Public Member Functions | List of all members
QgsTableCell Class Reference

Encapsulates the contents and formatting of a single table cell. More...

#include <qgstablecell.h>

Public Member Functions

 QgsTableCell (const QgsTableCell &other)
 Copy constructor. More...
 
 QgsTableCell (const QVariant &content=QVariant())
 Constructor for QgsTableCell, with the specified content. More...
 
 ~QgsTableCell ()
 
QColor backgroundColor () const
 Returns the cell's background color, or an invalid color if a default color should be used for the background. More...
 
QVariant content () const
 Returns the cell's content. More...
 
QColor foregroundColor () const
 Returns the cell's foreground color, or an invalid color if a default color should be used for the foreground. More...
 
Qt::Alignment horizontalAlignment () const
 Returns the horizontal alignment for text in the cell. More...
 
const QgsNumericFormatnumericFormat () const
 Returns the numeric format used for numbers in the cell, or nullptr if no format is set. More...
 
QgsTableCelloperator= (const QgsTableCell &other)
 
QVariantMap properties (const QgsReadWriteContext &context) const
 Returns the properties of the cell. More...
 
void setBackgroundColor (const QColor &color)
 Sets the cell's background color. More...
 
void setContent (const QVariant &content)
 Sets the cell's content. More...
 
void setForegroundColor (const QColor &color)
 Sets the cell's foreground color. More...
 
void setHorizontalAlignment (Qt::Alignment alignment)
 Sets the horizontal alignment for text in the cell. More...
 
void setNumericFormat (QgsNumericFormat *format)
 Sets the numeric format used for numbers in the cell, or nullptr if no specific format is set. More...
 
void setProperties (const QVariantMap &properties, const QgsReadWriteContext &context)
 Sets the properties for the cell. More...
 
void setTextFormat (const QgsTextFormat &format)
 Sets the cell's text format. More...
 
void setVerticalAlignment (Qt::Alignment alignment)
 Sets the vertical alignment for text in the cell. More...
 
QgsTextFormat textFormat () const
 Returns the cell's text format. More...
 
Qt::Alignment verticalAlignment () const
 Returns the vertical alignment for text in the cell. More...
 

Detailed Description

Encapsulates the contents and formatting of a single table cell.

Since
QGIS 3.12

Definition at line 35 of file qgstablecell.h.

Constructor & Destructor Documentation

◆ QgsTableCell() [1/2]

QgsTableCell::QgsTableCell ( const QVariant &  content = QVariant())

Constructor for QgsTableCell, with the specified content.

Definition at line 22 of file qgstablecell.cpp.

◆ QgsTableCell() [2/2]

QgsTableCell::QgsTableCell ( const QgsTableCell other)

Copy constructor.

Definition at line 26 of file qgstablecell.cpp.

◆ ~QgsTableCell()

QgsTableCell::~QgsTableCell ( )
default

Member Function Documentation

◆ backgroundColor()

QColor QgsTableCell::backgroundColor ( ) const
inline

Returns the cell's background color, or an invalid color if a default color should be used for the background.

See also
setBackgroundColor()

Definition at line 71 of file qgstablecell.h.

◆ content()

QVariant QgsTableCell::content ( ) const
inline

Returns the cell's content.

See also
setContent()

Definition at line 57 of file qgstablecell.h.

◆ foregroundColor()

QColor QgsTableCell::foregroundColor ( ) const
inline

Returns the cell's foreground color, or an invalid color if a default color should be used for the foreground.

See also
setForegroundColor()

Definition at line 87 of file qgstablecell.h.

◆ horizontalAlignment()

Qt::Alignment QgsTableCell::horizontalAlignment ( ) const

Returns the horizontal alignment for text in the cell.

See also
setHorizontalAlignment()
verticalAlignment()
Since
QGIS 3.16

Definition at line 122 of file qgstablecell.cpp.

◆ numericFormat()

const QgsNumericFormat * QgsTableCell::numericFormat ( ) const

Returns the numeric format used for numbers in the cell, or nullptr if no format is set.

See also
setNumericFormat()

Definition at line 50 of file qgstablecell.cpp.

◆ operator=()

QgsTableCell & QgsTableCell::operator= ( const QgsTableCell other)

Definition at line 38 of file qgstablecell.cpp.

◆ properties()

QVariantMap QgsTableCell::properties ( const QgsReadWriteContext context) const

Returns the properties of the cell.

See also
setProperties()

Definition at line 60 of file qgstablecell.cpp.

◆ setBackgroundColor()

void QgsTableCell::setBackgroundColor ( const QColor &  color)
inline

Sets the cell's background color.

Set an invalid color if a default color should be used for the background.

See also
backgroundColor()

Definition at line 80 of file qgstablecell.h.

◆ setContent()

void QgsTableCell::setContent ( const QVariant &  content)
inline

Sets the cell's content.

See also
content()

Definition at line 64 of file qgstablecell.h.

◆ setForegroundColor()

void QgsTableCell::setForegroundColor ( const QColor &  color)
inline

Sets the cell's foreground color.

Set an invalid color if a default color should be used for the foreground.

See also
foregroundColor()

Definition at line 96 of file qgstablecell.h.

◆ setHorizontalAlignment()

void QgsTableCell::setHorizontalAlignment ( Qt::Alignment  alignment)

Sets the horizontal alignment for text in the cell.

See also
horizontalAlignment()
setVerticalAlignment()
Since
QGIS 3.16

Definition at line 127 of file qgstablecell.cpp.

◆ setNumericFormat()

void QgsTableCell::setNumericFormat ( QgsNumericFormat format)

Sets the numeric format used for numbers in the cell, or nullptr if no specific format is set.

Ownership of format is transferred to the cell.

See also
numericFormat()

Definition at line 55 of file qgstablecell.cpp.

◆ setProperties()

void QgsTableCell::setProperties ( const QVariantMap &  properties,
const QgsReadWriteContext context 
)

Sets the properties for the cell.

See also
properties()

Definition at line 86 of file qgstablecell.cpp.

◆ setTextFormat()

void QgsTableCell::setTextFormat ( const QgsTextFormat format)
inline

Sets the cell's text format.

Note
The text format will only be used if hasTextFormat() returns true.
See also
textFormat()
Since
QGIS 3.16

Definition at line 116 of file qgstablecell.h.

◆ setVerticalAlignment()

void QgsTableCell::setVerticalAlignment ( Qt::Alignment  alignment)

Sets the vertical alignment for text in the cell.

See also
verticalAlignment()
setHorizontalAlignment()
Since
QGIS 3.16

Definition at line 137 of file qgstablecell.cpp.

◆ textFormat()

QgsTextFormat QgsTableCell::textFormat ( ) const
inline

Returns the cell's text format.

Note
The text format will only be used if hasTextFormat() returns true.
See also
setTextFormat()
Since
QGIS 3.16

Definition at line 106 of file qgstablecell.h.

◆ verticalAlignment()

Qt::Alignment QgsTableCell::verticalAlignment ( ) const

Returns the vertical alignment for text in the cell.

See also
setVerticalAlignment()
horizontalAlignment()
Since
QGIS 3.16

Definition at line 132 of file qgstablecell.cpp.


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