sphinx.writers.latex.Table

class documentation

class Table: (source)

A table data

Method	`__init__`	Undocumented
Method	`add_cell`	Adds a new cell to a table.
Method	`cell`	Returns a cell object (i.e. rectangular area) containing given position.
Method	`get_colspec`	Returns a column spec of table.
Method	`get_table_type`	Returns the LaTeX environment name for the table.
Method	`is_longtable`	True if and only if table uses longtable environment.
Instance Variable	`align`	Undocumented
Instance Variable	`body`	Undocumented
Instance Variable	`caption`	Undocumented
Instance Variable	`cell_id`	Undocumented
Instance Variable	`cells`	Undocumented
Instance Variable	`classes`	Undocumented
Instance Variable	`col`	Undocumented
Instance Variable	`colcount`	Undocumented
Instance Variable	`colsep`	Undocumented
Instance Variable	`colspec`	Undocumented
Instance Variable	`colwidths`	Undocumented
Instance Variable	`has_oldproblematic`	Undocumented
Instance Variable	`has_problematic`	Undocumented
Instance Variable	`has_verbatim`	Undocumented
Instance Variable	`header`	Undocumented
Instance Variable	`row`	Undocumented
Instance Variable	`stubs`	Undocumented
Instance Variable	`styles`	Undocumented

def __init__(self, node): (source) ¶

Undocumented

Parameters
node:`Element`	Undocumented

def add_cell(self, height, width): (source) ¶

Adds a new cell to a table. It will be located at current position: (``self.row``, ``self.col``).

Parameters
height:`int`	Undocumented
width:`int`	Undocumented

def cell(self, row=None, col=None): (source) ¶

Returns a cell object (i.e. rectangular area) containing given position. If no option arguments: ``row`` or ``col`` are given, the current position; ``self.row`` and ``self.col`` are used to get a cell object by default.

Parameters
row:`int\|None`	Undocumented
col:`int\|None`	Undocumented
Returns
`TableCell\|None`	Undocumented

def get_colspec(self): (source) ¶

Returns a column spec of table. This is what LaTeX calls the 'preamble argument' of the used table environment. .. note:: The ``\X`` and ``T`` column type specifiers are defined in ``sphinxlatextables.sty``.