Scribus
Open source desktop publishing at your fingertips
TableBorder Class Reference

#include <tableborder.h>

Public Member Functions

 TableBorder ()
 Creates a new null table border. Null borders are used to indicate the absence of a border.
 
 TableBorder (double width, Qt::PenStyle style, const QString &color, double shade)
 Creates a new table border with a single border line with width, style and color.
 
double width () const
 Returns the width of the first table border line, or 0.0 if this is a null border.
 
QList< TableBorderLineborderLines () const
 Returns the list of border lines for this border in the order they should be painted.
 
TableBorderLine borderLine (int index) const
 
void addBorderLine (const TableBorderLine &borderLine)
 Adds borderLine to the list of border lines for this border.
 
void removeBorderLine (int index)
 
void replaceBorderLine (int index, const TableBorderLine &borderLine)
 
bool joinsWith (const TableBorder &other) const
 
bool isNull () const
 Returns true if this border has no border lines.
 
QString asString () const
 Returns a string representation of the border.
 

Detailed Description

The TableBorder class represents a border on a table or table cell.

It consists of a list of table border lines kept in descending order by width.

Member Function Documentation

TableBorderLine TableBorder::borderLine ( int  index) const

Returns the border line at index from the list of border lines for this border, or a default constructed border line if there is no border line at index.

bool TableBorder::joinsWith ( const TableBorder other) const
inline

Returns true if this border can be joined with other. Two borders can be joined if they are both not null and their list of border lines are equal.

void TableBorder::removeBorderLine ( int  index)

Removes the border line at index from the list of border lines for this border. If there is no border line at index, this method does nothing.

void TableBorder::replaceBorderLine ( int  index,
const TableBorderLine borderLine 
)

Replaces the border line at index in the list of border lines for this border. If there is no border line at index, this method does nothing.


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