MantidQt::API::IProjectSerialisable Class Reference

Defines an interface to a MantidPlot class that can be saved into or loaded from a project. More...

#include <IProjectSerialisable.h>

Public Member Functions
virtual std::string	getWindowName ()=0
	Returns the user friendly name of the window. More...
virtual std::string	getWindowType ()=0
	Returns the type of the window. More...
virtual std::vector< std::string >	getWorkspaceNames ()=0
	Returns a list of workspace names that are used by this window. More...
virtual std::string	saveToProject (ApplicationWindow *app)=0
	Serialises to a string that can be saved to a project file. More...
virtual	~IProjectSerialisable ()=default
	Virtual destructor (required by linker on some versions of OS X/Intel compiler) More...

Static Public Member Functions
static IProjectSerialisable *	loadFromProject (const std::string &lines, ApplicationWindow *app, const int fileVersion)

Detailed Description

Defines an interface to a MantidPlot class that can be saved into or loaded from a project.

Author

Harry Jeffery, ISIS, RAL

Date

31/07/2014

Definition at line 26 of file IProjectSerialisable.h.

Constructor & Destructor Documentation

~IProjectSerialisable()

virtual MantidQt::API::IProjectSerialisable::~IProjectSerialisable ( )

virtualdefault

Virtual destructor (required by linker on some versions of OS X/Intel compiler)

Member Function Documentation

getWindowName()

virtual std::string MantidQt::API::IProjectSerialisable::getWindowName ( )

pure virtual

Returns the user friendly name of the window.

Referenced by MantidQt::MantidWidgets::ProjectSaveModel::makeWindowInfoObject().

getWindowType()

virtual std::string MantidQt::API::IProjectSerialisable::getWindowType ( )

pure virtual

Returns the type of the window.

Referenced by MantidQt::MantidWidgets::ProjectSaveModel::makeWindowInfoObject().

getWorkspaceNames()

virtual std::vector< std::string > MantidQt::API::IProjectSerialisable::getWorkspaceNames ( )

pure virtual

Returns a list of workspace names that are used by this window.

loadFromProject()

static IProjectSerialisable * MantidQt::API::IProjectSerialisable::loadFromProject ( const std::string &  lines, ApplicationWindow *  app, const int  fileVersion  )

inlinestatic

Definition at line 32 of file IProjectSerialisable.h.

References UNUSED_ARG.

saveToProject()

virtual std::string MantidQt::API::IProjectSerialisable::saveToProject ( ApplicationWindow *  app )

pure virtual

Serialises to a string that can be saved to a project file.

---

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

• qt/widgets/common/inc/MantidQtWidgets/Common/IProjectSerialisable.h