FreeCAD: Gui::BaseView Class Reference

Base class of all windows belonging to a document there are two ways of belonging to a document. More...

#include <View.h>

Public Member Functions
	BaseView (Gui::Document *pcDocument=nullptr)
	View constructor Attach the view to the given document. More...

virtual	~BaseView ()
	View destructor Detach the view from the document, if attached! More...

methods used by the Application and the GuiDocument
void	setDocument (Gui::Document *pcDocument)
	sets the view to another document (called by Application) More...

void	onClose (void)
	is sent from the document in order to close the document More...

Gui::Document *	getGuiDocument () const
	returns the document the view is attached to More...

App::Document *	getAppDocument () const
	returns the document the view is attached to More...

bool	isPassive (void) const
	indicates if the view is in passive mode More...

Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...

	BaseClass (const BaseClass &)=default

virtual PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...

virtual Type	getTypeId () const

bool	isDerivedFrom (const Type type) const

BaseClass &	operator= (const BaseClass &)=default

virtual void	setPyObject (PyObject *)

virtual	~BaseClass ()
	Destruction. More...

methods to override
bool	bIsDetached

bool	bIsPassive

virtual void	onUpdate (void)
	get called when the document is updated More...

virtual void	onRelabel (Gui::Document *)
	get called when the document is relabeled (change of its user name) More...

virtual void	onRename (Gui::Document *)
	get called when the document is renamed (change of its internal name) More...

virtual const char *	getName (void) const
	returns the name of the view (important for messages) More...

virtual bool	onMsg (const char pMsg, const char *ppReturn)=0
	Message handler. More...

virtual bool	onHasMsg (const char *pMsg) const =0
	Message handler test. More...

virtual bool	canClose (void)
	overwrite when checking on close state More...

virtual void	deleteSelf ()
	delete itself More...

Additional Inherited Members
Static Public Member Functions inherited from Base::BaseClass
static void *	create ()

static Type	getClassTypeId ()

static void	init ()

Static Protected Member Functions inherited from Base::BaseClass
static void	initSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Type::instantiationMethod method=nullptr)

Detailed Description

Base class of all windows belonging to a document there are two ways of belonging to a document.

The first way is to a fixed one. The second way is to always belonging to the Active document. that means switching every time the active document is changing. It also means that the view belongs sometimes to no document at all!

See also: TreeView; Gui::Document; Application

Author: Juergen Riegel

Constructor & Destructor Documentation

◆ BaseView()

BaseView::BaseView ( Gui::Document * pcDocument = nullptr )

View constructor Attach the view to the given document.

If the document is 0 the view will attach to the active document. Be aware! there isn't always an active document!

◆ ~BaseView()

BaseView::~BaseView ( )

virtual

View destructor Detach the view from the document, if attached!

References onClose().

Member Function Documentation

◆ canClose()

virtual bool Gui::BaseView::canClose ( void )

virtual

overwrite when checking on close state

Reimplemented in Gui::AlignmentView, Gui::TextDocumentEditorView, Gui::DockWindow, Gui::EditorView, Gui::MDIView, and WebGui::BrowserView.

◆ deleteSelf()

void BaseView::deleteSelf ( )

virtual

delete itself

Reimplemented in Gui::MDIView, Gui::AbstractSplitView, Gui::View3DInventor, and SpreadsheetGui::SheetView.

◆ getAppDocument()

App::Document * BaseView::getAppDocument ( ) const

returns the document the view is attached to

Referenced by Gui::MDIView::canClose(), Gui::View3DInventor::dropEvent(), TechDrawGui::MDIViewPage::fixOrphans(), PartDesignGui::getBody(), Gui::View3DInventor::onHasMsg(), DrawingGui::DrawingView::onHasMsg(), SpreadsheetGui::SheetView::onHasMsg(), TechDrawGui::MDIViewPage::onHasMsg(), SpreadsheetGui::SheetView::onMsg(), and PartDesignGui::Workbench::setupContextMenu().

◆ getGuiDocument()

Gui::Document * Gui::BaseView::getGuiDocument ( ) const

returns the document the view is attached to

