#include <berryIStackPresentationSite.h>

Inheritance diagram for berry::IStackPresentationSite:

Collaboration diagram for berry::IStackPresentationSite:

Public Member Functions
	berryObjectMacro (berry::IStackPresentationSite)

	~IStackPresentationSite () override

virtual void	SetState (int newState)=0

virtual int	GetState ()=0

virtual bool	SupportsState (int state)=0

virtual void	DragStart (IPresentablePart::Pointer beingDragged, QPoint &initialPosition, bool keyboard)=0

virtual void	Close (const QList< IPresentablePart::Pointer > &toClose)=0

virtual void	DragStart (QPoint &initialPosition, bool keyboard)=0

virtual bool	IsCloseable (IPresentablePart::Pointer toClose)=0

virtual bool	IsPartMoveable (IPresentablePart::Pointer toMove)=0

virtual bool	IsStackMoveable ()=0

virtual void	SelectPart (IPresentablePart::Pointer toSelect)=0

virtual IPresentablePart::Pointer	GetSelectedPart ()=0

virtual void	FlushLayout ()=0

virtual QList< IPresentablePart::Pointer >	GetPartList ()=0

virtual QString	GetProperty (const QString &id)=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 int	STATE_MINIMIZED

static int	STATE_MAXIMIZED

static int	STATE_RESTORED

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

Represents the main interface between a StackPresentation and the workbench.

Not intended to be implemented by clients.

Since: 3.0

Definition at line 34 of file berryIStackPresentationSite.h.

Constructor & Destructor Documentation

◆ ~IStackPresentationSite()

berry::IStackPresentationSite::~IStackPresentationSite ( )

override

Member Function Documentation

◆ berryObjectMacro()

berry::IStackPresentationSite::berryObjectMacro ( berry::IStackPresentationSite )

◆ Close()

virtual void berry::IStackPresentationSite::Close ( const QList< IPresentablePart::Pointer > & toClose )

pure virtual

Closes the given set of parts.

Parameters

toClose the set of parts to close (Not null. All of the entries must be non-null)

◆ DragStart() [1/2]

virtual void berry::IStackPresentationSite::DragStart	(	IPresentablePart::Pointer	beingDragged,
		QPoint &	initialPosition,
		bool	keyboard
	)

pure virtual

Begins dragging the given part

Parameters

beingDragged	the part to drag (not null)
initialPosition	the mouse position at the time of the initial mousedown (display coordinates, not null)
keyboard	true iff the drag was initiated via mouse dragging, and false if the drag may be using the keyboard

◆ DragStart() [2/2]

virtual void berry::IStackPresentationSite::DragStart	(	QPoint &	initialPosition,
		bool	keyboard
	)

pure virtual

Begins dragging the entire stack of parts

Parameters

initialPosition	the mouse position at the time of the initial mousedown (display coordinates, not null)
keyboard	true iff the drag was initiated via mouse dragging, and false if the drag may be using the keyboard

◆ FlushLayout()

virtual void berry::IStackPresentationSite::FlushLayout ( )

pure virtual

Notifies the workbench that the preferred size of the presentation has changed. Hints to the workbench that it should trigger a layout at the next opportunity.

Since: 3.1

◆ GetPartList()

virtual QList<IPresentablePart::Pointer> berry::IStackPresentationSite::GetPartList ( )

pure virtual

Returns the list of presentable parts currently in this site

Returns: the list of presentable parts currently in this site

Since: 3.1

◆ GetProperty()

virtual QString berry::IStackPresentationSite::GetProperty ( const QString & id )

pure virtual

Returns the property with the given id or null. Folder properties are an extensible mechanism for perspective authors to customize the appearance of view stacks. The list of customizable properties is determined by the presentation factory, and set in the perspective factory.

Parameters

id	Must not be `null`.

Returns: property value, or null if the property is not set.

Since: 3.3

◆ GetSelectedPart()

virtual IPresentablePart::Pointer berry::IStackPresentationSite::GetSelectedPart ( )

pure virtual

Returns the currently selected part or null if the stack is empty

Returns: the currently selected part or null if the stack is empty

◆ GetState()

virtual int berry::IStackPresentationSite::GetState ( )

pure virtual

Returns the current state of the site (one of the STATE_* constants)

Returns: the current state of the site (one of the STATE_* constants)

◆ IsCloseable()

virtual bool berry::IStackPresentationSite::IsCloseable ( IPresentablePart::Pointer toClose )

pure virtual

Returns true iff this site will allow the given part to be closed

Parameters

toClose part to test (not null)

Returns: true iff the part may be closed

◆ IsPartMoveable()

virtual bool berry::IStackPresentationSite::IsPartMoveable ( IPresentablePart::Pointer toMove )

pure virtual

Returns true iff the given part can be dragged. If this returns false, the given part should not trigger a drag.

Parameters

toMove part to test (not null)

Returns: true iff this part is a valid drag source

◆ IsStackMoveable()

virtual bool berry::IStackPresentationSite::IsStackMoveable ( )

pure virtual

Returns true iff this entire stack can be dragged

Returns: true iff the stack can be dragged

◆ SelectPart()

virtual void berry::IStackPresentationSite::SelectPart ( IPresentablePart::Pointer toSelect )

pure virtual

Makes the given part active

Parameters

toSelect

◆ SetState()

virtual void berry::IStackPresentationSite::SetState ( int newState )

pure virtual

Sets the state of the container. Called by the presentation when the user causes the the container to be minimized, maximized, etc.

Parameters

newState one of the STATE_* constants

◆ SupportsState()

virtual bool berry::IStackPresentationSite::SupportsState ( int state )

pure virtual

Returns true iff the site supports the given state

Parameters

state one of the STATE_* constants, above

Returns: true iff the site supports the given state

Member Data Documentation

◆ STATE_MAXIMIZED

int berry::IStackPresentationSite::STATE_MAXIMIZED

static

Definition at line 41 of file berryIStackPresentationSite.h.

◆ STATE_MINIMIZED

int berry::IStackPresentationSite::STATE_MINIMIZED

static

Definition at line 39 of file berryIStackPresentationSite.h.

◆ STATE_RESTORED

int berry::IStackPresentationSite::STATE_RESTORED

static

Definition at line 43 of file berryIStackPresentationSite.h.

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

berryIStackPresentationSite.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IStackPresentationSite()

Member Function Documentation

◆ berryObjectMacro()

◆ Close()

◆ DragStart() [1/2]

◆ DragStart() [2/2]

◆ FlushLayout()

◆ GetPartList()

◆ GetProperty()

◆ GetSelectedPart()

◆ GetState()

◆ IsCloseable()

◆ IsPartMoveable()

◆ IsStackMoveable()

◆ SelectPart()

◆ SetState()

◆ SupportsState()

Member Data Documentation

◆ STATE_MAXIMIZED

◆ STATE_MINIMIZED

◆ STATE_RESTORED