String Class Reference

Inheritance diagram for String:

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

Public Attributes
	output
	output string

Detailed Description

Used for wrapping conventionel text into latex-code.
Has to possibility to handle python-style format-placeholders

Definition at line 163 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			text = ''
	)

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 169 of file b2latex.py.

    def __init__(self, text=''):
        """
        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 += str(text)
 

Member Function Documentation

add()

def add	(		self,
			text = ''
	)

Adds an object to the output, can contain python-placeholders
    @param text string or object with implicit string conversion (like LatexObject)

Reimplemented from LatexObject.

Definition at line 178 of file b2latex.py.

    def add(self, text=''):
        """
        Adds an object to the output, can contain python-placeholders
            @param text string or object with implicit string conversion (like LatexObject)
        """
        self.output += str(text)
        return self
 

finish()

def finish	(		self,
		**	kwargs
	)

Finish the generation of the string by replacing possible placehholders with the given dictionary
    @param kwargs dictionary used to replace placeholders

Reimplemented from LatexObject.

Definition at line 186 of file b2latex.py.

    def finish(self, **kwargs):
        """
        Finish the generation of the string by replacing possible placehholders with the given dictionary
            @param kwargs dictionary used to replace placeholders
        """
        
        self.output = self.output.format(**kwargs) + '\n'
        return self
 
 

Member Data Documentation

output

output

output string

Definition at line 192 of file b2latex.py.

---

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

• framework/scripts/B2Tools/b2latex.py