LatexObject Class Reference

Inheritance diagram for LatexObject:

Public Member Functions
def	__init__ (self)
def	__str__ (self)
def	add (self)
def	finish (self)
def	save (self, filename, compile=False)

Public Attributes
	output
	Stores the outputted latex-code.

Detailed Description

Common base class of all Latex Wrapper objects

Definition at line 14 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor, initialize output with empty string

Reimplemented in Itemize, Graphics, and DefineColourList.

Definition at line 19 of file b2latex.py.

    def __init__(self):
        """
        Constructor, initialize output with empty string
        """
        
        self.output = ''
 

Member Function Documentation

__str__()

def __str__

(

self

)

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

Definition at line 26 of file b2latex.py.

add()

def add

(

self

)

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

Definition at line 32 of file b2latex.py.

finish()

def finish

(

self

)

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.

save()

def save	(		self,
			filename,
			compile = False
	)

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