Class layout

Introduction
Screenshots
License
Download
Userinterface
Function Index
White Papers
Community
Contact

no help

layout Class Reference

main widget class more...

Public Member Functions

void	choose() file open
void	chooseImport() file import
void	deleteActuellCell() delete
int	executeMacro(string filename, string parameter="") execute macro
int	getBool(string caption,string lable) get bool
double	getDouble(string caption,string lable,double value=0) get double
int	getInteger(string caption,string lable, int value=0) get integer
string	getOpenFilename() get open filename
string	getSaveFilename() get save filename
string	getText(string caption,string lable,string value="") get text
void	group() group selected elements
void	hideToolBar(string name) hide tool bar
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 label) show message
void	showStatus(string lable) show message in statusbar
textEdit*	showTextEditor() show text editor
void	showToolBar(string name) show tool bar
void	toolBarAdd(string name,string buttons) add tool bar
void	trigger3dRenderAll() trigger 3d render all
void	trigger3dRenderAuto() trigger 3d render auto
void	trigger3dRenderSelect() trigger 3d render select

Public Attributes

barcodeModule*	barcodeTool barcode tool
booleanHandler*	booleanTool boolean tool
static bool	debug debug mode
drawingField*	drawing head class of the drawing
drc*	drcTool design rule checker tool
string	filename filename
netListModule*	netlistTool netlist tool
view3dModule*	view3dTool view 3d tool

Detailed Description

This class is the main widget of the windows from which the macro was executed. It is directly accessible 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. drawingField

Member Documentation

netListModule* layout::netlistTool

netlist tool

The netlist utilities are accessible via this class.

barcodeModule* layout::barcodeTool

barcode tool

The barcode utilities are accessible via this class.

view3dModule* layout::view3dTool

view 3d tool

The 3d view is accessable via this class

booleanHandler* layout::booleanTool

boolean tool

The boolean utilities are accessible via this class. booleanHandler

drc* layout::drcTool

design rule checker tool

The design rule checker is accessible via this class. drc

drawingField* layout::drawing

head class of the drawing

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

string layout::filename

filename

This string hold the current filename.

void layout::trigger3dRenderAll()

trigger 3d render all

renderAll will be called after the macro terminates. OBSOLETE: Please use view3dTool->trigger3dRenderAll() instead.

void layout::trigger3dRenderSelect()

trigger 3d render select

renderSeclect will be called after the macro terminates. OBSOLETE: Please use view3dTool->trigger3dRenderSelect() instead.

void layout::trigger3dRenderAuto()

trigger 3d render auto

renderAuto will be called after the macro terminates. OBSOLETE: Please use view3dTool->trigger3dRenderAuto() instead.

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.

int layout::executeMacro(string filename, string parameter="")

execute macro

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

Parameters:

filename

filename of the macro.

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::save()

file save

The actual 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::screenshot()

screenshot

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

void layout::print()

A printer dialog will be opened.

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. OBSOLETE: Please use drawing->saveScreenshot(QString filename) instead.

void layout::group()

group selected elements

All selected elements are moved to a new cell. A correlating cellref will be added. OBSOLETE: Please use drawing->group() instead.

void layout::deleteActuellCell()

delete

After a confirmation the current display cell will be deleted. If there are no more cell in the drawing, a new empty cell will be created. OBSOLETE: Please use drawing->deleteCurrentCell() instead.

void layout::newCell()

new cell

A new empty cell will be added, named with an unused cell name and it is set as current cell. OBSOLETE: Please use drawing->newCell() instead.

string layout::getText(string caption,string lable,string value="")

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.
value	default value

Returns:

returns the text set by the user.

int layout::getInteger(string caption,string lable, int value=0)

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.
value	default value

Returns:

returns the integer set by the user.

double layout::getDouble(string caption,string lable,double value=0)

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.
value	default value

Returns:

returns the double set by the user.

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

get bool

The user will be prompted to enter a bool.

Parameters:

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

Returns:

returns 0 if yes, otherwise 1

string layout::getOpenFilename()

get open filename

A file open dialog is shown.

Returns:

returns a string with the filename or a empty string if canceled

string layout::getSaveFilename()

get save filename

A file save dialog is shown.

Returns:

returns a string with the filename or a empty string if canceled

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.

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

show message

A message will be displayed.

Parameters:

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

textEdit* layout::showTextEditor()

show text editor

Will create a new text Editor window in a thread save way.

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.

layout->setShortcut("&Sector",""); // remove old 'F' shortkey
layout->setShortcut("&Zoom Fit All","F"); // set 'F' to zoom fit
layout->setShortcut("&Zoom Fit Selection","Shift+F"); // set 'Shift F' to zoom fit selection

void layout::hideToolBar(string name)

hide tool bar

Hides the named toolbar.

void layout::showToolBar(string name)

show tool bar

Shows the named toolbar.

void layout::toolBarAdd(string name,string buttons)

add tool bar

Add a new tool bar, separate multipli buttons with a ';'.

layout->toolBarAdd("my toolbar","New Layout;Zoom Mouse;Code 39;Quit");

static bool layout::debug

debug mode

True if the debug mode is on.