machine.Structure.Structure Class Reference

Not instanciable mother class of all machine objects. More...

Inheritance diagram for machine.Structure.Structure:

List of all members.

Public Member Functions
def	__init__
	/!\ Must be redefined.
def	clone
	Returns a deep copy of the object.
def	write_document_header
	/!\ Must be redefined.
def	write_document_begins
	/!\ Must be redefined.
def	write_exercise_number
	/!\ Must be redefined.
def	write_jump_to_next_page
	/!\ Must be redefined.
def	reset_exercises_counter
	/!\ Must be redefined.
def	set_font_size_offset
	Sets the font_size_offset field.
def	set_redirect_output_to_str
	Sets the redirect_output_to_str field to True or False.
def	redirect_output_to_str
	Gets the value of redirect_output_to_str field.
def	translate_font_size
	turn the size keyword in language matching keyword
def	write_document_ends
	/!\ Must be redefined.
def	write_new_line
	/!\ Must be redefined.
def	write_new_line_twice
	/!\ Must be redefined.
def	write_math_style2
	/!\ Must be redefined.
def	write_math_style1
	/!\ Must be redefined.
def	write
	/!\ Must be redefined.
def	write_set_font_size_to
	/!\ Must be redefined.
def	write_table
	Writes a table filled with the given [strings].
def	write_layout
	Writes content arranged like in a table (but can be written.
def	type_string
	/!\ Must be redefined.
def	insert_picture
	/!\ Must be redefined.
def	insert_dashed_hline
	/!\ Must be redefined.
def	insert_vspace
	/!\ Must be redefined.

---

Detailed Description

Not instanciable mother class of all machine objects.

Definition at line 30 of file Structure.py.

---

Constructor & Destructor Documentation

def machine.Structure.Structure.__init__	(		self,
			language
	)

/!\ Must be redefined.

Constructor.

Warning:

Will raise an exception if not redefined

Parameters:

embedded_machine	The machine to be used
**options	Any options

Definition at line 42 of file Structure.py.

---

Member Function Documentation

def machine.Structure.Structure.insert_dashed_hline	(		self,
			options
	)

/!\ Must be redefined.

Returns a string containing the object to be displayed, according to the desired output format (LaTeX etc.)

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 225 of file Structure.py.

def machine.Structure.Structure.insert_picture	(		self,
			drawable_arg,
			options
	)

/!\ Must be redefined.

Returns a string containing the object to be displayed, according to the desired output format (LaTeX etc.)

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 214 of file Structure.py.

def machine.Structure.Structure.insert_vspace	(		self,
			options
	)

/!\ Must be redefined.

Returns a string containing the object to be displayed, according to the desired output format (LaTeX etc.)

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 237 of file Structure.py.

def machine.Structure.Structure.reset_exercises_counter

(

self

)

/!\ Must be redefined.

Writes to the output the exercises counter reinitializing command

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 99 of file Structure.py.

def machine.Structure.Structure.translate_font_size	(		self,
			arg
	)

turn the size keyword in language matching keyword

Warning:

if you chose a too low or too high value as font_size_offset,

then all the text will be either tiny or Huge.

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 124 of file Structure.py.

def machine.Structure.Structure.type_string	(		self,
			objct,
			options
	)

/!\ Must be redefined.

Returns a string containing the object to be displayed, according to the desired output format (LaTeX etc.)

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 204 of file Structure.py.

def machine.Structure.Structure.write	(		self,
			given_string,
			options
	)

/!\ Must be redefined.

Writes to the output the given string

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 167 of file Structure.py.

def machine.Structure.Structure.write_document_begins

(

self

)

/!\ Must be redefined.

Writes to the output the command to begin the document

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 77 of file Structure.py.

def machine.Structure.Structure.write_document_ends

(

self

)

/!\ Must be redefined.

Writes to the output the end of document command

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 132 of file Structure.py.

def machine.Structure.Structure.write_document_header

(

self

)

/!\ Must be redefined.

Write the complete header of the sheet to the output.

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 65 of file Structure.py.

def machine.Structure.Structure.write_exercise_number

(

self

)

/!\ Must be redefined.

Writes to the output the command displaying an exercise's title plus its number

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 85 of file Structure.py.

def machine.Structure.Structure.write_jump_to_next_page

(

self

)

/!\ Must be redefined.

Writes to the output the jump to next page command

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 92 of file Structure.py.

def machine.Structure.Structure.write_layout	(		self,
			size,
			col_widths,
			content,
			options
	)

Writes content arranged like in a table (but can be written.

 without using a table)

Parameters:

size	: (nb of columns, nb of lines)
col_widths	: [int]
content	: [strings] : borders=0|1|2|3... (not implemented yet) : unit='inch' etc. (check the possibilities...)

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 195 of file Structure.py.

def machine.Structure.Structure.write_math_style1	(		self,
			given_string
	)

/!\ Must be redefined.

Writes to the output the given string as a math. expression (2d option)

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 160 of file Structure.py.

def machine.Structure.Structure.write_math_style2	(		self,
			given_string
	)

/!\ Must be redefined.

Writes to the output the given string as a mathematical expression

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 153 of file Structure.py.

def machine.Structure.Structure.write_new_line	(		self,
			options
	)

/!\ Must be redefined.

Writes to the output the new line command

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 139 of file Structure.py.

def machine.Structure.Structure.write_new_line_twice	(		self,
			options
	)

/!\ Must be redefined.

Writes to the output two commands writing two new lines

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 146 of file Structure.py.

def machine.Structure.Structure.write_set_font_size_to	(		self,
			arg
	)

/!\ Must be redefined.

Writes to the output the command setting the text size

Warning:

Will raise an exception if not redefined

Reimplemented in machine.LaTeX.LaTeX.

Definition at line 174 of file Structure.py.

def machine.Structure.Structure.write_table	(		self,
			size,
			col_widths,
			content,
			options
	)

Writes a table filled with the given [strings].

Parameters:

size	: (nb of columns, nb of lines)
col_widths	: [int]
content	: [strings] : borders=0|1|2|3... (not implemented yet) : unit='inch' etc. (check the possibilities...)

Definition at line 184 of file Structure.py.

---

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

• mamk_misc/doc/mathmaker4doxygen/machine/Structure.py