Public Types | Public Member Functions | Properties

ctkPluginEvent Class Reference

#include <Libs/PluginFramework/ctkPluginEvent.h>

List of all members.

Public Types

enum  Type {
  INSTALLED, STARTED, STOPPED, UPDATED,
  UNINSTALLED, RESOLVED, UNRESOLVED, STARTING,
  STOPPING, LAZY_ACTIVATION
}

Public Member Functions

 ctkPluginEvent (Type type, ctkPlugin *plugin)
 ctkPluginEvent (const ctkPluginEvent &other)
ctkPlugingetPlugin () const
Type getType () const

Properties

QSharedDataPointer
< ctkPluginEventData
d
ctkPlugin plugin
Type type

Detailed Description

An event from the Framework describing a plugin lifecycle change.

ctkPluginEvent objects are delivered to slots connected to ctkPluginContext::pluginChanged() or to registerd event handlers for the topic "org.commontk/framework/pluginChanged" when a change occurs in a plugins's lifecycle. A type code is used to identify the event type for future extendability.

See also:
ctkPluginContext::connectPluginListener
ctkEventBus

Definition at line 46 of file ctkPluginEvent.h.


Member Enumeration Documentation

Enumerator:
INSTALLED 
STARTED 
STOPPED 
UPDATED 
UNINSTALLED 
RESOLVED 
UNRESOLVED 
STARTING 
STOPPING 
LAZY_ACTIVATION 

Definition at line 57 of file ctkPluginEvent.h.


Constructor & Destructor Documentation

ctkPluginEvent::ctkPluginEvent ( Type  type,
ctkPlugin plugin 
)

Creates a plugin event of the specified type.

Parameters:
type The event type.
plugin The plugin which had a lifecycle change.

Definition at line 26 of file ctkPluginEvent.cpp.

ctkPluginEvent::ctkPluginEvent ( const ctkPluginEvent other  ) 

Definition at line 32 of file ctkPluginEvent.cpp.


Member Function Documentation

ctkPlugin * ctkPluginEvent::getPlugin (  )  const

Returns the plugin which had a lifecycle change.

Returns:
The plugin that had a change occur in its lifecycle.

Definition at line 38 of file ctkPluginEvent.cpp.

ctkPluginEvent::Type ctkPluginEvent::getType (  )  const

Returns the type of lifecyle event. The type values are:

Returns:
The type of lifecycle event.

Definition at line 43 of file ctkPluginEvent.cpp.


Property Documentation

QSharedDataPointer<ctkPluginEventData> ctkPluginEvent::d

Definition at line 53 of file ctkPluginEvent.h.

ctkPlugin ctkPluginEvent::plugin [read]

Definition at line 50 of file ctkPluginEvent.h.

Type ctkPluginEvent::type [read]

Definition at line 49 of file ctkPluginEvent.h.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines