openfluid::builderext::PluggableBuilderExtension Class Reference

Inheritance diagram for openfluid::builderext::PluggableBuilderExtension:

List of all members.

Public Types
enum	ExtensionType {   WorkspaceTab, ModelessWindow, ModalWindow, SpatialgraphImporter,   InputdataImporter, EventsImporter, ExtraImporter, MixedImporter,   SimulationListener, HomeLauncher }
Public Member Functions
	PluggableBuilderExtension ()
virtual	~PluggableBuilderExtension ()
void	setSimulationBlob (openfluid::machine::SimulationBlob *Blob)
virtual ExtensionType	getType () const =0
virtual bool	isConfigurable ()
ExtensionConfig_t	getConfiguration () const
void	setConfiguration (const ExtensionConfig_t &Config)
Gtk::Widget *	getPrefsPanelAsWidget ()
virtual Gtk::Widget *	getExtensionAsWidget ()=0
virtual bool	isReadyForShowtime () const
Protected Attributes
ExtensionConfig_t	m_Config
Gtk::Widget *	m_PrefsPanelWidget
openfluid::machine::SimulationBlob *	mp_SimulationBlob

---

Member Enumeration Documentation

enum openfluid::builderext::PluggableBuilderExtension::ExtensionType

Enumerator:

WorkspaceTab
ModelessWindow
ModalWindow
SpatialgraphImporter
InputdataImporter
EventsImporter
ExtraImporter
MixedImporter
SimulationListener
HomeLauncher

---

Constructor & Destructor Documentation

openfluid::builderext::PluggableBuilderExtension::PluggableBuilderExtension

(

)

[inline]

virtual openfluid::builderext::PluggableBuilderExtension::~PluggableBuilderExtension

(

)

[inline, virtual]

---

Member Function Documentation

ExtensionConfig_t openfluid::builderext::PluggableBuilderExtension::getConfiguration

(

)

const [inline]

Retrieves the configuration information from the extension.

Returns:

the configuration information

virtual Gtk::Widget* openfluid::builderext::PluggableBuilderExtension::getExtensionAsWidget

(

)

[pure virtual]

Returns the main widget of the extension. The kind of widget depends on the extension type. This must be overridden in derived extensions

Returns:

a pointer to the main widget

Gtk::Widget* openfluid::builderext::PluggableBuilderExtension::getPrefsPanelAsWidget

(

)

[inline]

Returns the main widget for the preferences panel of the extension. Default is NULL, so no preference panel will be shown for this extension. This should be overridden in derived extensions.

Returns:

a pointer to widget for the preferences panel

virtual ExtensionType openfluid::builderext::PluggableBuilderExtension::getType

(

)

const [pure virtual]

Returns the type of the extension. This must be overridden.

Returns:

the type of the extension

Implemented in openfluid::builderext::EventsImporter, openfluid::builderext::ExtraImporter, openfluid::builderext::HomeLauncher, openfluid::builderext::InputdataImporter, openfluid::builderext::MixedImporter, openfluid::builderext::ModalWindow, openfluid::builderext::ModelessWindow, openfluid::builderext::SimulationListener, openfluid::builderext::SpatialgraphImporter, and openfluid::builderext::WorkspaceTab.

virtual bool openfluid::builderext::PluggableBuilderExtension::isConfigurable

(

)

[inline, virtual]

Returns true if the extension is configurable, false otherwise.

Returns:

true if the extension is configurable

virtual bool openfluid::builderext::PluggableBuilderExtension::isReadyForShowtime

(

)

const [inline, virtual]

Returns true if the extension is currently ready to use (showtime!). Default is false, but this should be overridden in derived extensions

Returns:

a boolean giving the state of the extension

Reimplemented in openfluid::builderext::DataImporter, openfluid::builderext::HomeLauncher, and openfluid::builderext::SimulationListener.

void openfluid::builderext::PluggableBuilderExtension::setConfiguration

(

const ExtensionConfig_t &

Config

)

[inline]

Gives the configuration information to the extension.

Parameters:

[in]

Config

the configuration information

void openfluid::builderext::PluggableBuilderExtension::setSimulationBlob

(

openfluid::machine::SimulationBlob *

Blob

)

[inline]

---

Member Data Documentation

ExtensionConfig_t openfluid::builderext::PluggableBuilderExtension::m_Config [protected]

Gtk::Widget* openfluid::builderext::PluggableBuilderExtension::m_PrefsPanelWidget [protected]

openfluid::machine::SimulationBlob* openfluid::builderext::PluggableBuilderExtension::mp_SimulationBlob [protected]