Medical Imaging Interaction Toolkit  2021.10.99-fd647480
Medical Imaging Interaction Toolkit
berry::IntroPart Class Reference

#include <berryIntroPart.h>

Inheritance diagram for berry::IntroPart:
Collaboration diagram for berry::IntroPart:

Public Member Functions

void AddPropertyListener (IPropertyChangeListener *l) override
 
 ~IntroPart () override
 
IIntroSite::Pointer GetIntroSite () const override
 
QIcon GetTitleImage () const override
 
QString GetPartName () const override
 
void Init (IIntroSite::Pointer site, IMemento::Pointer memento) override
 
void RemovePropertyListener (IPropertyChangeListener *l) override
 
void SaveState (IMemento::Pointer memento) override
 
void SetInitializationData (const IConfigurationElement::Pointer &cfig, const QString &propertyName, const Object::Pointer &data) override
 
- Public Member Functions inherited from berry::IIntroPart
 berryObjectMacro (berry::IIntroPart)
 
 ~IIntroPart () override
 
virtual void StandbyStateChanged (bool standby)=0
 
virtual void CreatePartControl (void *parent)=0
 
virtual void SetFocus ()=0
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () const
 
virtual void Delete ()
 
QDebug Print (QDebug os, Indent Indent=0) const
 
virtual QString ToString () const
 
virtual uint HashCode () const
 
virtual bool operator< (const Object *) const
 
void Register () const
 
void UnRegister (bool del=true) const
 
int GetReferenceCount () const
 
void SetReferenceCount (int)
 
void AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
void RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
virtual bool operator== (const Object *) const
 
- Public Member Functions inherited from berry::IExecutableExtension
virtual ~IExecutableExtension ()
 
virtual void SetInitializationData (const SmartPointer< IConfigurationElement > &config, const QString &propertyName, const Object::Pointer &data)=0
 

Protected Member Functions

void FirePropertyChange (int propertyId)
 
IConfigurationElement::Pointer GetConfigurationElement ()
 
QIcon GetDefaultImage () const
 
void SetSite (IIntroSite::Pointer site)
 
void SetTitleImage (const QIcon &titleImage)
 
void SetTitle (const QString &titleLabel)
 
- Protected Member Functions inherited from berry::Object
 Object ()
 
virtual ~Object ()
 
virtual QDebug PrintSelf (QDebug os, Indent indent) const
 
virtual QDebug PrintHeader (QDebug os, Indent indent) const
 
virtual QDebug PrintTrailer (QDebug os, Indent indent) const
 

Additional Inherited Members

- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

Abstract base implementation of an intro part.

Subclasses must implement the following methods:

  • CreatePartControl- to create the intro part's controls
  • SetFocus- to accept focus
  • StandbyStateChanged- to change the standby mode

Subclasses may extend or reimplement the following methods as required:

  • SetInitializationData- extend to provide additional initialization when the intro extension is instantiated
  • Init(IIntroSite::Pointer, IMemento::Pointer)- extend to provide additional initialization when intro is assigned its site
  • GetAdapter- reimplement to make their intro adaptable

Definition at line 52 of file berryIntroPart.h.

Constructor & Destructor Documentation

◆ ~IntroPart()

berry::IntroPart::~IntroPart ( )
override

The IntroPart implementation of this IIntroPart method disposes the title image loaded by setInitializationData. Subclasses may extend.

Member Function Documentation

◆ AddPropertyListener()

void berry::IntroPart::AddPropertyListener ( IPropertyChangeListener listener)
overridevirtual

Adds a listener for changes to properties of this intro part. Has no effect if an identical listener is already registered.

Parameters
listenera property listener

Implements berry::IIntroPart.

◆ FirePropertyChange()

void berry::IntroPart::FirePropertyChange ( int  propertyId)
protected

Fires a property changed event.

Parameters
propertyIdthe id of the property that changed

◆ GetConfigurationElement()

IConfigurationElement::Pointer berry::IntroPart::GetConfigurationElement ( )
protected

Returns the configuration element for this part. The configuration element comes from the plug-in registry entry for the extension defining this part.

Returns
the configuration element for this part

◆ GetDefaultImage()

QIcon berry::IntroPart::GetDefaultImage ( ) const
protected

Returns the default title image.

Returns
the default image

◆ GetIntroSite()

IIntroSite::Pointer berry::IntroPart::GetIntroSite ( ) const
overridevirtual

Returns the site for this intro part.

Returns
the intro site

Implements berry::IIntroPart.

◆ GetPartName()

QString berry::IntroPart::GetPartName ( ) const
overridevirtual

Returns the title of this intro part.

The title is used to populate the title bar of this part's visual container.

Returns
the intro part title (not null)

Implements berry::IIntroPart.

◆ GetTitleImage()

QIcon berry::IntroPart::GetTitleImage ( ) const
overridevirtual

Returns the title image of this intro part.

The title image is usually used to populate the title bar of this part's visual container. Since this image is managed by the part itself, callers must not dispose the returned image.

Returns
the title image

Implements berry::IIntroPart.

◆ Init()

void berry::IntroPart::Init ( IIntroSite::Pointer  site,
IMemento::Pointer  memento 
)
overridevirtual

The base implementation of this IIntroPart method ignores the memento and initializes the part in a fresh state. Subclasses may extend to perform any state restoration, but must call the super method.

Parameters
sitethe intro site
mementothe intro part state or null if there is no previous saved state
Exceptions
PartInitExceptionif this part was not initialized successfully

Implements berry::IIntroPart.

◆ RemovePropertyListener()

void berry::IntroPart::RemovePropertyListener ( IPropertyChangeListener listener)
overridevirtual

Removes the given property listener from this intro part. Has no affect if an identical listener is not registered.

Parameters
listenera property listener

Implements berry::IIntroPart.

◆ SaveState()

void berry::IntroPart::SaveState ( IMemento::Pointer  memento)
overridevirtual

The base implementation of this IIntroPart method does nothing. Subclasses may override.

Parameters
mementoa memento to receive the object state

Implements berry::IIntroPart.

◆ SetInitializationData()

void berry::IntroPart::SetInitializationData ( const IConfigurationElement::Pointer cfig,
const QString &  propertyName,
const Object::Pointer data 
)
override

The IntroPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement). It also loads the title image, if one is specified in the configuration element. Subclasses may extend.

Should not be called by clients. It is called by the core plugin when creating this executable extension.

◆ SetSite()

void berry::IntroPart::SetSite ( IIntroSite::Pointer  site)
protected

Sets the part site.

Subclasses must invoke this method from IIntroPart#Init.

Parameters
sitethe intro part site

◆ SetTitle()

void berry::IntroPart::SetTitle ( const QString &  titleLabel)
protected

Set the title string for this part.

Parameters
titleLabelthe title string. Must not be null.
Since
3.2

◆ SetTitleImage()

void berry::IntroPart::SetTitleImage ( const QIcon &  titleImage)
protected

Sets or clears the title image of this part.

Parameters
titleImagethe title image, or null to clear

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