QtGui.QTextTableFormat Class Reference

The QTextTableFormat class provides formatting information for tables in a QTextDocument. More...

Inheritance diagram for QtGui.QTextTableFormat:

Collaboration diagram for QtGui.QTextTableFormat:

Public Member Functions
	QTextTableFormat ()
	QTextTableFormat (QTextTableFormat copy)
override void	CreateProxy ()
new void	ClearColumnWidthConstraints ()
new bool	IsValid ()
new void	Dispose ()
Public Member Functions inherited from QtGui.QTextFrameFormat
	QTextFrameFormat ()
	QTextFrameFormat (QTextFrameFormat copy)
new bool	IsValid ()
new void	SetHeight (double height)
new void	SetWidth (double width)
new void	Dispose ()
Public Member Functions inherited from QtGui.QTextFormat
override bool	Equals (object o)
override int	GetHashCode ()
	QTextFormat ()
	QTextFormat (QTextFormat rhs)
	QTextFormat (int type)
new bool	BoolProperty (int propertyId)
new QBrush	BrushProperty (int propertyId)
new void	ClearBackground ()
new void	ClearForeground ()
new void	ClearProperty (int propertyId)
new QColor	ColorProperty (int propertyId)
new double	DoubleProperty (int propertyId)
new bool	HasProperty (int propertyId)
new int	IntProperty (int propertyId)
new bool	IsBlockFormat ()
new bool	IsCharFormat ()
new bool	IsFrameFormat ()
new bool	IsImageFormat ()
new bool	IsListFormat ()
new bool	IsTableCellFormat ()
new bool	IsTableFormat ()
new bool	IsValid ()
new QTextLength	LengthProperty (int propertyId)
new System.Collections.Generic.List < QTextLength >	LengthVectorProperty (int propertyId)
new void	Merge (QTextFormat other)
new QPen	PenProperty (int propertyId)
new System.Collections.Generic.Dictionary < System.Int32, System.Object >	Properties ()
new object	property (int propertyId)
new int	PropertyCount ()
new void	SetProperty (int propertyId, object value)
new void	SetProperty (int propertyId, System.Collections.Generic.List< QTextLength > lengths)
new string	StringProperty (int propertyId)
new QTextBlockFormat	ToBlockFormat ()
new QTextCharFormat	ToCharFormat ()
new QTextFrameFormat	ToFrameFormat ()
new QTextImageFormat	ToImageFormat ()
new QTextListFormat	ToListFormat ()
new QTextTableCellFormat	ToTableCellFormat ()
new QTextTableFormat	ToTableFormat ()
new int	Type ()
new void	Dispose ()

Protected Member Functions
	QTextTableFormat (System.Type dummy)
	QTextTableFormat (QTextFormat fmt)
Protected Member Functions inherited from QtGui.QTextFrameFormat
	QTextFrameFormat (System.Type dummy)
	QTextFrameFormat (QTextFormat fmt)
Protected Member Functions inherited from QtGui.QTextFormat
	QTextFormat (System.Type dummy)

Properties
new Qt.AlignmentFlag	Alignment [get, set]
new double	CellPadding [get, set]
new double	CellSpacing [get, set]
new System.Collections.Generic.List < QTextLength >	ColumnWidthConstraints [get, set]
new int	Columns [get, set]
new int	HeaderRowCount [get, set]
Properties inherited from QtGui.QTextFrameFormat
new double	Border [get, set]
new QBrush	BorderBrush [get, set]
new QTextFrameFormat.BorderStyle	borderStyle [get, set]
new double	BottomMargin [get, set]
new QTextLength	Height [get, set]
new double	LeftMargin [get, set]
new double	Margin [get, set]
new double	Padding [get, set]
new QTextFormat.PageBreakFlag	PageBreakPolicy [get, set]
new QTextFrameFormat.Position	position [get, set]
new double	RightMargin [get, set]
new double	TopMargin [get, set]
new QTextLength	Width [get, set]
Properties inherited from QtGui.QTextFormat
new QBrush	Background [get, set]
new QBrush	Foreground [get, set]
new Qt.LayoutDirection	LayoutDirection [get, set]
new int	ObjectIndex [get, set]
new int	ObjectType [get, set]
virtual System.IntPtr	SmokeObject [get, set]
static new QMetaObject	StaticMetaObject [get]

