Debug Console is a simple plugin that just show all messages received. More...

#include <DebugConsolePlugin.h>

Inheritance diagram for DebugConsolePlugin:

Collaboration diagram for DebugConsolePlugin:

Public Slots
void	onEntityAdded (QString ID, Entity *)

void	onEntityChanged (QString ID, Entity *)

void	onEntityRemoved (QString ID, QString entityID)

void	errorMessage (QString error)

void	sendToAll ()

virtual void	updateFromModel ()
	Calls the plugin to update its internal model from model. More...

virtual void	onEntityAdded (QString pluginID, Entity *entity)
	This is called by the core when a new Entity is added. More...

virtual void	onEntityChanged (QString pluginID, Entity *entity)
	Called by the core when an Entity is changed. More...

Signals
void	addEntity (QString type, QString parentEntityId, QMap< QString, QString > &atts, bool force)
	This message can be used to add a new entity in the model. More...

void	setAttributes (Entity *entity, QMap< QString, QString > atts, bool force)
	This message can be used to edit the attributes of an Entity. More...

void	removeEntity (Entity *entity, bool force)
	This message can be used to ask the core to remove an Entity. More...

void	setListenFilter (const QStringList &entityTypes)
	Say the core that the plugin is interested in just the entities of the the type passed as parameter. More...

void	sendBroadcastMessage (const char msg, void obj)
	Can be used to extend the current messages of Core. More...

void	setPluginData (QByteArray data)
	Each plugin is able to save its specific data by calling this message. More...

void	setCurrentProjectAsDirty ()
	TODO. More...

Public Member Functions
void	init ()
	Initialize the plugin. More...

QWidget *	getWidget ()
	Return the main Widget. More...

bool	saveSubsession ()
	Says to plugin save its settings. More...

QString	getPluginInstanceID ()

void	setPluginInstanceID (QString pluginInstID)

void	setLanguageProfile (ILanguageProfile *languageProfile)

ILanguageProfile *	getLanguageProfile ()

void	setProject (Project *project)
	This call is used by the core to bind an existing NclDocument with this plugin instance. More...

Project *	getProject ()
	This call is used by the core to recover the Project instance previously binded with this plugin instance. More...

Protected Attributes
Project *	project
	The Project binded with this particular plugin instance.

QString	pluginInstanceID
	Each plugin instance also receives a unique instance ID (given by the core).

QMutex	mutex

ILanguageProfile *	languageProfile

Detailed Description

Debug Console is a simple plugin that just show all messages received.

It also is a simple way to learn how to create a new plugin.

Definition at line 36 of file DebugConsolePlugin.h.

Member Function Documentation

void composer::extension::IPlugin::addEntity	(	QString	type,
		QString	parentEntityId,
		QMap< QString, QString > &	atts,
		bool	force
	)

signalinherited

This message can be used to add a new entity in the model.

Parameters

type
parentEntityId
atts
force

Project* composer::extension::IPlugin::getProject ( )

inlineinherited

This call is used by the core to recover the Project instance previously binded with this plugin instance.

Returns: project aProject instance

Definition at line 90 of file IPlugin.h.

QWidget * DebugConsolePlugin::getWidget ( )

virtual

Return the main Widget.

The core calls this method to retrieve the Plugin Graphical Interface. This Widget is going to be wrapped into a QDockWidget and then displayed for the user in the main interface

Returns: QWidget - wrapping the plugin interface

Reimplemented from composer::extension::IPlugin.

Definition at line 50 of file DebugConsolePlugin.cpp.

void DebugConsolePlugin::init ( )

virtual

Initialize the plugin.

This call is used after the plugin is connected with core. Just after the init return the plugin is able to receive messages from core. Messages send to core befor this call are IGNORED.

Reimplemented from composer::extension::IPlugin.

Definition at line 45 of file DebugConsolePlugin.cpp.

virtual void composer::extension::IPlugin::onEntityAdded	(	QString	pluginID,
		Entity *	entity
	)

inlinevirtualslotinherited

This is called by the core when a new Entity is added.

This call is invoked by the core when a new Entity (from that particular types the plugin is listening) is added in the model.

Definition at line 150 of file IPlugin.h.

virtual void composer::extension::IPlugin::onEntityChanged	(	QString	pluginID,
		Entity *	entity
	)

inlinevirtualslotinherited

Called by the core when an Entity is changed.

Parameters

pluginID	the plugin instance id that first called the changes to the entity.
entity	The entity that was modified.

Definition at line 163 of file IPlugin.h.

void composer::extension::IPlugin::removeEntity	(	Entity *	entity,
		bool	force
	)

signalinherited

This message can be used to ask the core to remove an Entity.

Parameters

entity	The pointer to the Entity must be removed.
force	It should be true if the user want to remove that entity even the internal model will not be consistent.

bool DebugConsolePlugin::saveSubsession ( )

virtual

Says to plugin save its settings.

The core calls this method to notify the plugin that the user is requesting to save this document. Some plugins need to save special settings for a particular document, in case that document is re-open in a different session.

Returns: bool - true if the save was successfull, false otherwise

Reimplemented from composer::extension::IPlugin.

Definition at line 102 of file DebugConsolePlugin.cpp.

void composer::extension::IPlugin::sendBroadcastMessage	(	const char *	msg,
		void *	obj
	)

signalinherited

Can be used to extend the current messages of Core.

This message is send to all plugins without any validation. The content of the message can be any QObject and are useful to extend the default core message.

Always, the signature of the method msg implemented by an receiver must be an public slot like: void msg(QString pluginID, void *obj)

The core will call this msg method to each publin that implements it when sendBroadcastMethod is called.

Here is the caller graph for this function:

void composer::extension::IPlugin::setAttributes	(	Entity *	entity,
		QMap< QString, QString >	atts,
		bool	force
	)

signalinherited

This message can be used to edit the attributes of an Entity.

Parameters

entity
atts
force

Here is the caller graph for this function:

void composer::extension::IPlugin::setCurrentProjectAsDirty ( )

signalinherited

TODO.

Todo:: This could be done with setBroadcastMessage?!

void composer::extension::IPlugin::setListenFilter ( const QStringList & entityTypes)

signalinherited

Say the core that the plugin is interested in just the entities of the the type passed as parameter.

Parameters

entityTypes a list of strings that the plugin want to listen.

void composer::extension::IPlugin::setPluginData ( QByteArray data)

signalinherited

Each plugin is able to save its specific data by calling this message.

Important: When the plugin send this message, the data overwrite the previously saved by this plugin.

Parameters

data	A byte array contatining the data that plugin wants to save.

Here is the caller graph for this function:

void composer::extension::IPlugin::setProject ( Project * project)

inlineinherited

This call is used by the core to bind an existing NclDocument with this plugin instance.

Parameters

document an NclDocument instance

Definition at line 78 of file IPlugin.h.

virtual void composer::extension::IPlugin::updateFromModel ( )

inlinevirtualslotinherited

Calls the plugin to update its internal model from model.

This call is invoked by the core in two situations:

When the user resquest an update to all plugins
When the plugin is loaded in runtime

In the second case, the plugin is loaded, but did no receive the previous modifications, so it has to be forceed to reload the Document*.

Definition at line 142 of file IPlugin.h.

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

Public Slots

Signals

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation