Macro Programming

layout Class Reference

main widget class More...

#include <layout.h>

List of all members.

Public Member Functions
void	choose ()
	file open
void	chooseImport ()
	file import
void	deleteActuellCell ()
	delete
int	executeMacro (string filename)
	execute macro
double	getDouble (string caption, string lable)
	get double
int	getInteger (string caption, string lable)
	get integer
string	getText (string caption, string lable)
	get text
void	group ()
	group selected elements
void	newCell ()
	new cell
void	print ()
	print
void	save ()
	file save
void	saveAs ()
	file save as
void	saveScreenshot (string filename)
	screenshot
void	screenshot ()
	screenshot
void	setCell ()
	set cell
void	setCellname ()
	set cellname
bool	setShortcut (string function, string key)
	set shortcut
void	showMessage (string caption, string lable)
	show message
void	showStatus (string lable)
	show message in statusbar
Public Attributes
booleanHandler *	booleanTool
	boolean tool
drawingField *	drawing
	head class of the drawing
drc *	drcTool
	design rule checker tool
string	filename
	filename
Static Public Attributes
static bool	debug
	debug mode

---

Detailed Description

main widget class

This class is the main widget of the windows from which the macro was executed. It is directly accessable via the classname "layout".

  layout->filename="/var/layouts/samples1.gds";
  layout->newCell();

Most methods of this call require a user dialog. A direct access of the drawing is possible via the member drawing.

See also:

drawingField

---

Member Function Documentation

void layout::choose

(

)

file open

It opened a file dialog. The selected file will be loaded.

void layout::chooseImport

(

)

file import

It opened a file dialog. The selected file will be imported.(= add to the existing file)

void layout::deleteActuellCell

(

)

delete

After a comfirmation the current display cell will be deleted. If there are no more cell in the drawing, a new empty cell will be created.

int layout::executeMacro

(

string

filename

)

execute macro

Another macro is executed. The execution of this macro stoped until the termination of the new started macro.

Parameters:

filename

filename of the macro.

double layout::getDouble	(	string	caption,
		string	lable
	)

get double

The user will be prompted to enter a double.

Parameters:

	caption	the title of the window.
	lable	this string will be displayed inside the window.

Returns:

returns the double set by the user.

int layout::getInteger	(	string	caption,
		string	lable
	)

get integer

The user will be prompted to enter a integer.

Parameters:

	caption	the title of the window.
	lable	this string will be displayed inside the window.

Returns:

returns the integer set by the user.

string layout::getText	(	string	caption,
		string	lable
	)

get text

  The user will be prompted to enter a text.

Parameters:

	caption	the title of the window.
	lable	this string will be displayed inside the window.

Returns:

returns the text set by the user.

void layout::group

(

)

group selected elements

All selected elements are moved to a new cell. A correlating cellref will be added.

void layout::newCell

(

)

new cell

A new empty cell will be added.

void layout::print

(

)

print

A printer dialog will be opened.

void layout::save

(

)

file save

The actuell file will be saved. If filename is empty, you will be prompted to enter a filename.

void layout::saveAs

(

)

file save as

You will be prompted to enter a filename. The actuell file will be saved.

void layout::saveScreenshot

(

string

filename

)

screenshot

The screen will be saved in the file with the name filename. The type is selected by the extension.

void layout::screenshot

(

)

screenshot

The screen will be saved. You will be prompted to enter a filename.

void layout::setCell

(

)

set cell

You will be prompted to select a cell. The cell will be displayed.

void layout::setCellname

(

)

set cellname

You will be prompted to enter a name for the current displayed cell.

bool layout::setShortcut	(	string	function,
		string	key
	)

set shortcut

Use this function to modify any existing shortcut. It returns true, if the modification was successful.

void layout::showMessage	(	string	caption,
		string	lable
	)

show message

A message will be displayed.

Parameters:

	caption	the title of the window.
	lable	this string will be displayed inside the window.

void layout::showStatus

(

string

lable

)

show message in statusbar

A message will be displayed in the statusbar for 2 seconds.

Parameters:

lable

this string will be displayed in the statusbar.

---

Member Data Documentation

booleanHandler* layout::booleanTool

boolean tool

The boolean utilities are accessable via this class.

See also:

booleanHandler

bool layout::debug [static]

debug mode

True if the debug mode is on.

drawingField* layout::drawing

head class of the drawing

This class is the main class of the drawing. It holds all relevant information.

See also:

drawingField

drc* layout::drcTool

design rule checker tool

The design rule checker is accessable via this class.

See also:

drc

string layout::filename

filename

This string hold the current filename.