Additional Inherited Members
Public Types inherited from QtGui.QTextFrameFormat
enum	BorderStyle {   BorderStyle_Dashed = 2, BorderStyle_DotDash = 5, BorderStyle_DotDotDash = 6, BorderStyle_Dotted = 1,   BorderStyle_Double = 4, BorderStyle_Groove = 7, BorderStyle_Inset = 9, BorderStyle_None = 0,   BorderStyle_Outset = 10, BorderStyle_Ridge = 8, BorderStyle_Solid = 3 }
	More...
enum	Position { FloatLeft = 1, FloatRight = 2, InFlow = 0 }
	More...
Static Public Member Functions inherited from QtGui.QTextFormat
static bool	operator!= (QTextFormat arg1, QTextFormat arg2)
static bool	operator== (QTextFormat arg1, QTextFormat arg2)
Protected Attributes inherited from QtGui.QTextFormat
SmokeInvocation	interceptor

Detailed Description

The QTextTableFormat class provides formatting information for tables in a QTextDocument.

A table is a group of cells ordered into rows and columns. Each table contains at least one row and one column. Each cell contains a block. Tables in rich text documents are formatted using the properties defined in this class.

Tables are horizontally justified within their parent frame according to the table's alignment. This can be read with the alignment() function and set with setAlignment().

Cells within the table are separated by cell spacing. The number of pixels between cells is set with setCellSpacing() and read with cellSpacing(). The contents of each cell is surrounded by cell padding. The number of pixels between each cell edge and its contents is set with setCellPadding() and read with cellPadding().

The table's background color can be read with the background() function, and can be specified with setBackground(). The background color of each cell can be set independently, and will control the color of the cell within the padded area.

The table format also provides a way to constrain the widths of the columns in the table. Columns can be assigned a fixed width, a variable width, or a percentage of the available width (see QTextLength). The columns() function returns the number of columns with constraints, and the columnWidthConstraints() function returns the constraints defined for the table. These quantities can also be set by calling setColumnWidthConstraints() with a vector containing new constraints. If no constraints are required, clearColumnWidthConstraints() can be used to remove them.

See also QTextTable, QTextTableCell, and QTextLength.

Constructor & Destructor Documentation

QtGui.QTextTableFormat.QTextTableFormat ( System.Type  dummy )

protected

QtGui.QTextTableFormat.QTextTableFormat

(

)

Constructs a new table format object.

QtGui.QTextTableFormat.QTextTableFormat ( QTextFormat  fmt )

protected

Constructs a new table format object.

QtGui.QTextTableFormat.QTextTableFormat

(

QTextTableFormat

copy

)

Constructs a new table format object.

Member Function Documentation

new void QtGui.QTextTableFormat.ClearColumnWidthConstraints

(

)

Clears the column width constraints for the table.

See also columnWidthConstraints() and setColumnWidthConstraints().

override void QtGui.QTextTableFormat.CreateProxy ( )

virtual

Reimplemented from QtGui.QTextFrameFormat.

new void QtGui.QTextTableFormat.Dispose

(

)

new bool QtGui.QTextTableFormat.IsValid

(

)

Returns true if this table format is valid; otherwise returns false.

Property Documentation

new Qt.AlignmentFlag QtGui.QTextTableFormat.Alignment

getset

Returns the table's alignment.

Sets the table's alignment.

new double QtGui.QTextTableFormat.CellPadding

getsetadd

Returns the table's cell padding. This describes the distance between the border of a cell and its contents.

Sets the cell padding for the table. This determines the distance between the border of a cell and its contents.

new double QtGui.QTextTableFormat.CellSpacing

getset

Returns the table's cell spacing. This describes the distance between adjacent cells.

Sets the cell spacing for the table. This determines the distance between adjacent cells.

new int QtGui.QTextTableFormat.Columns

getset

Returns the number of columns specified by the table format.

new System.Collections.Generic.List<QTextLength> QtGui.QTextTableFormat.ColumnWidthConstraints

getset

Returns a list of constraints used by this table format to control the appearance of columns in a table.

Sets the column width constraints for the table.

new int QtGui.QTextTableFormat.HeaderRowCount

getset

Returns the number of rows in the table that define the header.

This function was introduced in Qt 4.2.

Declares the first count rows of the table as table header. The table header rows get repeated when a table is broken across a page boundary.

This function was introduced in Qt 4.2.