Itemize Class Reference

Inheritance diagram for Itemize:

Public Member Functions
def	__init__ (self)
def	add (self, item)
def	finish (self)

Public Attributes
	amount
	number of items

Detailed Description

Creates a itemized list in latex.

Definition at line 344 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Calls super-class init and begins itemize

Reimplemented from LatexObject.

Definition at line 349 of file b2latex.py.

    def __init__(self):
        """
        Calls super-class init and begins itemize
        """
        super().__init__()
        
        self.amount = 0
        self.output += r"\begin{itemize}"
 

Member Function Documentation

add()

def add	(		self,
			item
	)

Adds another item.
    @param item string or object with implicit string conversion used as item

Reimplemented from LatexObject.

Definition at line 358 of file b2latex.py.

    def add(self, item):
        """
        Adds another item.
            @param item string or object with implicit string conversion used as item
        """
        self.amount += 1
        self.output += r"\item " + str(item) + '\n'
        return self
 

finish()

def finish

(

self

)

Finishes the generation of latex-code.

Reimplemented from LatexObject.

Definition at line 367 of file b2latex.py.

    def finish(self):
        """
        Finishes the generation of latex-code.
        """
        if self.amount == 0:
            return ''
        self.output += r"\end{itemize}"
        return self
 
 

Member Data Documentation

amount

amount

number of items

Definition at line 355 of file b2latex.py.

---

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

• framework/scripts/B2Tools/b2latex.py