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

#include <berryIPreferencePage.h>

Inheritance diagram for berry::IPreferencePage:
Collaboration diagram for berry::IPreferencePage:

Public Member Functions

 berryObjectMacro (berry::IPreferencePage)
 
 ~IPreferencePage () override
 
virtual void Init (IWorkbench::Pointer workbench)=0
 
virtual void CreateControl (void *parent)=0
 
virtual void * GetControl () const =0
 
virtual bool PerformOk ()=0
 
virtual void PerformCancel ()=0
 
virtual void Update ()=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

Interface for workbench preference pages.

Clients should implement this interface and include the name of their class in an extension contributed to the workbench's preference extension point (named "org.blueberry.ui.preferencePages"). For example, the plug-in's XML markup might contain:

<extension point="org.blueberry.ui.preferencePages>
<page id="com.example.myplugin.prefs"
name="Knobs"
class="ns::MyPreferencePage" />
</extension>

Definition at line 43 of file berryIPreferencePage.h.

Constructor & Destructor Documentation

◆ ~IPreferencePage()

berry::IPreferencePage::~IPreferencePage ( )
override

Member Function Documentation

◆ berryObjectMacro()

berry::IPreferencePage::berryObjectMacro ( berry::IPreferencePage  )

◆ CreateControl()

virtual void berry::IPreferencePage::CreateControl ( void *  parent)
pure virtual

Creates the top level control for this preference page under the given parent widget.

Implementors are responsible for ensuring that the created control can be accessed via GetControl

Parameters
parentthe parent widget

Implemented in berry::IQtPreferencePage.

◆ GetControl()

virtual void* berry::IPreferencePage::GetControl ( ) const
pure virtual

Returns the top level control for this dialog page.

May return null if the control has not been created yet.

Returns
the top level control or null

Implemented in berry::IQtPreferencePage.

◆ Init()

virtual void berry::IPreferencePage::Init ( IWorkbench::Pointer  workbench)
pure virtual

Initializes this preference page for the given workbench.

This method is called automatically as the preference page is being created and initialized. Clients must not call this method.

Parameters
workbenchthe workbench

Implemented in QmitkDataManagerHotkeysPrefPage, QmitkMultiLabelSegmentationPreferencePage, QmitkSegmentationPreferencePage, and QmitkDataManagerPreferencePage.

◆ PerformCancel()

virtual void berry::IPreferencePage::PerformCancel ( )
pure virtual

Invoked when the Cancel button was clicked in the preferences dialog

Implemented in QmitkDataManagerHotkeysPrefPage, QmitkDataManagerPreferencePage, QmitkMultiLabelSegmentationPreferencePage, and QmitkSegmentationPreferencePage.

◆ PerformOk()

virtual bool berry::IPreferencePage::PerformOk ( )
pure virtual

Invoked when the OK button was clicked in the preferences dialog

Implemented in QmitkDataManagerHotkeysPrefPage, QmitkMultiLabelSegmentationPreferencePage, QmitkSegmentationPreferencePage, and QmitkDataManagerPreferencePage.

◆ Update()

virtual void berry::IPreferencePage::Update ( )
pure virtual

Invoked when the user performed an import. As the values of the preferences may have changed you should read all values again from the preferences service.

Implemented in QmitkDataManagerHotkeysPrefPage, QmitkDataManagerPreferencePage, QmitkMultiLabelSegmentationPreferencePage, and QmitkSegmentationPreferencePage.


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