DataStructureBackendManager Class Reference

#include <DataStructureBackendManager.h>

Inheritance diagram for DataStructureBackendManager:

Public Slots
void	setBackend (const QString &pluginIdentifier)

Signals
void	backendChanged (const QString &pluginName)

Public Member Functions
DataStructureBackendInterface *	activeBackend () const
DataStructureBackendInterface *	backend (const QString &internalName) const
KPluginInfo	backendInfo (DataStructureBackendInterface *plugin) const
const QStringList	backends () const
DataStructurePtr	createDataStructure (Document *parent, const QString &pluginName=QString())
DataStructurePtr	createDataStructure (const DataStructurePtr dataStructure, Document *parent)
QLayout *	dataExtraProperties (DataPtr data, QWidget *parent) const
QGraphicsItem *	dataItem (DataPtr data) const
QLayout *	dataStructureExtraProperties (DataStructurePtr dataStructure, QWidget *parent) const
QLayout *	pointerExtraProperties (PointerPtr pointer, QWidget *parent) const
QGraphicsItem *	pointerItem (PointerPtr pointer) const

Static Public Member Functions
static DataStructureBackendManager &	self ()

Detailed Description

This singelton class provides access to all available data structure backends.

Definition at line 43 of file DataStructureBackendManager.h.

Member Function Documentation

DataStructureBackendInterface * DataStructureBackendManager::activeBackend

(

)

const

Returns the currently active data structure backend.

The return value is only '0' if

See also

DataStructureBackendManager::backends() returns an empty list.

Returns

data structure backend or '0' if no backend exists

Definition at line 275 of file DataStructureBackendManager.cpp.

DataStructureBackendInterface * DataStructureBackendManager::backend

(

const QString &

internalName

)

const

Returns data structure backend identified by its identifier internalName.

Parameters

internalName

the unique identifier for backend

Returns

the requested backend or '0' if backend is not found

Definition at line 280 of file DataStructureBackendManager.cpp.

void DataStructureBackendManager::backendChanged ( const QString &  pluginName )

signal

Emitted if the active backend is changed.

KPluginInfo DataStructureBackendManager::backendInfo

(

DataStructureBackendInterface *

plugin

)

const

Returns KPluginInfo object representing the plugin information for plugin.

Parameters

plugin

the data structure plugin object

Returns

plugin information

Definition at line 265 of file DataStructureBackendManager.cpp.

const QStringList DataStructureBackendManager::backends

(

)

const

Returns list of loaded backends.

Backends are loaded with first call to self().

Returns

list of plugin interfaces of loaded backends

Definition at line 270 of file DataStructureBackendManager.cpp.

DataStructurePtr DataStructureBackendManager::createDataStructure	(	Document *	parent,
		const QString &	pluginName = QString()
	)

TODO change this method: it is not clear how the parent document is registered; the creation functionality should only be located at the Document class.

Create data structure with backend pluginName. If not backend is specified, the currently active data structure backend is used, activeBackend().

Parameters

parent	the Document that will hold the created data structure
pluginName	the optional name of the data structure backend

Returns

the created data structure

Definition at line 260 of file DataStructureBackendManager.cpp.

DataStructurePtr DataStructureBackendManager::createDataStructure	(	const DataStructurePtr	dataStructure,
		Document *	parent
	)

Create a new data structure from given dataStructure within document parent.

The currently active data structure backend is used to create the data structure. TODO change this method: same comment as on createDataStructure()

Parameters

dataStructure	the data structure to be converted
parent

Definition at line 255 of file DataStructureBackendManager.cpp.

QLayout * DataStructureBackendManager::dataExtraProperties	(	DataPtr	data,
		QWidget *	parent
	)		const

Create widgets for backend specific data properties.

If no extra properties exist, return value is 0.

Definition at line 317 of file DataStructureBackendManager.cpp.

QGraphicsItem * DataStructureBackendManager::dataItem

(

DataPtr

data

)

const

Generates graphics item for represenation of data at graph scene based on data structure backend of the parent document of data.

Parameters

data	the data object

Returns

item associated with the data object

Definition at line 285 of file DataStructureBackendManager.cpp.

QLayout * DataStructureBackendManager::dataStructureExtraProperties	(	DataStructurePtr	dataStructure,
		QWidget *	parent
	)		const

Create widgets for backend specific data structure properties.

If no extra properties exist, return value is 0.

Definition at line 309 of file DataStructureBackendManager.cpp.

QLayout * DataStructureBackendManager::pointerExtraProperties	(	PointerPtr	pointer,
		QWidget *	parent
	)		const

Create widgets for backend specific pointer properties.

If no extra properties exist, return value is 0.

Definition at line 301 of file DataStructureBackendManager.cpp.

QGraphicsItem * DataStructureBackendManager::pointerItem

(

PointerPtr

pointer

)

const

Generates graphics item for represenation of pointer at graph scene based on data structure backend of the parent document of pointer.

Parameters

pointer

the pointer object

Returns

item associated with the pointer object

Definition at line 293 of file DataStructureBackendManager.cpp.

DataStructureBackendManager & DataStructureBackendManager::self ( )

static

Returns self reference to backend manager.

First call of this method initializes data structure backend manager and loads plugins.

Returns

self reference

Definition at line 233 of file DataStructureBackendManager.cpp.

void DataStructureBackendManager::setBackend ( const QString &  pluginIdentifier )

slot

Change the active backend.

If backend is changed, the signal backendChanged() is emitted. If pluginIdentifier does not denote a valid backend, the active backend is not changed.

Parameters

pluginIdentifier

internal name of the data structure backend

Definition at line 240 of file DataStructureBackendManager.cpp.

---

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

• DataStructureBackendManager.h
• DataStructureBackendManager.cpp