Skip to content

PythonQt.QtGui.QTextTableFormat

QTextTableFormat

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

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.

Source: https://doc.qt.io/archives/qt-5.15/qtexttableformat.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
AnchorHref attribute Any (shared captured text)
AnchorName attribute Any (shared captured text)
BackgroundBrush attribute Any (shared captured text)
BackgroundImageUrl attribute Any (shared captured text)
BlockAlignment attribute Any (shared captured text)
BlockBottomMargin attribute Any (shared captured text)
BlockFormat attribute Any (shared captured text)
BlockIndent attribute Any (shared captured text)
BlockLeftMargin attribute Any (shared captured text)
BlockNonBreakableLines attribute Any (shared captured text)
BlockRightMargin attribute Any (shared captured text)
BlockTopMargin attribute Any (shared captured text)
BlockTrailingHorizontalRulerWidth attribute Any (shared captured text)
BorderStyle attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
BorderStyle_Dashed attribute Any (shared captured text)
BorderStyle_DotDash attribute Any (shared captured text)
BorderStyle_DotDotDash attribute Any (shared captured text)
BorderStyle_Dotted attribute Any (shared captured text)
BorderStyle_Double attribute Any (shared captured text)
BorderStyle_Groove attribute Any (shared captured text)
BorderStyle_Inset attribute Any (shared captured text)
BorderStyle_None attribute Any (shared captured text)
BorderStyle_Outset attribute Any (shared captured text)
BorderStyle_Ridge attribute Any (shared captured text)
BorderStyle_Solid attribute Any (shared captured text)
CharFormat attribute Any (shared captured text)
CssFloat attribute Any (shared captured text)
FirstFontProperty attribute Any (shared captured text)
FloatLeft attribute Any (shared captured text)
FloatRight attribute Any (shared captured text)
FontCapitalization attribute Any (shared captured text)
FontFamily attribute Any (shared captured text)
FontFixedPitch attribute Any (shared captured text)
FontHintingPreference attribute Any (shared captured text)
FontItalic attribute Any (shared captured text)
FontKerning attribute Any (shared captured text)
FontLetterSpacing attribute Any (shared captured text)
FontLetterSpacingType attribute Any (shared captured text)
FontOverline attribute Any (shared captured text)
FontPixelSize attribute Any (shared captured text)
FontPointSize attribute Any (shared captured text)
FontSizeAdjustment attribute Any (shared captured text)
FontSizeIncrement attribute Any (shared captured text)
FontStretch attribute Any (shared captured text)
FontStrikeOut attribute Any (shared captured text)
FontStyleHint attribute Any (shared captured text)
FontStyleStrategy attribute Any (shared captured text)
FontUnderline attribute Any (shared captured text)
FontWeight attribute Any (shared captured text)
FontWordSpacing attribute Any (shared captured text)
ForegroundBrush attribute Any (shared captured text)
FormatType attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
FrameBorder attribute Any (shared captured text)
FrameBorderBrush attribute Any (shared captured text)
FrameBorderStyle attribute Any (shared captured text)
FrameBottomMargin attribute Any (shared captured text)
FrameFormat attribute Any (shared captured text)
FrameHeight attribute Any (shared captured text)
FrameLeftMargin attribute Any (shared captured text)
FrameMargin attribute Any (shared captured text)
FramePadding attribute Any (shared captured text)
FrameRightMargin attribute Any (shared captured text)
FrameTopMargin attribute Any (shared captured text)
FrameWidth attribute Any (shared captured text)
FullWidthSelection attribute Any (shared captured text)
ImageHeight attribute Any (shared captured text)
ImageName attribute Any (shared captured text)
ImageObject attribute Any (shared captured text)
ImageWidth attribute Any (shared captured text)
InFlow attribute Any (shared captured text)
InvalidFormat attribute Any (shared captured text)
IsAnchor attribute Any (shared captured text)
LastFontProperty attribute Any (shared captured text)
LayoutDirection attribute Any (shared captured text)
LineHeight attribute Any (shared captured text)
LineHeightType attribute Any (shared captured text)
ListFormat attribute Any (shared captured text)
ListIndent attribute Any (shared captured text)
ListNumberPrefix attribute Any (shared captured text)
ListNumberSuffix attribute Any (shared captured text)
ListStyle attribute Any (shared captured text)
NoObject attribute Any (shared captured text)
ObjectIndex attribute Any (shared captured text)
ObjectType attribute Any (shared captured text)
ObjectTypes attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
OutlinePen attribute Any (shared captured text)
PageBreakFlag attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
PageBreakFlags attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
PageBreakPolicy attribute Any (shared captured text)
PageBreak_AlwaysAfter attribute Any (shared captured text)
PageBreak_AlwaysBefore attribute Any (shared captured text)
PageBreak_Auto attribute Any (shared captured text)
Position attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
Property attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
TabPositions attribute Any (shared captured text)
TableCellBottomPadding attribute Any (shared captured text)
TableCellColumnSpan attribute Any (shared captured text)
TableCellLeftPadding attribute Any (shared captured text)
TableCellObject attribute Any (shared captured text)
TableCellPadding attribute Any (shared captured text)
TableCellRightPadding attribute Any (shared captured text)
TableCellRowSpan attribute Any (shared captured text)
TableCellSpacing attribute Any (shared captured text)
TableCellTopPadding attribute Any (shared captured text)
TableColumnWidthConstraints attribute Any (shared captured text)
TableColumns attribute Any (shared captured text)
TableFormat attribute Any (shared captured text)
TableHeaderRowCount attribute Any (shared captured text)
TableObject attribute Any (shared captured text)
TextIndent attribute Any (shared captured text)
TextOutline attribute Any (shared captured text)
TextToolTip attribute Any (shared captured text)
TextUnderlineColor attribute Any (shared captured text)
TextUnderlineStyle attribute Any (shared captured text)
TextVerticalAlignment attribute Any (shared captured text)
UserFormat attribute Any (shared captured text)
UserObject attribute Any (shared captured text)
UserProperty attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
alignment function (self) -> Any Returns the table's alignment.
background function (self) -> Any X.background() -> PythonQt.QtGui.QBrush (shared captured text)
boolProperty function (self, propertyId: Any) -> bool X.boolProperty(propertyId) -> bool (shared captured text)
border function (self) -> float X.border() -> float
borderBrush function (self) -> Any X.borderBrush() -> PythonQt.QtGui.QBrush
borderStyle function (self) -> Any
bottomMargin function (self) -> float X.bottomMargin() -> float
brushProperty function (self, propertyId: Any) -> Any X.brushProperty(propertyId) -> PythonQt.QtGui.QBrush (shared captured text)
cellPadding function (self) -> float X.cellPadding() -> float
cellSpacing function (self) -> float X.cellSpacing() -> float
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
clearBackground function (self) -> Any (shared captured text)
clearColumnWidthConstraints function (self) -> None Clears the column width constraints for the table.
clearForeground function (self) -> Any (shared captured text)
clearProperty function (self, propertyId: Any) -> Any (shared captured text)
colorProperty function (self, propertyId: Any) -> Any X.colorProperty(propertyId) -> PythonQt.QtGui.QColor (shared captured text)
columnWidthConstraints function (self) -> tuple X.columnWidthConstraints() -> tuple
columns function (self) -> int X.columns() -> int
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
doubleProperty function (self, propertyId: Any) -> float X.doubleProperty(propertyId) -> float (shared captured text)
foreground function (self) -> Any X.foreground() -> PythonQt.QtGui.QBrush (shared captured text)
hasProperty function (self, propertyId: Any) -> bool X.hasProperty(propertyId) -> bool (shared captured text)
headerRowCount function (self) -> int X.headerRowCount() -> int
height function (self) -> Any X.height() -> PythonQt.QtGui.QTextLength
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
intProperty function (self, propertyId: Any) -> int X.intProperty(propertyId) -> int (shared captured text)
isBlockFormat function (self) -> bool X.isBlockFormat() -> bool (shared captured text)
isCharFormat function (self) -> bool X.isCharFormat() -> bool (shared captured text)
isEmpty function (self) -> bool X.isEmpty() -> bool (shared captured text)
isFrameFormat function (self) -> bool X.isFrameFormat() -> bool (shared captured text)
isImageFormat function (self) -> bool X.isImageFormat() -> bool (shared captured text)
isListFormat function (self) -> bool X.isListFormat() -> bool (shared captured text)
isTableCellFormat function (self) -> bool X.isTableCellFormat() -> bool (shared captured text)
isTableFormat function (self) -> bool X.isTableFormat() -> bool (shared captured text)
isValid function (self) -> bool X.isValid() -> bool
layoutDirection function (self) -> Any (shared captured text)
leftMargin function (self) -> float X.leftMargin() -> float
lengthProperty function (self, propertyId: Any) -> Any X.lengthProperty(propertyId) -> PythonQt.QtGui.QTextLength (shared captured text)
lengthVectorProperty function (self, propertyId: Any) -> tuple X.lengthVectorProperty(propertyId) -> tuple (shared captured text)
margin function (self) -> float X.margin() -> float
merge function (self, other: Any) -> Any (shared captured text)
objectIndex function (self) -> int X.objectIndex() -> int (shared captured text)
objectType function (self) -> int X.objectType() -> int (shared captured text)
padding function (self) -> float X.padding() -> float
pageBreakPolicy function (self) -> Any
penProperty function (self, propertyId: Any) -> Any X.penProperty(propertyId) -> PythonQt.QtGui.QPen (shared captured text)
position function (self) -> Any
properties function (self) -> dict X.properties() -> dict (shared captured text)
property function (self, propertyId: Any) -> Any X.property(propertyId) -> object (shared captured text)
propertyCount function (self) -> int X.propertyCount() -> int (shared captured text)
readFrom function (self, arg__1: Any) -> Any (shared captured text)
rightMargin function (self) -> float X.rightMargin() -> float
setAlignment function (self, alignment: Any) -> None Sets the table's alignment.
setBackground function (self, brush: Any) -> Any (shared captured text)
setBorder function (self, border: Any) -> Any
setBorderBrush function (self, brush: Any) -> Any
setBorderStyle function (self, style: Any) -> Any
setBottomMargin function (self, margin: Any) -> Any
setCellPadding function (self, padding: float) -> None Sets the cell padding for the table.
setCellSpacing function (self, spacing: float) -> None Sets the cell spacing for the table.
setColumnWidthConstraints function (self, constraints: Any) -> None Sets the column width constraints for the table.
setColumns function (self, columns: int) -> None
setForeground function (self, brush: Any) -> Any (shared captured text)
setHeaderRowCount function (self, count: int) -> None Declares the first count rows of the table as table header.
setHeight function (self, height: Any) -> Any
setLayoutDirection function (self, direction: Any) -> Any (shared captured text)
setLeftMargin function (self, margin: Any) -> Any
setMargin function (self, margin: Any) -> Any
setObjectIndex function (self, object: Any) -> Any (shared captured text)
setObjectType function (self, type: Any) -> Any (shared captured text)
setPadding function (self, padding: Any) -> Any
setPageBreakPolicy function (self, arg0: flags) -> Any
setPosition function (self, f: Any) -> Any
setProperty function (self, propertyId: Any, value: Any) -> Any X.setProperty(propertyId, value) (shared captured text)
setRightMargin function (self, margin: Any) -> Any
setTopMargin function (self, margin: Any) -> Any
setWidth function (self, length: Any) -> Any
stringProperty function (self, propertyId: Any) -> str X.stringProperty(propertyId) -> str (shared captured text)
swap function (self, other: Any) -> Any (shared captured text)
toBlockFormat function (self) -> Any X.toBlockFormat() -> PythonQt.QtGui.QTextBlockFormat (shared captured text)
toCharFormat function (self) -> Any X.toCharFormat() -> PythonQt.QtGui.QTextCharFormat (shared captured text)
toFrameFormat function (self) -> Any X.toFrameFormat() -> PythonQt.QtGui.QTextFrameFormat (shared captured text)
toImageFormat function (self) -> Any X.toImageFormat() -> PythonQt.QtGui.QTextImageFormat (shared captured text)
toListFormat function (self) -> Any X.toListFormat() -> PythonQt.QtGui.QTextListFormat (shared captured text)
toTableCellFormat function (self) -> Any X.toTableCellFormat() -> PythonQt.QtGui.QTextTableCellFormat (shared captured text)
toTableFormat function (self) -> Any X.toTableFormat() -> PythonQt.QtGui.QTextTableFormat (shared captured text)
topMargin function (self) -> float X.topMargin() -> float
type function (self) -> int X.type() -> int (shared captured text)
width function (self) -> Any X.width() -> PythonQt.QtGui.QTextLength
writeTo function (self, arg__1: Any) -> Any (shared captured text)