berry::IPlaceholderFolderLayout Struct Reference

#include <berryIPlaceholderFolderLayout.h>

Inheritance diagram for berry::IPlaceholderFolderLayout:

Collaboration diagram for berry::IPlaceholderFolderLayout:

Public Member Functions
	berryObjectMacro (berry::IPlaceholderFolderLayout)
	~IPlaceholderFolderLayout () override
virtual void	AddPlaceholder (const QString &viewId)=0
virtual QString	GetProperty (const QString &id)=0
virtual void	SetProperty (const QString &id, const QString &value)=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

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

An IPlaceholderFolderLayout is used to define the initial view placeholders within a folder. The folder itself is contained within an IPageLayout.

This interface is not intended to be implemented by clients.

See also

IPageLayout::CreatePlaceholderFolder

Definition at line 35 of file berryIPlaceholderFolderLayout.h.

Constructor & Destructor Documentation

~IPlaceholderFolderLayout()

berry::IPlaceholderFolderLayout::~IPlaceholderFolderLayout ( )

override

Member Function Documentation

AddPlaceholder()

virtual void berry::IPlaceholderFolderLayout::AddPlaceholder ( const QString &  viewId )

pure virtual

Adds a view placeholder to this folder. A view placeholder is used to define the position of a view before the view appears. Initially, it is invisible; however, if the user ever opens a view whose compound id matches the placeholder, the view will appear at the same location as the placeholder. See the IPageLayout type documentation for more details about compound ids. If the placeholder contains wildcards, it remains in the layout, otherwise it is replaced by the view. If the primary id of the placeholder has no wildcards, it must refer to a view contributed to the workbench's view extension point (named "org.blueberry.ui.views").

Parameters

viewId

the compound view id (wildcards allowed)

berryObjectMacro()

berry::IPlaceholderFolderLayout::berryObjectMacro

(

berry::IPlaceholderFolderLayout

)

GetProperty()

virtual QString berry::IPlaceholderFolderLayout::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.

Parameters

id	Must not be null.

Returns

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

Since

3.3

SetProperty()

virtual void berry::IPlaceholderFolderLayout::SetProperty ( const QString &  id, const QString &  value  )

pure virtual

Sets the given property to the given value. 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.

These folder properties are intended to be set during IPerspectiveFactory::createInitialLayout. Any subsequent changes to property values after this method completes will not fire change notifications and will not be reflected in the presentation.

Parameters

id	property id. Must not be null.
value	property value. null will clear the property.

Since

3.3

---

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

• berryIPlaceholderFolderLayout.h