berry::Plugin Class Reference

#include <berryPlugin.h>

Inheritance diagram for berry::Plugin:

Collaboration diagram for berry::Plugin:

Public Member Functions
	Plugin ()
void	start (ctkPluginContext *context) override
void	stop (ctkPluginContext *context) override
QSharedPointer< ctkPlugin >	GetPlugin () const
ILog *	GetLog () const
QString	GetStateLocation () const

Protected Attributes
ctkPluginContext *	m_Context

Detailed Description

Definition at line 28 of file berryPlugin.h.

Constructor & Destructor Documentation

berry::Plugin::Plugin

(

)

Definition at line 22 of file berryPlugin.cpp.

Member Function Documentation

ILog * berry::Plugin::GetLog

(

)

const

Returns the log for this plug-in. If no such log exists, one is created.

Returns

the log for this plug-in XXX change this into a LogMgr service that would keep track of the map. See if it can be a service factory.

Definition at line 42 of file berryPlugin.cpp.

References m_Context.

QSharedPointer< ctkPlugin > berry::Plugin::GetPlugin

(

)

const

Definition at line 37 of file berryPlugin.cpp.

References m_Context.

Referenced by GetStateLocation().

QString berry::Plugin::GetStateLocation

(

)

const

Returns the location in the local file system of the plug-in state area for this plug-in. If the plug-in state area did not exist prior to this call, it is created.

The plug-in state area is a file directory within the platform's metadata area where a plug-in is free to create files. The content and structure of this area is defined by the plug-in, and the particular plug-in is solely responsible for any files it puts there. It is recommended for plug-in preference settings and other configuration parameters.

Exceptions

ctkIllegalStateException,when

the system is running with no data area (-data ), or when a data area has not been set yet.

Returns

a local file system path

Definition at line 47 of file berryPlugin.cpp.

References GetPlugin().

void berry::Plugin::start ( ctkPluginContext *  context )

override

Definition at line 27 of file berryPlugin.cpp.

References m_Context.

Referenced by berry::AbstractUICTKPlugin::start().

void berry::Plugin::stop ( ctkPluginContext *  context )

override

Definition at line 32 of file berryPlugin.cpp.

References m_Context.

Referenced by berry::AbstractUICTKPlugin::stop().

Member Data Documentation

ctkPluginContext* berry::Plugin::m_Context

protected

Definition at line 71 of file berryPlugin.h.

Referenced by GetLog(), GetPlugin(), berry::AbstractUICTKPlugin::GetPreferencesService(), start(), and stop().

---

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

• berryPlugin.h
• berryPlugin.cpp