docutils.writers.latex2e.Table

class documentation

class Table(object): (source)

Constructor: Table(translator, latex_type)

View In Hierarchy

Manage a table while traversing.

Maybe change to a mixin defining the visit/departs, but then class Table internal variables are in the Translator.

Table style might be

Unknown Field: standard
horizontal and vertical lines
Unknown Field: booktabs
only horizontal lines (requires "booktabs" LaTeX package)
Unknown Field: borderless
no borders around table cells
Unknown Field: nolines
alias for borderless
Unknown Field: colwidths-auto
column widths determined by LaTeX
Unknown Field: colwidths-given
use colum widths from rST source
Method __init__ Undocumented
Method close Undocumented
Method depart_row Undocumented
Method depart_thead Undocumented
Method get Undocumented
Method get_caption Undocumented
Method get_closing Undocumented
Method get_colspecs Return column specification for longtable.
Method get_column_width Return columnwidth for current cell (not multicell).
Method get_entry_number Undocumented
Method get_latex_type Undocumented
Method get_multicolumn_width Return sum of columnwidths for multicell.
Method get_opening Undocumented
Method get_rowspan Undocumented
Method get_vertical_bar Undocumented
Method is_open Undocumented
Method is_stub_column Undocumented
Method need_recurse Undocumented
Method open Undocumented
Method set Undocumented
Method set_rowspan Undocumented
Method set_table_style Undocumented
Method visit_colspec Undocumented
Method visit_entry Undocumented
Method visit_row Undocumented
Method visit_thead Undocumented
Instance Variable borders Undocumented
Instance Variable caption Undocumented
Instance Variable colwidths_auto Undocumented
Instance Variable stubs Undocumented
Instance Variable _attrs Undocumented
Instance Variable _cell_in_row Undocumented
Instance Variable _col_specs Undocumented
Instance Variable _col_width Undocumented
Instance Variable _in_head Undocumented
Instance Variable _in_thead Undocumented
Instance Variable _latex_type Undocumented
Instance Variable _open Undocumented
Instance Variable _rowspan Undocumented
Instance Variable _translator Undocumented
def __init__(self, translator, latex_type): (source)

Undocumented

def close(self): (source)

Undocumented

def depart_row(self): (source)

Undocumented

def depart_thead(self): (source)

Undocumented

def get(self, attr): (source)

Undocumented

def get_caption(self): (source)

Undocumented

def get_closing(self): (source)

Undocumented

def get_colspecs(self, node): (source)

Return column specification for longtable.

Assumes reST line length being 80 characters. Table width is hairy.

ABC DEF

usually gets to narrow, therefore we add 1 (fiddlefactor).

def get_column_width(self): (source)

Return columnwidth for current cell (not multicell).

def get_entry_number(self): (source)

Undocumented

def get_latex_type(self): (source)

Undocumented

def get_multicolumn_width(self, start, len_): (source)

Return sum of columnwidths for multicell.

def get_opening(self, width='\\linewidth'): (source)

Undocumented

def get_rowspan(self, cell): (source)

Undocumented

def get_vertical_bar(self): (source)

Undocumented

def is_open(self): (source)

Undocumented

def is_stub_column(self): (source)

Undocumented

def need_recurse(self): (source)

Undocumented

def open(self): (source)

Undocumented

def set(self, attr, value): (source)

Undocumented

def set_rowspan(self, cell, value): (source)

Undocumented

def set_table_style(self, table_style, classes): (source)

Undocumented

def visit_colspec(self, node): (source)

Undocumented

def visit_entry(self): (source)

Undocumented

def visit_row(self): (source)

Undocumented

def visit_thead(self): (source)

Undocumented

borders = (source)

Undocumented

caption: list = (source)

Undocumented

colwidths_auto = (source)

Undocumented

stubs: list = (source)

Undocumented

_attrs: dict = (source)

Undocumented

_cell_in_row = (source)

Undocumented

_col_specs = (source)

Undocumented

_col_width: list = (source)

Undocumented

_in_head: bool = (source)

Undocumented

_in_thead: int = (source)

Undocumented

_latex_type = (source)

Undocumented

_open: bool = (source)

Undocumented

_rowspan = (source)

Undocumented

_translator = (source)

Undocumented