Medical Imaging Interaction Toolkit  2018.04.99-46eee069
Medical Imaging Interaction Toolkit
berry::AbstractUICTKPlugin Class Reference

#include <berryAbstractUICTKPlugin.h>

Inheritance diagram for berry::AbstractUICTKPlugin:
Collaboration diagram for berry::AbstractUICTKPlugin:

Public Member Functions

 AbstractUICTKPlugin ()
IPreferencesServiceGetPreferencesService () const
SmartPointer< IPreferencesGetPreferences () const
IWorkbenchGetWorkbench ()
void start (ctkPluginContext *context) override
void stop (ctkPluginContext *context) override
- Public Member Functions inherited from berry::Plugin
 Plugin ()
void start (ctkPluginContext *context) override
void stop (ctkPluginContext *context) override
QSharedPointer< ctkPlugin > GetPlugin () const
ILogGetLog () const
QString GetStateLocation () const

Static Public Member Functions

static QIcon ImageDescriptorFromPlugin (const QString &pluginId, const QString &imageFilePath)
static QIcon GetMissingIcon ()

Additional Inherited Members

- Protected Attributes inherited from berry::Plugin
ctkPluginContext * m_Context

Detailed Description

Abstract base class for plug-ins that integrate with the BlueBerry platform UI.

Subclasses obtain the following capabilities:


  • The platform core runtime contains general support for plug-in preferences (org.blueberry.core.runtime.Preferences). This class provides appropriate conversion to the older JFace preference API (org.blueberry.jface.preference.IPreferenceStore).
  • The method getPreferenceStore returns the JFace preference store (cf. Plugin.getPluginPreferences which returns a core runtime preferences object.
  • Subclasses may reimplement initializeDefaultPreferences to set up any default values for preferences using JFace API. In this case, initializeDefaultPluginPreferences should not be overridden.
  • Subclasses may reimplement initializeDefaultPluginPreferences to set up any default values for preferences using core runtime API. In this case, initializeDefaultPreferences should not be overridden.
  • Preferences are also saved automatically on plug-in shutdown. However, saving preferences immediately after changing them is strongly recommended, since that ensures that preference settings are not lost even in the event of a platform crash.


  • The dialog store is read the first time getDialogSettings is called.
  • The dialog store allows the plug-in to "record" important choices made by the user in a wizard or dialog, so that the next time the wizard/dialog is used the widgets can be defaulted to better values. A wizard could also use it to record the last 5 values a user entered into an editable combo - to show "recent values".
  • The dialog store is found in the file whose name is given by the constant FN_DIALOG_STORE. A dialog store file is first looked for in the plug-in's read/write state area; if not found there, the plug-in's install directory is checked. This allows a plug-in to ship with a read-only copy of a dialog store file containing initial values for certain settings.
  • Plug-in code can call saveDialogSettings to cause settings to be saved in the plug-in's read/write state area. A plug-in may opt to do this each time a wizard or dialog is closed to ensure the latest information is always safe on disk.
  • Dialog settings are also saved automatically on plug-in shutdown.

For easy access to your plug-in object, use the singleton pattern. Declare a static variable in your plug-in class for the singleton. Store the first (and only) instance of the plug-in class in the singleton when it is created. Then access the singleton when needed through a static getDefault method.

See the description on Plugin.

Definition at line 91 of file berryAbstractUICTKPlugin.h.

Constructor & Destructor Documentation

◆ AbstractUICTKPlugin()

berry::AbstractUICTKPlugin::AbstractUICTKPlugin ( )

Creates an abstract UI plug-in runtime object.

Plug-in runtime classes are ctkPluginActivators and so must have an default constructor. This method is called by the runtime when the associated bundle is being activated.

Member Function Documentation

◆ GetMissingIcon()

static QIcon berry::AbstractUICTKPlugin::GetMissingIcon ( )

◆ GetPreferences()

SmartPointer<IPreferences> berry::AbstractUICTKPlugin::GetPreferences ( ) const

◆ GetPreferencesService()

IPreferencesService* berry::AbstractUICTKPlugin::GetPreferencesService ( ) const

Returns the preferences service for this UI plug-in. This preferences service is used to hold persistent settings for this plug-in in the context of a workbench. Some of these settings will be user controlled, whereas others may be internal setting that are never exposed to the user.

If an error occurs reading the preferences service, an empty preference service is quietly created, initialized with defaults, and returned.

the preferences service

◆ GetWorkbench()

IWorkbench* berry::AbstractUICTKPlugin::GetWorkbench ( )

Returns the Platform UI workbench.

This method exists as a convenience for plugin implementors. The workbench can also be accessed by invoking PlatformUI.getWorkbench().

IWorkbench the workbench for this plug-in

◆ ImageDescriptorFromPlugin()

static QIcon berry::AbstractUICTKPlugin::ImageDescriptorFromPlugin ( const QString &  pluginId,
const QString &  imageFilePath 

Creates and returns a new image descriptor for an image file located within the specified plug-in.

This is a convenience method that simply locates the image file in within the plug-in (no image registries are involved). The path is relative to the root of the plug-in, and takes into account files coming from plug-in fragments. The path may include $arg$ elements. However, the path must not have a leading "." or path separator. Clients should use a path like "icons/mysample.gif" rather than "./icons/mysample.gif" or "/icons/mysample.gif".

pluginIdthe id of the plug-in containing the image file; null is returned if the plug-in does not exist
imageFilePaththe relative path of the image file, relative to the root of the plug-in; the path must be legal
an image descriptor, or null if no image could be found

◆ start()

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

The AbstractUIPlugin implementation of this Plugin method refreshes the plug-in actions. Subclasses may extend this method, but must send super first.


◆ stop()

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

The AbstractUIPlugin implementation of this Plugin method saves this plug-in's preference and dialog stores and shuts down its image registry (if they are in use). Subclasses may extend this method, but must send super last. A try-finally statement should be used where necessary to ensure that super.shutdown() is always done.

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