LongTable Class Reference

Inheritance diagram for LongTable:

Collaboration diagram for LongTable:

Public Member Functions
def	__init__ (self, columnspecs, caption, format_string, head)
def	add (self, *args, **kwargs)
def	finish (self, tail='')
def	__str__ (self)
def	add (self)
def	finish (self)
def	save (self, filename, compile=False)

Public Attributes
	format_string
	python-style format-string used to generate a new row out of a given dictionary.
	output
	Stores the outputted latex-code.

Detailed Description

Creates a longtable in latex. A longtable can span multiple pages
and is automatically wrapped.

Definition at line 377 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			columnspecs,
			caption,
			format_string,
			head
	)

Calls super-class init, begins centered environment and longtable environment.
Defines caption and head of the table.
    @param columnspecs of the longtable, something like:
            rclp{7cm} 4 columns, right-center-left aligned and one paragraph column with a width of 7cm
    @param caption string or object with implicit string conversion used as caption.
    @param format_string  python-style format-string used to generate a new row out of a given dictionary.
    @param head of the table

Definition at line 383 of file b2latex.py.

Member Function Documentation

__str__()

def __str__ (   self )

inherited

Transform object to string, in this case, just returns .the generated latex-code

Definition at line 26 of file b2latex.py.

add() [1/2]

def add (   self )

inherited

Add latex-code to the output string.
This method is usually overriden in the subclasses

Definition at line 32 of file b2latex.py.

add() [2/2]

def add	(		self,
		*	args,
		**	kwargs
	)

Add a new row to the longtable by generating the row using the format_string given in init
and the provided dictionary.
    @param args positional arguments used to generate the row using the python-style format string.
    @param kwargs dictionary used to generate the row using the python-style format-string.

Definition at line 403 of file b2latex.py.

finish() [1/2]

def finish (   self )

inherited

Finishes the generation of latex-code.
E.g. adds end latex-commands
This method is usually overriden in the subclasses

Reimplemented in Itemize, and Graphics.

Definition at line 39 of file b2latex.py.

finish() [2/2]

def finish	(		self,
			tail = ''
	)

Adds optional tail of the table, ends longtable and centered environment.
    @param tail optional tail, like head but at the bottom of the table.

Definition at line 413 of file b2latex.py.

save()

def save (   self,   filename,   compile = False  )

inherited

Saves the latex-code into a file, adds preamble and end of document,
and compiles the code if requested.
    @param filename latex-code is stored in this file, should end on .tex
    @param compile compile the .tex file using pdflatex into a .pdf file

Definition at line 47 of file b2latex.py.

---

The documentation for this class was generated from the following file:

• framework/scripts/B2Tools/b2latex.py