Referenced by Gui::TextDocumentEditorView::canClose(), Gui::MDIView::canClose(), Gui::MDIView::closeEvent(), DrawingGui::DrawingView::onHasMsg(), Gui::TextDocumentEditorView::onMsg(), Gui::View3DInventor::onMsg(), DrawingGui::DrawingView::onMsg(), SpreadsheetGui::SheetView::onMsg(), TechDrawGui::MDIViewPage::onMsg(), Gui::MDIView::redoActions(), Gui::View3DInventorPy::removeAnnotation(), Gui::View3DInventorPy::setAnnotation(), Gui::MDIView::undoActions(), and Gui::Application::viewActivated().

◆ getName()

virtual const char * Gui::BaseView::getName ( void ) const

virtual

returns the name of the view (important for messages)

Reimplemented in Gui::TextDocumentEditorView, Gui::DockWindow, Gui::EditorView, Gui::Dialog::LicenseView, Gui::AbstractSplitView, Gui::View3DInventor, ImageGui::ImageView, SpreadsheetGui::SheetView, WebGui::BrowserView, and Gui::DockWnd::SelectionView.

Referenced by Gui::GraphicsView3D::OnChange().

◆ isPassive()

bool Gui::BaseView::isPassive ( void ) const

indicates if the view is in passive mode

Referenced by TechDrawGui::MDIViewPage::setTabText(), and Gui::Application::viewActivated().

◆ onClose()

void BaseView::onClose ( void )

is sent from the document in order to close the document

References bIsDetached, bIsPassive, Gui::Application::detachView(), and Gui::Application::Instance.

Referenced by Gui::MDIView::deleteSelf(), and ~BaseView().

◆ onHasMsg()

virtual bool Gui::BaseView::onHasMsg ( const char * pMsg ) const

pure virtual

Message handler test.

Implemented in Gui::DockWindow, ImageGui::ImageView, Gui::TextDocumentEditorView, Gui::EditorView, Gui::PythonEditorView, Gui::GraphvizView, Gui::MDIView, Gui::AbstractSplitView, Gui::View3DInventor, DrawingGui::DrawingView, SpreadsheetGui::SheetView, TechDrawGui::MDIViewPage, and WebGui::BrowserView.

◆ onMsg()

virtual bool Gui::BaseView::onMsg	(	const char *	pMsg,
		const char **	ppReturn
	)

pure virtual

Message handler.

Implemented in Gui::DockWindow, ImageGui::ImageView, Gui::TextDocumentEditorView, Gui::EditorView, Gui::PythonEditorView, Gui::GraphvizView, Gui::MDIView, Gui::AbstractSplitView, Gui::View3DInventor, DrawingGui::DrawingView, SpreadsheetGui::SheetView, TechDrawGui::MDIViewPage, WebGui::BrowserView, and Gui::DockWnd::SelectionView.

◆ onRelabel()

virtual void Gui::BaseView::onRelabel ( Gui::Document * )

virtual

get called when the document is relabeled (change of its user name)

Reimplemented in Gui::MDIView, and DrawingGui::DrawingView.

◆ onRename()

virtual void Gui::BaseView::onRename ( Gui::Document * )

virtual

get called when the document is renamed (change of its internal name)

Reimplemented in Gui::View3DInventor.

◆ onUpdate()

virtual void Gui::BaseView::onUpdate ( void )

virtual

get called when the document is updated

Reimplemented in Gui::DockWindow, Gui::EditorView, Gui::AbstractSplitView, Gui::View3DInventor, ImageGui::ImageView, and Gui::DockWnd::SelectionView.

◆ setDocument()

void BaseView::setDocument ( Gui::Document * pcDocument )

sets the view to another document (called by Application)

References Gui::Document::attachView().

Member Data Documentation

◆ bIsDetached

bool Gui::BaseView::bIsDetached

protected

Referenced by onClose().

◆ bIsPassive

bool Gui::BaseView::bIsPassive

protected

Referenced by Gui::MDIView::canClose(), Gui::MDIView::closeEvent(), onClose(), Gui::MDIView::onRelabel(), and DrawingGui::DrawingView::onRelabel().

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

FreeCAD/src/Gui/View.h
FreeCAD/src/Gui/View.cpp