![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
#include <Libs/PluginFramework/ctkPluginFrameworkEvent.h>
Public Types | |
enum | Type { FRAMEWORK_STARTED , PLUGIN_ERROR , PLUGIN_WARNING , PLUGIN_INFO , FRAMEWORK_STOPPED , FRAMEWORK_STOPPED_UPDATE , FRAMEWORK_WAIT_TIMEDOUT } |
Public Member Functions | |
ctkPluginFrameworkEvent () | |
ctkPluginFrameworkEvent (const ctkPluginFrameworkEvent &other) | |
ctkPluginFrameworkEvent (Type type, QSharedPointer< ctkPlugin > plugin) | |
ctkPluginFrameworkEvent (Type type, QSharedPointer< ctkPlugin > plugin, const ctkException &fwException) | |
QString | getErrorString () const |
QSharedPointer< ctkPlugin > | getPlugin () const |
Type | getType () const |
bool | isNull () const |
ctkPluginFrameworkEvent & | operator= (const ctkPluginFrameworkEvent &other) |
~ctkPluginFrameworkEvent () | |
A general event from the Framework.
ctkPluginFrameworkEvent
objects are delivered to slots connected via ctkPluginContext::connectFrameworkListener when a general event occurs within the plugin environment. A type code is used to identify the event type for future extendability.
Definition at line 49 of file ctkPluginFrameworkEvent.h.
Definition at line 56 of file ctkPluginFrameworkEvent.h.
ctkPluginFrameworkEvent::ctkPluginFrameworkEvent | ( | ) |
Default constructor for use with the Qt meta object system.
ctkPluginFrameworkEvent::~ctkPluginFrameworkEvent | ( | ) |
ctkPluginFrameworkEvent::ctkPluginFrameworkEvent | ( | Type | type, |
QSharedPointer< ctkPlugin > | plugin, | ||
const ctkException & | fwException | ||
) |
Creates a Framework event regarding the specified plugin and exception.
type | The event type. |
plugin | The event source. |
fwException | The related exception. |
Creates a Framework event regarding the specified plugin.
type | The event type. |
plugin | The event source. |
ctkPluginFrameworkEvent::ctkPluginFrameworkEvent | ( | const ctkPluginFrameworkEvent & | other | ) |
QString ctkPluginFrameworkEvent::getErrorString | ( | ) | const |
Returns the exception error string related to this event.
QSharedPointer<ctkPlugin> ctkPluginFrameworkEvent::getPlugin | ( | ) | const |
Returns the plugin associated with the event. This plugin is also the source of the event.
Type ctkPluginFrameworkEvent::getType | ( | ) | const |
Returns the type of framework event.
The type values are:
bool ctkPluginFrameworkEvent::isNull | ( | ) | const |
Can be used to check if this ctkPluginFrameworkEvent instance is valid, or if it has been constructed using the default constructor.
true
if this event object is valid, false
otherwise. ctkPluginFrameworkEvent& ctkPluginFrameworkEvent::operator= | ( | const ctkPluginFrameworkEvent & | other | ) |