Workbench Class Reference

#include <rcp/Workbench.h>

Inheritance diagram for Workbench:

Classes
struct	MinimizedDockArea
struct	MinimizedDockWidgetState
class	Perspective

Public Types
typedef boost::shared_ptr< Perspective >	PerspectivePtr

Public Slots
Perspective *	addPerspective (std::string name)
void	removePerspective (Perspective *perspective)
void	activatePerspective (Perspective *perspective)

Public Member Functions
	Workbench (bool setupUi=true)
virtual	~Workbench ()
void	reflect (XMLSerializer &r)
void	reflect (XMLDeserializer &r)
void	setupUi ()
QWidget *	createPart (ClassProxy partClass)
QWidget *	restorePart (ClassProxy partClass, const XMLDom &xml)
virtual void	saveWorkspace (const std::string &file)
virtual void	loadWorkspace (const std::string &file)
void	cleanupWorkspace ()
	removes all perspectives More...
bool	isDockAreaMinimized (Qt::DockWidgetArea area)
void	minimizeDockArea (Qt::DockWidgetArea area)
void	restoreDockArea (Qt::DockWidgetArea area)
QMenu *	createPopupMenu ()
virtual void	addPartListener (IPartListener *listener)
virtual void	removePartListener (IPartListener *listener)
virtual IWorkbenchPart *	getActiveEditor ()
	Returns the currently active editor part, or NULL, if no editor is active. More...
virtual std::list< IWorkbenchPart * >	getEditors (bool backToFront=false)
	Returns a list of all editors of this workbench site. More...
void	savePartMemory ()
void	loadPartMemory ()

Protected Types
typedef boost::shared_ptr< XMLDom >	XMLDomPtr

Protected Slots
virtual void	onEditorCreated (EditorPart *editor)
virtual void	onEditorDestroyed (EditorPart *editor)
virtual void	onWindowTitleChanged (EditorPartWindow *editor)
virtual void	onEditorWindowActivated (EditorPartWindow *window)
void	storePartMemory (ViewPart *part)
void	storePartMemory (EditorPart *part)

Protected Member Functions
void	createMinimizedDockArea (Qt::DockWidgetArea area)

Protected Attributes
std::list< ViewPart * >	mViewParts
std::list< EditorPart * >	mEditorParts
std::map< std::string, ViewPart * >	mCreatedViews
std::list< PerspectivePtr >	mPerspectives
Perspective *	mCurrentPerspective
std::map< Qt::DockWidgetArea, MinimizedDockArea >	mMinimizedDockAreas
QSignalMapper *	mDockRestoreMapper
std::map< QDockWidget *, MinimizedDockWidgetState >	mMinimizedDockWidgetStates
std::map< std::string, XMLDomPtr >	mPartMemory

Member Typedef Documentation

PerspectivePtr

typedef boost::shared_ptr<Perspective> PerspectivePtr

XMLDomPtr

typedef boost::shared_ptr<XMLDom> XMLDomPtr

protected

Constructor & Destructor Documentation

Workbench()

Workbench

(

bool

setupUi = true

)

~Workbench()

virtual ~Workbench ( )

virtual

Member Function Documentation

reflect() [1/2]

void reflect

(

XMLSerializer &

r

)

reflect() [2/2]

void reflect

(

XMLDeserializer &

r

)

setupUi()

void setupUi

(

)

createPart()

QWidget* createPart

(

ClassProxy

partClass

)

restorePart()

QWidget* restorePart	(	ClassProxy	partClass,
		const XMLDom &	xml
	)

saveWorkspace()

virtual void saveWorkspace ( const std::string &  file )

virtual

loadWorkspace()

virtual void loadWorkspace ( const std::string &  file )

virtual

cleanupWorkspace()

void cleanupWorkspace

(

)

removes all perspectives

isDockAreaMinimized()

bool isDockAreaMinimized

(

Qt::DockWidgetArea

area

)

minimizeDockArea()

void minimizeDockArea

(

Qt::DockWidgetArea

area

)

restoreDockArea()

void restoreDockArea

(

Qt::DockWidgetArea

area

)

createMinimizedDockArea()

void createMinimizedDockArea ( Qt::DockWidgetArea  area )

protected

createPopupMenu()

QMenu* createPopupMenu

(

)

addPerspective

Perspective* addPerspective ( std::string  name )

slot

removePerspective

void removePerspective ( Perspective *  perspective )

slot

activatePerspective

void activatePerspective ( Perspective *  perspective )

slot

onEditorCreated

virtual void onEditorCreated ( EditorPart *  editor )

protectedvirtualslot

onEditorDestroyed

virtual void onEditorDestroyed ( EditorPart *  editor )

protectedvirtualslot

onWindowTitleChanged

virtual void onWindowTitleChanged ( EditorPartWindow *  editor )

protectedvirtualslot

onEditorWindowActivated

virtual void onEditorWindowActivated ( EditorPartWindow *  window )

protectedvirtualslot

addPartListener()

virtual void addPartListener ( IPartListener *  listener )

virtual

Implements IWorkbenchPartSite.

removePartListener()

virtual void removePartListener ( IPartListener *  listener )

virtual

Implements IWorkbenchPartSite.

getActiveEditor()

virtual IWorkbenchPart* getActiveEditor ( )

virtual

Returns the currently active editor part, or NULL, if no editor is active.

Implements IWorkbenchPartSite.

getEditors()

virtual std::list<IWorkbenchPart*> getEditors ( bool  backToFront = false )

virtual

Returns a list of all editors of this workbench site.

By default, they are in order of creation. If backToFront=true, they are ordered in their current stack order.

Implements IWorkbenchPartSite.

savePartMemory()

void savePartMemory

(

)

loadPartMemory()

void loadPartMemory

(

)

storePartMemory [1/2]

void storePartMemory ( ViewPart *  part )

protectedslot

storePartMemory [2/2]

void storePartMemory ( EditorPart *  part )

protectedslot

Member Data Documentation

mViewParts

std::list<ViewPart*> mViewParts

protected

mEditorParts

std::list<EditorPart*> mEditorParts

protected

mCreatedViews

std::map<std::string, ViewPart*> mCreatedViews

protected

mPerspectives

std::list<PerspectivePtr> mPerspectives

protected

mCurrentPerspective

Perspective* mCurrentPerspective

protected

mMinimizedDockAreas

std::map<Qt::DockWidgetArea, MinimizedDockArea> mMinimizedDockAreas

protected

mDockRestoreMapper

QSignalMapper* mDockRestoreMapper

protected

mMinimizedDockWidgetStates

std::map<QDockWidget*, MinimizedDockWidgetState> mMinimizedDockWidgetStates

protected

mPartMemory

std::map<std::string, XMLDomPtr> mPartMemory

protected

---

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

• gui/include/rcp/Workbench.h