LayoutExport Class Reference

The LayoutExport JavaScript class. Pop up a dialog, render layout and manage the export progress bar. More...

Public Slots
bool	execDialog (LayoutExportParams *params, bool showExportMultiple, bool showImageSize, String &dialogTitle)
	Show the Layout Export dialog. More...
bool	addRender (LayoutExportParams *params)
	Add a node to be rendered. More...
void	flush ()
	Render the nodes. More...
String	outputFilePath (LayoutExportParams *params)
	Get the path to the output files. More...
bool	save (LayoutExportParams *params)
void	saveXli (LayoutExportParams *params)

Progress Bar Methods
void	updateProgress (int progress)
void	showProgress (int totalSteps)
void	hideProgress ()
void	setProgressLabel (String lbl)
bool	progressCanceled ()

Detailed Description

The LayoutExport JavaScript class. Pop up a dialog, render layout and manage the export progress bar.

Member Function Documentation

addRender

bool LayoutExport::addRender ( LayoutExportParams *  params )

slot

Add a node to be rendered.

Parameters

params

The layout export parameters of the dialog when the dialog is closed. Passed as a reference.

Returns

True if the parameters are valid and the scene is in a good state for being rendered.

execDialog

bool LayoutExport::execDialog ( LayoutExportParams *  params, bool  showExportMultiple, bool  showImageSize, String &  dialogTitle  )

slot

Show the Layout Export dialog.

Parameters

params	The layout export parameters of the dialog when the dialog is closed. Passed as a reference.
showExportMultiple	Display the export multiple files checkbox.
showImageSize	Display the image size group of widget.
dialogTitle	The dialog's title

Returns

Return true if the user closed the dialog by pressing OK. False otherwise.

flush

void LayoutExport::flush ( )

slot

Render the nodes.

hideProgress

void LayoutExport::hideProgress ( )

slot

outputFilePath

String LayoutExport::outputFilePath ( LayoutExportParams *  params )

slot

Get the path to the output files.

progressCanceled

bool LayoutExport::progressCanceled ( )

slot

save

bool LayoutExport::save ( LayoutExportParams *  params )

slot

saveXli

void LayoutExport::saveXli ( LayoutExportParams *  params )

slot

setProgressLabel

void LayoutExport::setProgressLabel ( String  lbl )

slot

showProgress

void LayoutExport::showProgress ( int  totalSteps )

slot

updateProgress

void LayoutExport::updateProgress ( int  progress )

slot