Scribus
Open source desktop publishing at your fingertips
TableCell Class Reference

#include <tablecell.h>

Public Member Functions

 TableCell ()
 
 TableCell (const TableCell &other)
 Construct a new table cell as a shallow copy of other.
 
bool operator== (const TableCell &other) const
 Returns true if this cell is equal to other.
 
bool operator!= (const TableCell &other) const
 Returns true if this cell is not equal to other.
 
bool isValid () const
 Returns true if this cell is valid.
 
int row () const
 Returns the row in the table that contains this cell.
 
int column () const
 Returns the column in the table that contains this cell.
 
int rowSpan () const
 Returns the number of rows this cell spans.
 
int columnSpan () const
 Returns the number of columns this cell spans.
 
QRectF boundingRect () const
 Returns the bounding rectangle of this cell.
 
QRectF contentRect () const
 Returns the content rectangle of this cell.
 
void setFillColor (const QString &color)
 Sets the fill color of this cell to color.
 
QString fillColor () const
 Returns the fill color of this cell.
 
void setFillShade (const double &shade)
 Sets the fill color of this cell to color.
 
double fillShade () const
 Returns the fill color of this cell.
 
void setLeftBorder (const TableBorder &border)
 Sets the left border of this cell to border.
 
TableBorder leftBorder () const
 Returns the left border of this cell.
 
void setRightBorder (const TableBorder &border)
 Sets the right border of this cell to border.
 
TableBorder rightBorder () const
 Returns the right border of this cell.
 
void setTopBorder (const TableBorder &border)
 Sets the top border of this cell to border.
 
TableBorder topBorder () const
 Returns the top border of this cell.
 
void setBottomBorder (const TableBorder &border)
 Sets the bottom border of this cell to border.
 
TableBorder bottomBorder () const
 Returns the bottom border of this cell.
 
void setLeftPadding (double padding)
 Sets the left padding of this cell to padding.
 
double leftPadding () const
 Returns the left padding of this cell.
 
void setRightPadding (double padding)
 Sets the right padding of this cell to padding.
 
double rightPadding () const
 Returns the right padding of this cell.
 
void setTopPadding (double padding)
 Sets the top padding of this cell to padding.
 
double topPadding () const
 Returns the top padding of this cell.
 
void setBottomPadding (double padding)
 Sets the bottom padding of this cell to padding.
 
double bottomPadding () const
 Returns the bottom padding of this cell.
 
void setStyle (const QString &style)
 Sets the cell style for this cell to style.
 
void unsetDirectFormatting ()
 
QString style () const
 Returns the named cell style for this cell.
 
void setText (const QString &text)
 Sets the text for this cell to text.
 
PageItem_TextFrametextFrame () const
 Returns the text frame for this cell.
 
QString asString () const
 Returns the cell as a string. Useful for debugging. The format is subject to change.
 

Friends

class PageItem_Table
 

Detailed Description

The TableCell class represents a cell in a table.

It provides an interface for setting and getting cell properties. A cell may be marked as invalid if the row or column containing the cell is removed. The valid state of a cell may be queried using the isValid() function.

Text content may be set on the cell using setText(). If you want higher fidelity control over the cell content, retrieve its associated text frame with textFrame() and work with that.

A cell has a bounding rectangle. This is the rectangle on the table grid containing the cell. It may be queried using the boundingRect() function.

A cell also has a content rectangle. This is the bounding rect of the cell adjusted for any cell paddings and borders. It may be queried using the contentRect() function.

Constructor & Destructor Documentation

TableCell::TableCell ( )
inline

Constructs a new invalid table cell.

The cell will report a row, column, row span and column span of -1. This behavior is relied upon in places such as the painting code, so don't change it.


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