Listing Class Reference

Inheritance diagram for Listing:

Public Member Functions
def	__init__ (self, language='XML')
def	add (self, text='')
def	finish (self, **kwargs)

Detailed Description

Used for wrapping code in a listing environment

Definition at line 196 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			language = 'XML'
	)

Calls super-class initialize and adds initial text to output
    @param text intial text, usually you want to give a raw string r"some text"

Reimplemented from LatexObject.

Definition at line 201 of file b2latex.py.

    def __init__(self, language='XML'):
        """
        Calls super-class initialize and adds initial text to output
            @param text intial text, usually you want to give a raw string r"some text"
        """
        super().__init__()
        
        self.output += r'\lstset{language=' + language + '}\n'
        self.output += r'\begin{lstlisting}[breaklines=true]' + '\n'
 

Member Function Documentation

add()

def add	(		self,
			text = ''
	)

Adds code to the output
    @param code which is wrapped in the listing environment

Reimplemented from LatexObject.

Definition at line 211 of file b2latex.py.

    def add(self, text=''):
        """
        Adds code to the output
            @param code which is wrapped in the listing environment
        """
        self.output += str(text)
        return self
 

finish()

def finish	(		self,
		**	kwargs
	)

Finish the generation of the lsiting environment

Reimplemented from LatexObject.

Definition at line 219 of file b2latex.py.

    def finish(self, **kwargs):
        """
        Finish the generation of the lsiting environment
        """
        
        self.output += r'\end{lstlisting}'
        return self
 
 

---

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

• framework/scripts/B2Tools/b2latex.py