berry::IWorkbenchSite Struct Reference

#include <berryIWorkbenchSite.h>

Inheritance diagram for berry::IWorkbenchSite:

Collaboration diagram for berry::IWorkbenchSite:

Public Member Functions
	berryObjectMacro (berry::IWorkbenchSite, IServiceLocator)
	~IWorkbenchSite () override
virtual SmartPointer< IWorkbenchPage >	GetPage ()=0
virtual SmartPointer< ISelectionProvider >	GetSelectionProvider ()=0
virtual SmartPointer< Shell >	GetShell ()=0
virtual SmartPointer< IWorkbenchWindow >	GetWorkbenchWindow ()=0
virtual void	SetSelectionProvider (SmartPointer< ISelectionProvider > provider)=0
Public Member Functions inherited from berry::IServiceLocator
	berryObjectMacro (berry::IServiceLocator, Object)
	~IServiceLocator () override
template<class S >
S *	GetService ()
template<class S >
bool	HasService () const
virtual Object *	GetService (const QString &api)=0
virtual bool	HasService (const QString &api) 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

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

The common interface between the workbench and its parts, including pages within parts.

The workbench site supports a few services by default. If these services are used to allocate resources, it is important to remember to clean up those resources after you are done with them. Otherwise, the resources will exist until the workbench site is disposed. The supported services are:

• ICommandService
• IContextService
• IHandlerService

This interface is not intended to be implemented or extended by clients.

See also

org.blueberry.ui.IWorkbenchPartSite

org.blueberry.ui.part.IPageSite

Since

2.0

Definition at line 54 of file berryIWorkbenchSite.h.

Constructor & Destructor Documentation

~IWorkbenchSite()

berry::IWorkbenchSite::~IWorkbenchSite ( )

override

Member Function Documentation

berryObjectMacro()

berry::IWorkbenchSite::berryObjectMacro	(	berry::IWorkbenchSite	,
		IServiceLocator
	)

GetPage()

virtual SmartPointer<IWorkbenchPage> berry::IWorkbenchSite::GetPage ( )

pure virtual

Returns the page containing this workbench site.

Returns

the page containing this workbench site

GetSelectionProvider()

virtual SmartPointer<ISelectionProvider> berry::IWorkbenchSite::GetSelectionProvider ( )

pure virtual

Returns the selection provider for this workbench site.

Returns

the selection provider, or null if none

GetShell()

virtual SmartPointer<Shell> berry::IWorkbenchSite::GetShell ( )

pure virtual

Returns the shell for this workbench site. Not intended to be called from outside the UI thread. Clients should call IWorkbench.getDisplay() to gain access to the display rather than calling getShell().getDisplay().

Returns

the shell for this workbench site

GetWorkbenchWindow()

virtual SmartPointer<IWorkbenchWindow> berry::IWorkbenchSite::GetWorkbenchWindow ( )

pure virtual

Returns the workbench window containing this workbench site.

Returns

the workbench window containing this workbench site

SetSelectionProvider()

virtual void berry::IWorkbenchSite::SetSelectionProvider ( SmartPointer< ISelectionProvider >  provider )

pure virtual

Sets the selection provider for this workbench site.

Parameters

provider

the selection provider, or null to clear it

---

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

• berryIWorkbenchSite.h