Medical Imaging Interaction Toolkit  2021.10.99-9c07a326
Medical Imaging Interaction Toolkit
berry::IIntroPart Struct Referenceabstract

#include <berryIIntroPart.h>

Inheritance diagram for berry::IIntroPart:
Collaboration diagram for berry::IIntroPart:

Public Member Functions

 berryObjectMacro (berry::IIntroPart)
 
 ~IIntroPart () override
 
virtual IIntroSite::Pointer GetIntroSite () const =0
 
virtual void Init (IIntroSite::Pointer site, IMemento::Pointer memento)=0
 
virtual void StandbyStateChanged (bool standby)=0
 
virtual void SaveState (IMemento::Pointer memento)=0
 
virtual void AddPropertyListener (IPropertyChangeListener *listener)=0
 
virtual void CreatePartControl (void *parent)=0
 
virtual QIcon GetTitleImage () const =0
 
virtual QString GetPartName () const =0
 
virtual void RemovePropertyListener (IPropertyChangeListener *listener)=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
 

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 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
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

The intro part is a visual component within the workbench responsible for introducing the product to new users. The intro part is typically shown the first time a product is started up.

The intro part implementation is contributed to the workbench via the org.blueberry.ui.intro extension point. There can be several intro part implementations, and associations between intro part implementations and products. The workbench will only make use of the intro part implementation for the current product (as given by berry::Platform#GetProduct(). There is at most one intro part instance in the entire workbench, and it resides in exactly one workbench window at a time.

This interface in not intended to be directly implemented. Rather, clients providing a intro part implementation should subclass berry::IntroPart.

See also
IIntroManager::ShowIntro

Definition at line 52 of file berryIIntroPart.h.

Constructor & Destructor Documentation

◆ ~IIntroPart()

berry::IIntroPart::~IIntroPart ( )
override

Member Function Documentation

◆ AddPropertyListener()

virtual void berry::IIntroPart::AddPropertyListener ( IPropertyChangeListener listener)
pure virtual

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

Implemented in berry::IntroPart.

◆ berryObjectMacro()

berry::IIntroPart::berryObjectMacro ( berry::IIntroPart  )

◆ CreatePartControl()

virtual void berry::IIntroPart::CreatePartControl ( void *  parent)
pure virtual

Creates the SWT controls for this intro part.

Clients should not call this method (the workbench calls this method when it needs to, which may be never).

For implementors this is a multi-step process:

  1. Create one or more controls within the parent.
  2. Set the parent layout as needed.
  3. Register any global actions with the IActionService.
  4. Register any popup menus with the IActionService.
  5. Register a selection provider with the ISelectionService (optional).
Parameters
parentthe parent control

Implemented in berry::QtIntroPart.

◆ GetIntroSite()

virtual IIntroSite::Pointer berry::IIntroPart::GetIntroSite ( ) const
pure virtual

Returns the site for this intro part.

Returns
the intro site

Implemented in berry::IntroPart.

◆ GetPartName()

virtual QString berry::IIntroPart::GetPartName ( ) const
pure virtual

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)

Implemented in berry::IntroPart.

◆ GetTitleImage()

virtual QIcon berry::IIntroPart::GetTitleImage ( ) const
pure virtual

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

Implemented in berry::IntroPart.

◆ Init()

virtual void berry::IIntroPart::Init ( IIntroSite::Pointer  site,
IMemento::Pointer  memento 
)
pure virtual

Initializes this intro part with the given intro site. A memento is passed to the part which contains a snapshot of the part state from a previous session. Where possible, the part should try to recreate that state.

This method is automatically called by the workbench shortly after part construction. It marks the start of the intro's lifecycle. Clients must not call this 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

Implemented in berry::IntroPart.

◆ RemovePropertyListener()

virtual void berry::IIntroPart::RemovePropertyListener ( IPropertyChangeListener listener)
pure virtual

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

Parameters
listenera property listener

Implemented in berry::IntroPart.

◆ SaveState()

virtual void berry::IIntroPart::SaveState ( IMemento::Pointer  memento)
pure virtual

Saves the object state within a memento.

This method is automatically called by the workbench at appropriate times. Clients must not call this method directly.

Parameters
mementoa memento to receive the object state

Implemented in berry::IntroPart.

◆ SetFocus()

virtual void berry::IIntroPart::SetFocus ( )
pure virtual

Asks this part to take focus within the workbench.

Clients should not call this method (the workbench calls this method at appropriate times). To have the workbench activate a part, use IIntroManager#ShowIntro.

◆ StandbyStateChanged()

virtual void berry::IIntroPart::StandbyStateChanged ( bool  standby)
pure virtual

Sets the standby state of this intro part. An intro part should render itself differently in the full and standby modes. In standby mode, the part should be partially visible to the user but otherwise allow them to work. In full mode, the part should be fully visible and be the center of the user's attention.

This method is automatically called by the workbench at appropriate times. Clients must not call this method directly (call IIntroManager#SetIntroStandby instead.

Parameters
standbytrue to put this part in its partially visible standy mode, and false to make it fully visible

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