StandAloneWidget Class Reference

#include <Workspace/Widgets/standalonewidget.h>

Inherits QFrame.

Public Slots
void	connectToWorkspace (CSIRO::DataExecution::Workspace *workspace)
void	handleActionLoad ()
void	handleActionSave ()
void	handleActionSaveAs ()
bool	loadProject (const QString &projectFile)
void	setExecutionState (bool running)
void	startExecution ()
void	stopExecution ()

Signals
void	controllerChange (CSIRO::Presentation::WorkspaceController *controller)
void	executionFinished ()
void	executionStarted ()
void	executionStateChange (bool executing)
void	statusMessage (QString msg)

Public Member Functions
	StandAloneWidget (QWidget *parent=nullptr)
	~StandAloneWidget () override
void	clearSaveableGlobalNames ()
const QStringList &	getSaveableGlobalNames () const
DataExecution::Workspace &	getWorkspace ()
bool	loadFromSerializedItem (const DataExecution::SerializedItem &item, bool includesDocType=true)
QSize	minimumSizeHint () const override
bool	saveToSerializedItem (DataExecution::SerializedItem &item, bool includeDocType=true)
void	setSaveableGlobalNames (const QStringList &globalNames)
bool	setWorkspace (const QString &workspaceFile)
void	setWorkspace (DataExecution::Workspace &workspace, bool takeOwnership=false)

Static Public Member Functions
static QWidget *	createStandAloneWidget (QString workspaceFile, QString uiFile, QString projectFile="", bool startExecutionNow=true)

Properties
QStringList	saveableGlobalNames

Constructor & Destructor Documentation

StandAloneWidget()

StandAloneWidget

(

QWidget *

parent = nullptr

)

~StandAloneWidget()

~StandAloneWidget ( )

override

Member Function Documentation

clearSaveableGlobalNames()

void clearSaveableGlobalNames

(

)

This function clears the list of saveable global names. It is mostly provided just to make the widget resettable in Qt Designer.

connectToWorkspace

void connectToWorkspace ( CSIRO::DataExecution::Workspace *  workspace )

slot

controllerChange

void controllerChange ( CSIRO::Presentation::WorkspaceController *  controller )

signal

createStandAloneWidget()

QWidget * createStandAloneWidget ( QString  workspaceFile, QString  uiFile, QString  projectFile = "", bool  startExecutionNow = true  )

static

executionFinished

void executionFinished ( )

signal

executionStarted

void executionStarted ( )

signal

executionStateChange

void executionStateChange ( bool  executing )

signal

getSaveableGlobalNames()

const QStringList & getSaveableGlobalNames

(

)

const

Returns

The list of global names that are allowed to be loaded and saved.

See also

setSaveableGlobalNames(), clearSaveableGlobalNames()

getWorkspace()

DataExecution::Workspace & getWorkspace

(

)

handleActionLoad

void handleActionLoad ( )

slot

handleActionSave

void handleActionSave ( )

slot

handleActionSaveAs

void handleActionSaveAs ( )

slot

loadFromSerializedItem()

bool loadFromSerializedItem	(	const DataExecution::SerializedItem &	item,
		bool	includesDocType = true
	)

loadProject

bool loadProject ( const QString &  projectFile )

slot

minimumSizeHint()

QSize minimumSizeHint ( ) const

override

saveToSerializedItem()

bool saveToSerializedItem	(	DataExecution::SerializedItem &	item,
		bool	includeDocType = true
	)

setExecutionState

void setExecutionState ( bool  running )

slot

setSaveableGlobalNames()

void setSaveableGlobalNames

(

const QStringList &

names

)

Parameters

names

The list of global names that are allowed to be loaded and saved.

See also

getSaveableGlobalNames(), clearSaveableGlobalNames()

setWorkspace() [1/2]

bool setWorkspace

(

const QString &

workspaceFile

)

Parameters

workspaceFile

The name of the workspace file to load as the new workspace. It can be a file on the local file system or it can be a resource path.

Returns

True if the workspace file could be loaded, false otherwise.

setWorkspace() [2/2]

void setWorkspace	(	DataExecution::Workspace &	workspace,
		bool	takeOwnership = false
	)

startExecution

void startExecution ( )

slot

statusMessage

void statusMessage ( QString  msg )

signal

stopExecution

void stopExecution ( )

slot

Property Documentation

saveableGlobalNames

QStringList saveableGlobalNames

readwrite