#include <berrySaveable.h>

Inheritance diagram for berry::Saveable:

Collaboration diagram for berry::Saveable:

Public Member Functions
virtual berryObjectMacro(Saveable) private bool	Show (SmartPointer< IWorkbenchPage > page)

virtual QString	GetName () const =0

virtual QString	GetToolTipText () const =0

virtual QIcon	GetImageDescriptor () const =0

virtual void	DoSave ()=0

virtual bool	IsDirty () const =0

virtual bool	operator< (const Object *object) const =0

virtual uint	HashCode () const =0

virtual void	DisableUI (const QList< SmartPointer< IWorkbenchPart > > &parts, bool closing)

virtual void	EnableUI (QList< SmartPointer< IWorkbenchPart > > &parts)

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

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::IAdaptable
template<class A >
A *	GetAdapter ()

virtual	~IAdaptable ()

Protected Member Functions
virtual Object *	GetAdapter (const QString &adapter) const override

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

QMutex	m_ReferenceCountLock

Detailed Description

A Saveable represents a unit of saveability, e.g. an editable subset of the underlying domain model that may contain unsaved changes. Different workbench parts (editors and views) may present the same saveables in different ways. This interface allows the workbench to provide more appropriate handling of operations such as saving and closing workbench parts. For example, if two editors sharing the same saveable with unsaved changes are closed simultaneously, the user is only prompted to save the changes once for the shared saveable, rather than once for each editor.

Workbench parts that work in terms of saveables should implement ISaveablesSource.

See also: ISaveablesSource

Definition at line 48 of file berrySaveable.h.

Member Function Documentation

void berry::Saveable::DisableUI	(	const QList< SmartPointer< IWorkbenchPart > > &	parts,
		bool	closing
	)

virtual

Saves this saveable, or prepares this saveable for a background save operation. Returns null if this saveable has been successfully saved, or a job runnable that needs to be run to complete the save in the background. This method is called in the UI thread. If this saveable supports saving in the background, it should do only minimal work. However, since the job runnable returned by this method (if any) will not run on the UI thread, this method should copy any state that can only be accessed from the UI thread so that the job runnable will be able to access it.

The supplied shell provider can be used from within this method and from within the job runnable for the purpose of parenting dialogs. Care should be taken not to open dialogs gratuitously and only if user input is required for cases where the save cannot otherwise proceed - note that in any given save operation, many saveable objects may be saved at the same time. In particular, errors should be signaled by throwing an exception, or if an error occurs while running the job runnable, an error status should be returned.

If the foreground part of the save is cancelled through user action, or for any other reason, the part should invoke setCancelled on the IProgressMonitor to inform the caller. If the background part of the save is cancelled, the job should return a IStatus#CANCEL status.

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

The default implementation of this method calls doSave(IProgressMonitor) and returns null.

Parameters

monitor	a progress monitor used for reporting progress and cancellation
shellProvider	an object that can provide a shell for parenting dialogs

Returns: null if this saveable has been saved successfully, or a job runnable that needs to be run to complete the save in the background.

Since: 3.3 Disables the UI of the given parts containing this saveable if necessary. This method is not intended to be called by clients. A corresponding call to

Saveables that can be saved in the background should ensure that the user cannot make changes to their data from the UI, for example by disabling controls, unless they are prepared to handle this case. This method is called on the UI thread after a job runnable has been returned from doSave(IProgressMonitor, IShellProvider) and before spinning the event loop. The closing flag indicates that this saveable is currently being saved in response to closing a workbench part, in which case further changes to this saveable through the UI must be prevented.

The default implementation calls setEnabled(false) on the given parts' composites.

Parameters

parts	the workbench parts containing this saveable
closing	a boolean flag indicating whether the save was triggered by a request to close a workbench part, and all of the given parts will be closed after the save operation finishes successfully.

Since: 3.3

Definition at line 37 of file berrySaveable.cpp.

void berry::Saveable::DoSave ( )

pure virtual

Saves the contents of this saveable.

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.

Parameters

monitor the progress monitor

Exceptions

CoreException if the save fails; it is the caller's responsibility to report the failure to the user

Definition at line 30 of file berrySaveable.cpp.

void berry::Saveable::EnableUI ( QList< SmartPointer< IWorkbenchPart > > & parts )

virtual

Enables the UI of the given parts containing this saveable after a background save operation has finished. This method is not intended to be called by clients.

The default implementation calls setEnabled(true) on the given parts' composites.

Parameters

parts the workbench parts containing this saveable

Since: 3.3

Definition at line 56 of file berrySaveable.cpp.

Object * berry::Saveable::GetAdapter ( const QString & adapter ) const

overrideprotectedvirtual

This implementation of IAdaptable#GetAdapterImpl(const std::type_info&) returns null. Subclasses may override. This allows two unrelated subclasses of Saveable to implement equals(Object) and hashCode() based on an underlying implementation class that is shared by both Saveable subclasses.

Since: 3.3

Implements berry::IAdaptable.

Definition at line 74 of file berrySaveable.cpp.

virtual QIcon berry::Saveable::GetImageDescriptor ( ) const

pure virtual

Returns the image descriptor for this saveable.

Returns: the image descriptor for this model; may be null if there is no image

virtual QString berry::Saveable::GetName ( ) const

pure virtual

Returns the name of this saveable for display purposes.

Returns: the model's name; never null.

virtual QString berry::Saveable::GetToolTipText ( ) const

pure virtual

Returns the tool tip text for this saveable. This text is used to differentiate between two inputs with the same name. For instance, MyClass.java in folder X and MyClass.java in folder Y. The format of the text varies between input types.

Returns: the tool tip text; never null

virtual uint berry::Saveable::HashCode ( ) const

pure virtual

Clients must implement equals and hashCode as defined in Object#equals(Object) and Object#hashCode(). Two saveables should be equal if their dirty state is shared, and saving one will save the other. If two saveables are equal, their hash codes MUST be the same, and their names, tooltips, and images should be the same because only one of them will be shown when prompting the user to save.

IMPORTANT: Implementers should ensure that the hashCode returned is sufficiently unique so as not to collide with hashCodes returned by other implementations. It is suggested that the defining plug-in's ID be used as part of the returned hashCode, as in the following example:

    int PRIME = 31;
    int hash = ...; // compute the "normal" hash code, e.g. based on some identifier unique within the defining plug-in
    return hash * PRIME + MY_PLUGIN_ID.hashCode();

Returns: a hash code

Reimplemented from berry::Object.

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

pure virtual

Returns whether the contents of this saveable have changed since the last save operation.

Note: this method is called frequently, 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

virtual bool berry::Saveable::operator< ( const Object * object ) const

pure virtual

Clients must implement equals and hashCode as defined in Object#equals(Object) and Object#hashCode(). Two saveables should be equal if their dirty state is shared, and saving one will save the other. If two saveables are equal, their names, tooltips, and images should be the same because only one of them will be shown when prompting the user to save.

Parameters

object

Returns: true if this Saveable is equal to the given object

Reimplemented from berry::Object.

bool berry::Saveable::Show ( SmartPointer< IWorkbenchPage > page )

virtual

Attempts to show this saveable in the given page and returns true on success. The default implementation does nothing and returns false.

Parameters

page	the workbench page in which to show this saveable

Returns: true if this saveable is now visible to the user

Since: 3.3

Definition at line 25 of file berrySaveable.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation