berry::ISaveablePart Struct Reference

#include <berryISaveablePart.h>

Inheritance diagram for berry::ISaveablePart:

Collaboration diagram for berry::ISaveablePart:

Public Member Functions
	berryObjectMacro (berry::ISaveablePart)
virtual void	DoSave ()=0
virtual void	DoSaveAs ()=0
virtual bool	IsDirty () const =0
virtual bool	IsSaveAsAllowed () const =0
virtual bool	IsSaveOnCloseNeeded () const =0
Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const
virtual Reflection::TypeInfo	GetTypeInfo () const
virtual QList< Reflection::TypeInfo >	GetSuperclasses () 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

Static Public Attributes
static const int	PROP_DIRTY

Additional Inherited Members
Public Types inherited from berry::Object
typedef Object	Self
typedef berry::SmartPointer< Self >	Pointer
typedef berry::SmartPointer< const Self >	ConstPointer
typedef berry::WeakPointer< Self >	WeakPtr
typedef berry::WeakPointer< const Self >	ConstWeakPtr
Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()
static Reflection::TypeInfo	GetStaticTypeInfo ()
static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()
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

Workbench parts implement or adapt to this interface to participate in the enablement and execution of the Save and Save As actions.

See also

IEditorPart

Definition at line 33 of file berryISaveablePart.h.

Member Function Documentation

berryObjectMacro()

berry::ISaveablePart::berryObjectMacro

(

berry::ISaveablePart

)

DoSave()

virtual void berry::ISaveablePart::DoSave ( )

pure virtual

Saves the contents of this part.

If the save is successful, the part should fire a property changed event reflecting the new dirty state (PROP_DIRTY property).

If the save is cancelled through user action, or for any other reason, the part should invoke setCancelled on the IProgressMonitor to inform the caller.

This method is long-running; progress and cancellation are provided by the given progress monitor.

Implemented in berry::EditorPart, and QmitkAbstractRenderEditor.

DoSaveAs()

virtual void berry::ISaveablePart::DoSaveAs ( )

pure virtual

Saves the contents of this part to another object.

Implementors are expected to open a "Save As" dialog where the user will be able to select a new name for the contents. After the selection is made, the contents should be saved to that new name. During this operation a IProgressMonitor should be used to indicate progress.

If the save is successful, the part fires a property changed event reflecting the new dirty state (PROP_DIRTY property).

Implemented in berry::EditorPart, and QmitkAbstractRenderEditor.

IsDirty()

virtual bool berry::ISaveablePart::IsDirty ( ) const

pure virtual

Returns whether the contents of this part have changed since the last save operation. If this value changes the part must fire a property listener event with PROP_DIRTY.

Note: this method is called often on a part open or part activation switch, for example by actions to determine their enabled status.

Returns

true if the contents have been modified and need saving, and false if they have not changed since the last save

Implemented in berry::EditorPart, and QmitkAbstractRenderEditor.

IsSaveAsAllowed()

virtual bool berry::ISaveablePart::IsSaveAsAllowed ( ) const

pure virtual

Returns whether the "Save As" operation is supported by this part.

Returns

true if "Save As" is supported, and false if not supported

Implemented in berry::EditorPart, and QmitkAbstractRenderEditor.

IsSaveOnCloseNeeded()

virtual bool berry::ISaveablePart::IsSaveOnCloseNeeded ( ) const

pure virtual

Returns whether the contents of this part should be saved when the part is closed.

Returns

true if the contents of the part should be saved on close, and false if the contents are expendable

Implemented in berry::EditorPart.

Member Data Documentation

PROP_DIRTY

const int berry::ISaveablePart::PROP_DIRTY

static

The property id for isDirty.

Definition at line 41 of file berryISaveablePart.h.

---

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

• berryISaveablePart.h