Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
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 ()
  More...
 
 QTextTableFormat (QTextTableFormat copy)
 
override void CreateProxy ()
 
new void ClearColumnWidthConstraints ()
  More...
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QTextFrameFormat
 QTextFrameFormat ()
  More...
 
 QTextFrameFormat (QTextFrameFormat copy)
 
new void SetHeight (double height)
  More...
 
new void SetWidth (double width)
  More...
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QTextFormat
override bool Equals (object o)
 
override int GetHashCode ()
 
 QTextFormat ()
  More...
 
 QTextFormat (QTextFormat rhs)
  More...
 
 QTextFormat (int type)
  More...
 
new bool BoolProperty (int propertyId)
  More...
 
new QBrush BrushProperty (int propertyId)
  More...
 
new void ClearBackground ()
  More...
 
new void ClearForeground ()
  More...
 
new void ClearProperty (int propertyId)
  More...
 
new QColor ColorProperty (int propertyId)
  More...
 
new double DoubleProperty (int propertyId)
  More...
 
new bool HasProperty (int propertyId)
  More...
 
new int IntProperty (int propertyId)
  More...
 
new QTextLength LengthProperty (int propertyId)
  More...
 
new
System.Collections.Generic.List
< QTextLength
LengthVectorProperty (int propertyId)
  More...
 
new void Merge (QTextFormat other)
  More...
 
new QPen PenProperty (int propertyId)
  More...
 
new object property (int propertyId)
  More...
 
new void SetProperty (int propertyId, object value)
  More...
 
new void SetProperty (int propertyId, System.Collections.Generic.List< QTextLength > lengths)
  More...
 
new string StringProperty (int propertyId)
  More...
 
new QTextBlockFormat ToBlockFormat ()
  More...
 
new QTextCharFormat ToCharFormat ()
  More...
 
new QTextFrameFormat ToFrameFormat ()
  More...
 
new QTextImageFormat ToImageFormat ()
  More...
 
new QTextListFormat ToListFormat ()
  More...
 
new QTextTableCellFormat ToTableCellFormat ()
  More...
 
new QTextTableFormat ToTableFormat ()
  More...
 
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

Qt.AlignmentFlag Alignment [get, set]
  More...
 
double CellPadding [get, set]
  More...
 
double CellSpacing [get, set]
  More...
 
System.Collections.Generic.List
< QTextLength
ColumnWidthConstraints [get, set]
  More...
 
int Columns [get, set]
  More...
 
int HeaderRowCount [get, set]
  More...
 
bool IsValid [get]
  More...
 
- Properties inherited from QtGui.QTextFrameFormat
double Border [get, set]
  More...
 
QBrush BorderBrush [get, set]
  More...
 
QTextFrameFormat.BorderStyle borderStyle [get, set]
  More...
 
double BottomMargin [get, set]
  More...
 
QTextLength Height [get, set]
  More...
 
double LeftMargin [get, set]
  More...
 
double Margin [get, set]
  More...
 
double Padding [get, set]
  More...
 
QTextFormat.PageBreakFlag PageBreakPolicy [get, set]
  More...
 
QTextFrameFormat.Position position [get, set]
  More...
 
double RightMargin [get, set]
  More...
 
double TopMargin [get, set]
  More...
 
QTextLength Width [get, set]
  More...
 
bool IsValid [get]
  More...
 
- Properties inherited from QtGui.QTextFormat
QBrush Background [get, set]
  More...
 
QBrush Foreground [get, set]
  More...
 
Qt.LayoutDirection LayoutDirection [get, set]
  More...
 
int ObjectIndex [get, set]
  More...
 
int ObjectType [get, set]
  More...
 
bool IsBlockFormat [get]
  More...
 
bool IsCharFormat [get]
  More...
 
bool IsFrameFormat [get]
  More...
 
bool IsImageFormat [get]
  More...
 
bool IsListFormat [get]
  More...
 
bool IsTableCellFormat [get]
  More...
 
bool IsTableFormat [get]
  More...
 
bool IsValid [get]
  More...
 
System.Collections.Generic.Dictionary
< System.Int32, System.Object > 
Properties [get]
  More...
 
int PropertyCount [get]
  More...
 
int Type [get]
  More...
 
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 one, QTextFormat rhs)
  More...
 
static bool operator== (QTextFormat one, QTextFormat rhs)
  More...
 
- 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.

Here is the call graph for this function:

QtGui.QTextTableFormat.QTextTableFormat ( QTextFormat  fmt)
protected

Here is the call graph for this function:

QtGui.QTextTableFormat.QTextTableFormat ( QTextTableFormat  copy)

Here is the call graph for this function:

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.

Here is the caller graph for this function:

new void QtGui.QTextTableFormat.Dispose ( )

Property Documentation

Qt.AlignmentFlag QtGui.QTextTableFormat.Alignment
getset

Returns the table's alignment.

Sets the table's alignment.

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.

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.

int QtGui.QTextTableFormat.Columns
getset

Returns the number of columns specified by the table format.

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.

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.

bool QtGui.QTextTableFormat.IsValid
get

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