clLayouts::Layouts Class Reference

Handling the Layouts. More...

List of all members.

Public Member Functions
def	__init__
	The Constructor.
def	register_layout
	Registers a layout.
def	show_layout
	Show a layout This methode is the central layout function.
Public Attributes
	layouts
	Dictionary filled with layouts later.
	toolbars
	Dictionary filled with the layouts' toolbars later.
	current_layout
	Holds the currently shown layout.

---

Detailed Description

Handling the Layouts.

You'll have to register your custon Layout here.

Definition at line 31 of file __init__.py.

---

Member Function Documentation

def clLayouts::Layouts::register_layout	(		self,
			layout_name,
			layout_class
	)

Registers a layout.

Each Layout needs a methode draw() and a subclass called ToolBar(). See layout-draw and layout-toolbar.

Parameters:

	self	Object Pointer
	layout_name	The name of the layout to register
	layout_class	The layout class to call when you want you Layout to be shown

Returns:

None

Definition at line 51 of file __init__.py.

def clLayouts::Layouts::show_layout	(		self,
			layout,
			data1 = None,
			data2 = None,
			data3 = None,
			data4 = None,
			fromhistory = False,
			who_called = ""
	)

Show a layout This methode is the central layout function.

When you've registered your layout, you can show it calling this function.

Parameters:

	self	Object Pointer
	layout	The layout to show (as registered in register_layout() before)
	data1	Optional - Data you want to pass to your layout's draw() methode
	data2	Optional - Data you want to pass to your layout's draw() methode
	data3	Optional - Data you want to pass to your layout's draw() methode
	data4	Optional - Data you want to pass to your layout's draw() methode
	fromhistory	Optional bool - default is False - If set to True the page won't be stored in hinstory
	who_called	Optional - for debugging perpose only - which methode called this?

Returns:

None

Todo:

• use *args or **kargs as params instead of data(n)

Definition at line 72 of file __init__.py.

---

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

• clLayouts/__init__.py