#include <berryIWorkbenchWindow.h>

Inheritance diagram for berry::IWorkbenchWindow:

[legend]

Collaboration diagram for berry::IWorkbenchWindow:

[legend]

Public Member Functions
	berryObjectMacro (berry::IWorkbenchWindow, IPageService, IServiceLocator, Object)

virtual bool	Close ()=0

virtual QList< SmartPointer< IWorkbenchPage > >	GetPages () const =0

SmartPointer< IWorkbenchPage >	GetActivePage () const override=0

virtual void	SetActivePage (SmartPointer< IWorkbenchPage > page)=0

virtual IPartService *	GetPartService ()=0

virtual ISelectionService *	GetSelectionService () const =0

virtual Shell::Pointer	GetShell () const =0

virtual IWorkbench *	GetWorkbench () const =0

virtual SmartPointer< IWorkbenchPage >	OpenPage (const QString &perspectiveId, IAdaptable *input)=0

virtual SmartPointer< IWorkbenchPage >	OpenPage (IAdaptable *input)=0

	~IWorkbenchWindow () override

Public Member Functions inherited from berry::IPageService
virtual	~IPageService ()

virtual void	AddPerspectiveListener (IPerspectiveListener *listener)=0

virtual void	RemovePerspectiveListener (IPerspectiveListener *listener)=0

virtual IPerspectiveListener::Events &	GetPerspectiveEvents ()=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

A workbench window is a top level window in a workbench. Visually, a workbench window has a menubar, a toolbar, a status bar, and a main area for displaying a single page consisting of a collection of views and editors.

Each workbench window has a collection of 0 or more pages; the active page is the one that is being presented to the end user; at most one page is active in a window at a time.

The workbench window 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 window is closed. The supported services are:

This interface is not intended to be implemented by clients.

See also: IWorkbenchPage

Definition at line 62 of file berryIWorkbenchWindow.h.

Constructor & Destructor Documentation

◆ ~IWorkbenchWindow()

berry::IWorkbenchWindow::~IWorkbenchWindow ( )

override

Member Function Documentation

◆ berryObjectMacro()

berry::IWorkbenchWindow::berryObjectMacro	(	berry::IWorkbenchWindow	,
		IPageService	,
		IServiceLocator	,
		Object
	)

◆ Close()

virtual bool berry::IWorkbenchWindow::Close ( )

pure virtual

Closes this workbench window.

If the window has an open editor with unsaved content, the user will be given the opportunity to save it.

Returns: true if the window was successfully closed, and false if it is still open

◆ GetActivePage()

SmartPointer<IWorkbenchPage> berry::IWorkbenchWindow::GetActivePage ( ) const

overridepure virtual

Returns the currently active page for this workbench window.

Returns: the active page, or null if none

Implements berry::IPageService.

◆ GetPages()

virtual QList<SmartPointer<IWorkbenchPage> > berry::IWorkbenchWindow::GetPages ( ) const

pure virtual

Returns a list of the pages in this workbench window.

Note that each window has its own pages; pages are never shared between different windows.

Returns: a list of pages

◆ GetPartService()

virtual IPartService* berry::IWorkbenchWindow::GetPartService ( )

pure virtual

Returns the part service which tracks part activation within this workbench window.

Returns: the part service

◆ GetSelectionService()

virtual ISelectionService* berry::IWorkbenchWindow::GetSelectionService ( ) const

pure virtual

Returns the selection service which tracks selection within this workbench window.

Returns: the selection service

◆ GetShell()

virtual Shell::Pointer berry::IWorkbenchWindow::GetShell ( ) const

pure virtual

Returns this workbench window's shell.

Returns: the shell containing this window's controls or null if the shell has not been created yet or if the window has been closed

◆ GetWorkbench()

virtual IWorkbench* berry::IWorkbenchWindow::GetWorkbench ( ) const

pure virtual

Returns the workbench for this window.

Returns: the workbench

◆ OpenPage() [1/2]

virtual SmartPointer<IWorkbenchPage> berry::IWorkbenchWindow::OpenPage	(	const QString &	perspectiveId,
		IAdaptable *	input
	)

pure virtual

Creates and opens a new workbench page. The perspective of the new page is defined by the specified perspective ID. The new page become active.

Note: Since release 2.0, a window is limited to contain at most one page. If a page exist in the window when this method is used, then another window is created for the new page. Callers are strongly recommended to use the IWorkbench.showPerspective APIs to programmatically show a perspective.

Parameters

perspectiveId	the perspective id for the window's initial page
input	the page input, or `null` if there is no current input. This is used to seed the input for the new page's views.

Returns: the new workbench page

Exceptions

WorkbenchException if a page could not be opened

See also: IWorkbench::showPerspective(String, IWorkbenchWindow, IAdaptable)

◆ OpenPage() [2/2]

virtual SmartPointer<IWorkbenchPage> berry::IWorkbenchWindow::OpenPage ( IAdaptable * input )

pure virtual

Creates and opens a new workbench page. The default perspective is used as a template for creating the page. The page becomes active.

Note: Since release 2.0, a window is limited to contain at most one page. If a page exist in the window when this method is used, then another window is created for the new page. Callers are strongly recommended to use the IWorkbench.showPerspective APIs to programmatically show a perspective.

Parameters

input the page input, or null if there is no current input. This is used to seed the input for the new page's views.

Returns: the new workbench window

Exceptions

WorkbenchException if a page could not be opened

See also: IWorkbench::showPerspective(String, IWorkbenchWindow, IAdaptable)

◆ SetActivePage()

virtual void berry::IWorkbenchWindow::SetActivePage ( SmartPointer< IWorkbenchPage > page )

pure virtual

Sets or clears the currently active page for this workbench window.

Parameters

page	the new active page

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

berryIWorkbenchWindow.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IWorkbenchWindow()

Member Function Documentation

◆ berryObjectMacro()

◆ Close()

◆ GetActivePage()

◆ GetPages()

◆ GetPartService()

◆ GetSelectionService()

◆ GetShell()

◆ GetWorkbench()

◆ OpenPage() [1/2]

◆ OpenPage() [2/2]

◆ SetActivePage()