The Gui Document This is the document on GUI level. More...

#include <Document.h>

Public Member Functions
	Document (App::Document pcDocument, Application app)

	~Document ()

methods for View handling
Gui::MDIView *	getActiveView (void) const
	Getter for the active view. More...

void	setActiveWindow (Gui::MDIView *view)
	Document::setActiveWindow If this document is active and the view is part of it then it will be activated. More...

Gui::MDIView *	getEditingViewOfViewProvider (Gui::ViewProvider *) const

Gui::MDIView *	getViewOfViewProvider (const Gui::ViewProvider *) const

Gui::MDIView *	getViewOfNode (SoNode *) const

MDIView *	createView (const Base::Type &typeId)
	Create a new view. More...

Gui::MDIView *	cloneView (Gui::MDIView *)
	Create a clone of the given view. More...

bool	sendMsgToViews (const char *pMsg)
	send messages to the active view Send a specific massage to the active view and is able to receive a return message More...

bool	sendMsgToFirstView (const Base::Type &typeId, const char pMsg, const char *ppReturn)
	Sends the message pMsg to the views of type typeid and stops with the first view that supports the message and returns ppReturn. More...

void	attachView (Gui::BaseView *pcView, bool bPassiv=false)
	Attach a view (get called by the MDIView constructor) More...

void	detachView (Gui::BaseView *pcView, bool bPassiv=false)
	Detach a view (get called by the MDIView destructor) More...

ViewProviderDocumentObject *	getViewProviderByPathFromTail (SoPath *path) const
	helper for selection More...

ViewProviderDocumentObject *	getViewProviderByPathFromHead (SoPath *path) const
	helper for selection More...

std::vector< std::pair< ViewProviderDocumentObject *, int > >	getViewProvidersByPath (SoPath *path) const
	Get all view providers along the path and the corresponding node index in the path. More...

void	onUpdate (void)
	call update on all attached views More...

void	onRelabel (void)
	call relabel to all attached views More...

std::list< MDIView * >	getMDIViews () const
	returns a list of all attached MDI views More...

std::list< MDIView * >	getMDIViewsOfType (const Base::Type &typeId) const
	returns a list of all MDI views of a certain type More...

MDIView *	setActiveView (ViewProviderDocumentObject *vp=nullptr, Base::Type typeId=Base::Type())

View provider handling <br>
ViewProvider *	getViewProvider (const App::DocumentObject *) const
	Get the view provider for that object. More...

ViewProviderDocumentObject *	getViewProvider (SoNode *node) const

void	setAnnotationViewProvider (const char name, ViewProvider pcProvider)
	set an annotation view provider More...

ViewProvider *	getAnnotationViewProvider (const char *name) const
	get an annotation view provider More...

void	removeAnnotationViewProvider (const char *name)
	remove an annotation view provider More...

bool	isShow (const char *name)
	test if the feature is in show More...

void	setShow (const char *name)
	put the feature in show More...

void	setHide (const char *name)
	set the feature in Noshow More...

void	setPos (const char *name, const Base::Matrix4D &rclMtrx)
	set the feature transformation (only viewing) More...

std::vector< ViewProvider * >	getViewProvidersOfType (const Base::Type &typeId) const

ViewProvider *	getViewProviderByName (const char *name) const

bool	setEdit (Gui::ViewProvider p, int ModNum=0, const char subname=nullptr)
	set the ViewProvider in special edit mode More...

const Base::Matrix4D &	getEditingTransform () const

void	setEditingTransform (const Base::Matrix4D &mat)

void	resetEdit (void)
	reset from edit mode, this cause all document to reset edit More...

ViewProvider *	getInEdit (ViewProviderDocumentObject *parentVp=nullptr, std::string subname=nullptr, int mode=nullptr, std::string subElement=nullptr) const
	get the in edit ViewProvider or NULL More...

void	setInEdit (ViewProviderDocumentObject parentVp, const char subname)
	set the in edit ViewProvider subname reference More...

void	toggleInSceneGraph (ViewProvider *vp)
	Add or remove view provider from scene graphs of all views. More...

Public Member Functions inherited from Base::Persistence
void	dumpToStream (std::ostream &stream, int compression)

virtual unsigned int	getMemSize () const =0
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

virtual Base::Type	getTypeId (void) const

virtual void	Restore (XMLReader &)=0
	This method is used to restore properties from an XML document. More...

virtual void	RestoreDocFile (Reader &)
	This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...

void	restoreFromStream (std::istream &stream)

virtual void	Save (Writer &) const =0
	This method is used to save properties to an XML document. More...

virtual void	SaveDocFile (Writer &) const
	This method is used to save large amounts of data to a binary file. 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...

Public Attributes
Signals of the document
boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalNewObject
	signal on new Object More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalDeletedObject
	signal on deleted Object More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &, const App::Property &)>	signalChangedObject
	signal on changed Object, the 2nd argument is the changed property of the referenced document object, not of the view provider More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalRelabelObject
	signal on renamed Object More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalActivatedObject
	signal on activated Object More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalInEdit
	signal on entering in edit mode More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalResetEdit
	signal on leaving edit mode More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &, const Gui::HighlightMode &, bool, App::DocumentObject parent, const char subname)>	signalHighlightObject
	signal on changed Object, the 2nd argument is the highlite mode to use More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &, const Gui::TreeItemMode &, App::DocumentObject parent, const char subname)>	signalExpandObject
	signal on changed Object, the 2nd argument is the highlite mode to use More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalShowItem
	signal on changed ShowInTree property in view provider More...

boost::signals2::signal< void(const Gui::ViewProviderDocumentObject &)>	signalScrollToObject
	signal on scrolling to an object More...

boost::signals2::signal< void(const Gui::Document &doc)>	signalUndoDocument
	signal on undo Document More...

boost::signals2::signal< void(const Gui::Document &doc)>	signalRedoDocument
	signal on redo Document More...

boost::signals2::signal< void(const Gui::Document &doc)>	signalDeleteDocument
	signal on deleting Document More...

methods for the UNDO REDO handling
void	openCommand (const char *sName=nullptr)
	Open a new Undo transaction on the document. More...

void	commitCommand (void)
	Commit the Undo transaction on the document. More...

void	abortCommand (void)
	Abort the Undo transaction on the document. More...

bool	hasPendingCommand (void) const
	Check if an Undo transaction is open. More...

std::vector< std::string >	getUndoVector (void) const
	Get an Undo string vector with the Undo names. More...

std::vector< std::string >	getRedoVector (void) const
	Get an Redo string vector with the Redo names. More...

void	undo (int iSteps)
	Will UNDO one or more steps. More...

void	redo (int iSteps)
	Will REDO one or more steps. More...

bool	isPerformingTransaction () const
	Check if the document is performing undo/redo transaction. More...

bool	canClose (bool checkModify=true, bool checkLink=false)
	handles the application close event More...

bool	isLastView (void)

void	beforeDelete ()
	called by Application before being deleted More...

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

const char *	getCameraSettings () const

bool	saveCameraSettings (const char *) const

attributes for the UNDO REDO facility
class	TransactionViewProvider

I/O of the document
unsigned int	getMemSize (void) const
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

bool	save (void)
	Save the document. More...

bool	saveAs (void)
	Save the document under a new file name. More...

bool	saveCopy (void)
	Save a copy of the document under a new file name. More...

virtual void	Save (Base::Writer &writer) const
	This method is used to save properties or very small amounts of data to an XML document. More...

virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...

virtual void	SaveDocFile (Base::Writer &writer) const
	This method is used to save large amounts of data to a binary file. More...

virtual void	RestoreDocFile (Base::Reader &reader)
	This method is used to restore large amounts of data from a binary file. More...

void	exportObjects (const std::vector< App::DocumentObject * > &, Base::Writer &)

void	importObjects (const std::vector< App::DocumentObject * > &, Base::Reader &, const std::map< std::string, std::string > &nameMapping)

void	addRootObjectsToGroup (const std::vector< App::DocumentObject * > &, App::DocumentObjectGroup *)
	Add all root objects of the given array to a group. More...

void	setModified (bool)
	Observer message from the App doc. More...

bool	isModified () const

App::Document *	getDocument (void) const
	Getter for the App Document. More...

void	slotNewObject (const App::DocumentObject &)
	This slot is connected to the App::Document::signalNewObject(...) More...

void	slotDeletedObject (const App::DocumentObject &)

void	slotChangedObject (const App::DocumentObject &, const App::Property &)

void	slotRelabelObject (const App::DocumentObject &)

void	slotTransactionAppend (const App::DocumentObject &, App::Transaction *)

void	slotTransactionRemove (const App::DocumentObject &, App::Transaction *)

void	slotActivatedObject (const App::DocumentObject &)

void	slotStartRestoreDocument (const App::Document &)

void	slotFinishRestoreDocument (const App::Document &)

void	slotUndoDocument (const App::Document &)

void	slotRedoDocument (const App::Document &)

void	slotShowHidden (const App::Document &)

void	slotFinishImportObjects (const std::vector< App::DocumentObject * > &)

void	slotFinishRestoreObject (const App::DocumentObject &obj)

void	slotRecomputed (const App::Document &)

void	slotSkipRecompute (const App::Document &doc, const std::vector< App::DocumentObject * > &objs)

void	slotTouchedObject (const App::DocumentObject &)

void	slotChangePropertyEditor (const App::Document &, const App::Property &)

void	addViewProvider (Gui::ViewProviderDocumentObject *)

static void	saveAll ()
	Save all open document. More...

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

static std::string	encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...

static Base::Type	getClassTypeId (void)

static void	init (void)

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

The Gui Document This is the document on GUI level.

Its main responsibility is keeping track off open windows for a document and warning on unsaved closes. All handled views on the document must inherit from MDIView

See also: App::Document; MDIView

Author: Jürgen Riegel

Constructor & Destructor Documentation

◆ Document()

Document::Document	(	App::Document *	pcDocument,
		Application *	app
	)

◆ ~Document()

Document::~Document ( )

Member Function Documentation

◆ abortCommand()

void Document::abortCommand ( void )

Abort the Undo transaction on the document.

References App::Document::abortTransaction(), and getDocument().

Referenced by MeshGui::ViewProviderMesh::clipMeshCallback(), ReverseEngineeringGui::SegmentationManual::createSegment(), SketcherGui::ViewProviderSketch::mouseButtonPressed(), PartGui::TaskDlgAttacher::reject(), and MeshGui::ViewProviderMesh::trimMeshCallback().

◆ addRootObjectsToGroup()

void Document::addRootObjectsToGroup	(	const std::vector< App::DocumentObject * > &	obj,
		App::DocumentObjectGroup *	grp
	)

Add all root objects of the given array to a group.

References Gui::ViewProvider::claimChildren(), and getViewProvider().

◆ addViewProvider()

void Document::addViewProvider ( Gui::ViewProviderDocumentObject * vp )

protected

References Gui::Detach, Gui::ViewProviderDocumentObject::getObject(), Gui::ViewProvider::getRoot(), and Gui::ViewProvider::setStatus().

◆ attachView()

void Document::attachView	(	Gui::BaseView *	pcView,
		bool	bPassiv = `false`
	)

Attach a view (get called by the MDIView constructor)

References Gui::DocumentP::baseViews, and Gui::DocumentP::passiveViews.

Referenced by Gui::BaseView::setDocument().

◆ beforeDelete()

void Document::beforeDelete ( )

called by Application before being deleted

References Gui::Application::editDocument(), Gui::Application::Instance, and Gui::Application::setEditDocument().

◆ canClose()

bool Document::canClose	(	bool	checkModify = `true`,
		bool	checkLink = `false`
	)

handles the application close event

This method checks if the document can be closed.

It checks on the save state of the document and is able to abort the closing.

References Gui::ControlSingleton::activeDialog(), Gui::MainWindow::confirmSave(), Gui::Control(), getActiveView(), getDocument(), App::PropertyXLink::getDocumentInList(), Gui::TaskView::TaskDialog::getDocumentName(), Gui::getMainWindow(), App::PropertyString::getValue(), isModified(), App::Document::Label, App::Document::PartialDoc, save(), and App::Document::TempDoc.

◆ cloneView()

Gui::MDIView * Document::cloneView ( Gui::MDIView * oldview )

Create a clone of the given view.

◆ commitCommand()

void Document::commitCommand ( void )

Commit the Undo transaction on the document.

References App::Document::commitTransaction(), and getDocument().

Referenced by PartGui::TaskDlgAttacher::accept(), Gui::TaskCSysDragger::accept(), Gui::ManualAlignment::align(), MeshGui::ViewProviderMesh::clipMeshCallback(), PartGui::DlgPrimitives::createPrimitive(), ReverseEngineeringGui::SegmentationManual::createSegment(), PointsGui::ViewProviderScattered::cut(), PointsGui::ViewProviderStructured::cut(), MeshGui::ViewProviderMesh::fillHole(), MeshGui::ViewProviderMesh::markPartCallback(), SketcherGui::ViewProviderSketch::mouseButtonPressed(), MeshGui::DlgRegularSolidImp::on_createSolidButton_clicked(), MeshGui::ViewProviderMesh::partMeshCallback(), MeshGui::ViewProviderMesh::segmMeshCallback(), and MeshGui::ViewProviderMesh::trimMeshCallback().

◆ createView()

◆ detachView()

void Document::detachView	(	Gui::BaseView *	pcView,
		bool	bPassiv = `false`
	)

Detach a view (get called by the MDIView destructor)

References Gui::DocumentP::baseViews, DraftVecUtils::find(), getDocument(), App::PropertyXLink::getDocumentInList(), and Gui::DocumentP::passiveViews.

◆ exportObjects()

void Document::exportObjects	(	const std::vector< App::DocumentObject * > &	obj,
		Base::Writer &	writer
	)

References Base::Writer::decInd(), App::Expand, Gui::Application::getDocument(), App::ExtensionContainer::hasExtensions(), Base::Writer::incInd(), Base::Writer::ind(), Gui::Application::Instance, Base::Writer::isForceXML(), App::ExtensionContainer::Save(), Base::Writer::setForceXML(), and Base::Writer::Stream().

Referenced by Document(), and Gui::MergeDocuments::SaveDocFile().

◆ getActiveView()

MDIView * Document::getActiveView ( void ) const

Getter for the active view.

References Gui::MainWindow::activeWindow(), Base::BaseClass::getClassTypeId(), Gui::getMainWindow(), getMDIViews(), and Gui::MainWindow::windows().

Referenced by StdCmdViewCreate::activated(), SketcherGui::ViewProviderSketch::activateHandler(), Gui::Application::activeView(), Gui::SelectionSingleton::addSelection(), canClose(), TechDrawGui::Grabber3d::copyActiveViewToSvgFile(), Gui::ViewProviderDocumentObject::getActiveView(), getInEdit(), Gui::Command::isViewOfType(), SketcherGui::ViewProviderSketch::purgeHandler(), Gui::SelectionSingleton::rmvPreselect(), sendMsgToFirstView(), setActiveView(), setEdit(), setEditingTransform(), Gui::SelectionSingleton::setPreselect(), Gui::Application::sExport(), Gui::Application::slotActiveDocument(), Gui::Application::sSetActiveDocument(), and SketcherGui::ViewProviderSketch::updateData().

◆ getAnnotationViewProvider()

ViewProvider * Document::getAnnotationViewProvider ( const char * name ) const

get an annotation view provider

Referenced by Gui::View3DInventorPy::removeAnnotation().

◆ getCameraSettings()

const char * Document::getCameraSettings ( ) const

Referenced by SaveDocFile().

◆ getDocument()

App::Document * Document::getDocument ( void ) const

Getter for the App Document.

Referenced by abortCommand(), Gui::Dialog::DlgMacroExecuteImp::accept(), Gui::TaskCSysDragger::accept(), Gui::MacroCommand::activated(), StdCmdImport::activated(), StdCmdToggleSelectability::activated(), Gui::RecentMacrosAction::activateFile(), PartGui::FaceColors::Private::addFacesToSelection(), canClose(), Gui::View3DInventorViewer::checkGroupOnTop(), commitCommand(), Gui::TreeWidget::contextMenuEvent(), ReverseEngineeringGui::SegmentationManual::createSegment(), createView(), Gui::DocumentIndex::data(), detachView(), Gui::View3DInventorViewer::dropEvent(), Gui::TreeWidget::dropEvent(), ReverseEngineeringGui::SegmentationManual::Private::findGeometry(), Gui::ManualAlignment::finish(), Gui::LinkInfo::getDocName(), Gui::Command::getDocument(), getRedoVector(), getUndoVector(), getViewProviderByName(), hasPendingCommand(), Gui::Command::isActiveObjectValid(), Gui::DAG::Model::Model(), Gui::TreeWidget::onAllowPartialRecompute(), Gui::TreeWidget::onCreateGroup(), Gui::Application::onLastWindowClosed(), Gui::TreeWidget::onMarkRecompute(), Gui::MDIView::onRelabel(), DrawingGui::DrawingView::onRelabel(), Gui::TreeWidget::onReloadDoc(), Gui::View3DInventor::onRename(), Gui::TreeWidget::onSelectDependents(), Gui::TreeWidget::onSkipRecompute(), openCommand(), MeshPartGui::CurveOnMeshHandler::recomputeDocument(), redo(), save(), saveAs(), saveCopy(), Gui::DocumentItem::selectItems(), Gui::Application::setActiveDocument(), Gui::DocumentItem::setData(), Gui::View3DInventorViewer::setDocument(), setEdit(), Gui::DocumentItem::setShowHidden(), Gui::DocumentItem::showHidden(), slotChangePropertyEditor(), Gui::ElementColors::slotDeleteDocument(), Gui::DocumentItem::slotNewObject(), Gui::Application::sSetActiveDocument(), Gui::TreeWidget::startItemSearch(), undo(), Gui::DocumentObjectData::updateChildren(), and PartDesignGui::ViewProviderBody::updateOriginDatumSize().

◆ getEditingTransform()

const Base::Matrix4D & Document::getEditingTransform ( ) const

◆ getEditingViewOfViewProvider()

Gui::MDIView * Document::getEditingViewOfViewProvider ( Gui::ViewProvider * vp ) const

References Base::BaseClass::getClassTypeId(), getMDIViewsOfType(), and OfflineRenderingUtils::viewer().

Referenced by Gui::ViewProviderDocumentObject::getEditingView(), and Gui::ViewProviderDocumentObject::getInventorView().

◆ getInEdit()

ViewProvider * Document::getInEdit	(	ViewProviderDocumentObject **	parentVp = `nullptr`,
		std::string *	subname = `nullptr`,
		int *	mode = `nullptr`,
		std::string *	subElement = `nullptr`
	)		const

get the in edit ViewProvider or NULL

References getActiveView(), Gui::View3DInventor::getViewer(), and Gui::View3DInventorViewer::isEditingViewProvider().

◆ getMDIViews()

std::list< MDIView * > Document::getMDIViews ( ) const

returns a list of all attached MDI views

References Gui::DocumentP::baseViews.

Referenced by TechDrawGui::DrawGuiUtil::get3DDirAndRot(), getActiveView(), TechDrawGui::QGVPage::getDevicePixelRatio(), RestoreDocFile(), Save(), SaveDocFile(), setActiveWindow(), and setModified().

◆ getMDIViewsOfType()

std::list< MDIView * > Document::getMDIViewsOfType ( const Base::Type & typeId ) const

returns a list of all MDI views of a certain type

References Gui::DocumentP::baseViews.

Referenced by DrawingGui::TaskProjection::accept(), TechDrawGui::TaskProjection::accept(), StdCmdImport::activated(), createView(), getEditingViewOfViewProvider(), Gui::ViewProviderTextDocument::getMDIView(), getViewOfNode(), and sendMsgToFirstView().

◆ getMemSize()

unsigned int Document::getMemSize ( void ) const

virtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?

Implements Base::Persistence.

◆ getPyObject()

PyObject * Document::getPyObject ( void )

virtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Base::BaseClass.

Referenced by Gui::Application::sActiveDocument(), Gui::Application::sEditDocument(), Gui::Application::sGetDocument(), and Gui::Application::slotActiveDocument().

◆ getRedoVector()

std::vector< std::string > Document::getRedoVector ( void ) const

Get an Redo string vector with the Redo names.

Get a string vector with the 'Redo' actions.

References App::Document::getAvailableRedoNames(), and getDocument().

◆ getUndoVector()

std::vector< std::string > Document::getUndoVector ( void ) const

Get an Undo string vector with the Undo names.

Get a string vector with the 'Undo' actions.

References App::Document::getAvailableUndoNames(), and getDocument().

Referenced by TechDrawGui::TaskLeaderLine::removeFeature(), and TechDrawGui::TaskRichAnno::removeFeature().

◆ getViewOfNode()

Gui::MDIView * Document::getViewOfNode ( SoNode * node ) const

References Base::BaseClass::getClassTypeId(), and getMDIViewsOfType().

Referenced by Gui::Application::editViewOfNode(), Gui::ViewProviderDocumentObject::getViewOfNode(), and getViewOfViewProvider().

◆ getViewOfViewProvider()

Gui::MDIView * Document::getViewOfViewProvider ( const Gui::ViewProvider * vp ) const

References Gui::ViewProvider::getRoot(), and getViewOfNode().

Referenced by Gui::ViewProviderDocumentObject::getInventorView(), PartDesignGui::ViewProviderBody::updateOriginDatumSize(), and Gui::ViewProviderOriginGroupExtension::updateOriginSize().

◆ getViewProvider() [1/2]

ViewProvider * Document::getViewProvider ( const App::DocumentObject * Feat ) const

Get the view provider for that object.

Referenced by addRootObjectsToGroup(), Gui::AlignmentGroup::addView(), cloneView(), TechDrawGui::TaskHatch::createHatch(), createView(), Gui::ViewProviderDocumentObject::findFrontRootOfType(), ReverseEngineeringGui::SegmentationManual::Private::findGeometry(), PartGui::DlgExtrusion::findShapes(), Gui::ViewProviderDocumentObject::getElementPicked(), TechDrawGui::QGIView::getFrameState(), TechDrawGui::ViewProviderDrawingView::getMDIViewPage(), TechDrawGui::ViewProviderTemplate::getMDIViewPage(), TechDrawGui::ViewProviderDrawingView::getQView(), Gui::LinkInfo::getView(), TechDrawGui::QGIView::getViewProvider(), Gui::ViewProviderDocumentObjectGroup::getViewProviders(), Gui::MergeDocuments::importObject(), TechDrawGui::TaskLinkDim::loadToTree(), Gui::DAG::Model::Model(), TechDrawGui::ViewProviderDrawingView::onGuiRepaint(), FemGui::ActiveAnalysisObserver::setActiveObject(), TechDrawGui::ViewProviderPage::setTemplateMarkers(), PartDesignGui::ViewProviderBody::setVisualBodyMode(), slotActivatedObject(), slotChangedObject(), slotDeletedObject(), slotFinishRestoreDocument(), slotFinishRestoreObject(), slotNewObject(), slotRelabelObject(), slotTransactionAppend(), TechDrawGui::TaskCosVertex::TaskCosVertex(), TechDrawGui::TaskDetail::TaskDetail(), TechDrawGui::TaskLeaderLine::TaskLeaderLine(), TechDrawGui::TaskProjGroup::TaskProjGroup(), TechDrawGui::TaskRichAnno::TaskRichAnno(), RobotGui::TaskTrajectory::TaskTrajectory(), RobotGui::TrajectorySimulate::TrajectorySimulate(), PartDesignGui::ViewProviderBody::unifyVisualProperty(), MeshGui::ViewProviderMeshCurvature::updateData(), and TechDrawGui::ViewProviderGeomHatch::updateGraphic().

◆ getViewProvider() [2/2]

ViewProviderDocumentObject * Document::getViewProvider ( SoNode * node ) const

◆ getViewProviderByName()

ViewProvider * Document::getViewProviderByName ( const char * name ) const

References getDocument(), and App::Document::getObject().

Referenced by StdCmdToggleSelectability::activated(), importObjects(), isShow(), RestoreDocFile(), setHide(), setPos(), and setShow().

◆ getViewProviderByPathFromHead()

ViewProviderDocumentObject * Document::getViewProviderByPathFromHead ( SoPath * path ) const

helper for selection

◆ getViewProviderByPathFromTail()

ViewProviderDocumentObject * Document::getViewProviderByPathFromTail ( SoPath * path ) const

helper for selection

◆ getViewProvidersByPath()

std::vector< std::pair< ViewProviderDocumentObject *, int > > Document::getViewProvidersByPath ( SoPath * path ) const

Get all view providers along the path and the corresponding node index in the path.

◆ getViewProvidersOfType()

std::vector< ViewProvider * > Document::getViewProvidersOfType ( const Base::Type & typeId ) const

Referenced by Gui::SoFCUnifiedSelection::doAction(), and Gui::View3DInventorViewer::setOverrideMode().

◆ hasPendingCommand()

bool Document::hasPendingCommand ( void ) const

Check if an Undo transaction is open.

References getDocument(), and App::Document::hasPendingTransaction().

Referenced by PartGui::TaskDlgAttacher::open().

◆ importObjects()

void Document::importObjects	(	const std::vector< App::DocumentObject * > &	obj,
		Base::Reader &	reader,
		const std::map< std::string, std::string > &	nameMapping
	)

References Gui::ExpandItem, getViewProviderByName(), Base::Reader::initLocalReader(), Gui::isRestoring, Gui::ViewProvider::Restore(), Gui::ViewProvider::setStatus(), and signalExpandObject.

Referenced by Document(), and Gui::MergeDocuments::RestoreDocFile().

◆ isLastView()

bool Document::isLastView ( void )

References Gui::DocumentP::baseViews.

◆ isModified()

bool Document::isModified ( ) const

Referenced by canClose(), createView(), Gui::ViewProviderDocumentObject::onChanged(), slotChangedObject(), and slotTouchedObject().

◆ isPerformingTransaction()

bool Document::isPerformingTransaction ( ) const

Check if the document is performing undo/redo transaction.

Unlike App::Document::isPerformingTransaction(), Gui::Document will report transacting when triggering grouped undo/redo in other documents

◆ isShow()

bool Document::isShow ( const char * name )

test if the feature is in show

References getViewProviderByName(), and Gui::ViewProvider::isShow().

◆ onRelabel()

void Document::onRelabel ( void )

call relabel to all attached views

References Gui::DocumentP::baseViews, Gui::DocumentP::connectChangeDocumentBlocker, Base::Console(), Base::ConsoleSingleton::Log(), and Gui::DocumentP::passiveViews.

◆ onUpdate()

void Document::onUpdate ( void )

call update on all attached views

References Gui::DocumentP::baseViews, Base::Console(), Base::ConsoleSingleton::Log(), and Gui::DocumentP::passiveViews.

Referenced by Gui::Application::updateActive().

◆ openCommand()

void Document::openCommand ( const char * sName = nullptr )

Open a new Undo transaction on the document.

Open a new Undo transaction on the active document This method opens a new UNDO transaction on the active document.

This transaction will later appear in the UNDO/REDO dialog with the name of the command. If the user recall the transaction everything changed on the document between OpenCommand() and CommitCommand will be undone (or redone). You can use an alternative name for the operation default is the command name.

See also: CommitCommand(),AbortCommand()

References getDocument(), and App::Document::openTransaction().

Referenced by Gui::ManualAlignment::align(), MeshGui::ViewProviderMesh::clipMeshCallback(), PartGui::DlgPrimitives::createPrimitive(), ReverseEngineeringGui::SegmentationManual::createSegment(), PointsGui::ViewProviderScattered::cut(), PointsGui::ViewProviderStructured::cut(), MeshGui::ViewProviderMesh::fillHole(), MeshGui::ViewProviderMesh::markPartCallback(), SketcherGui::ViewProviderSketch::mouseButtonPressed(), MeshGui::DlgRegularSolidImp::on_createSolidButton_clicked(), PartGui::TaskDlgAttacher::open(), MeshGui::ViewProviderMesh::partMeshCallback(), MeshGui::ViewProviderMesh::segmMeshCallback(), and MeshGui::ViewProviderMesh::trimMeshCallback().

◆ redo()

void Document::redo ( int iSteps )

Will REDO one or more steps.

References App::GetApplication(), getDocument(), App::Document::redo(), and App::Application::signalRedo.

Referenced by Gui::View3DInventor::onMsg(), and SpreadsheetGui::SheetView::onMsg().

◆ removeAnnotationViewProvider()

void Document::removeAnnotationViewProvider ( const char * name )

remove an annotation view provider

References Gui::DocumentP::baseViews, Gui::View3DInventor::getViewer(), and Gui::View3DInventorViewer::removeViewProvider().

Referenced by Gui::View3DInventorPy::removeAnnotation(), and setAnnotationViewProvider().

◆ resetEdit()

void Document::resetEdit ( void )

reset from edit mode, this cause all document to reset edit

References Gui::Application::Instance, and Gui::Application::setEditDocument().

Referenced by Gui::TaskCSysDragger::accept(), StdCmdTransformManip::activated(), Gui::ViewProvider::eventCallback(), Gui::TaskView::TaskView::keyPressEvent(), FemGui::TaskFemConstraint::onButtonWizOk(), and PartGui::FaceColors::slotUndoDocument().

◆ Restore()

void Document::Restore ( Base::XMLReader & reader )

virtual

This method is used to restore properties from an XML document.

Loads a separate XML file from the projects file with information about the view providers.

Implements Base::Persistence.

References Base::XMLReader::addFile(), and Gui::isRestoring.

Referenced by Document().

◆ RestoreDocFile()

void Document::RestoreDocFile ( Base::Reader & reader )

virtual

This method is used to restore large amounts of data from a binary file.

Restores the properties of the view providers.

Reimplemented from Base::Persistence.

References Base::Console(), Base::ConsoleSingleton::Error(), Gui::ExpandItem, Base::Reader::getFileVersion(), getMDIViews(), getViewProviderByName(), Base::Reader::initLocalReader(), Gui::TreeWidget::instance(), Gui::ViewProvider::Restore(), saveCameraSettings(), setModified(), and signalExpandObject.

◆ Save()

void Document::Save ( Base::Writer & writer ) const

virtual

This method is used to save properties or very small amounts of data to an XML document.

Adds a separate XML file to the projects file that contains information about the view providers.

Implements Base::Persistence.

References Base::Writer::addFile(), App::GetApplication(), ParameterGrp::GetBool(), Base::BaseClass::getClassTypeId(), ParameterGrp::GetInt(), getMDIViews(), App::Application::GetParameterGroupByPath(), Gui::View3DInventor::getViewer(), Base::Writer::isForceXML(), Gui::Thumbnail::Save(), Gui::Thumbnail::setFileName(), Gui::Thumbnail::setSize(), Gui::Thumbnail::setViewer(), and Gui::DocumentP::thumb.

Referenced by Document().

◆ save()

◆ saveAll()

void Document::saveAll ( )

static

Save all open document.

References Gui::Command::Doc, App::GetApplication(), App::Document::getDependentDocuments(), Gui::Application::getDocument(), App::Application::getDocuments(), Gui::getMainWindow(), Gui::Application::Instance, App::Document::PartialDoc, and App::Document::TempDoc.

Referenced by StdCmdSaveAll::activated().

◆ saveAs()

bool Document::saveAs ( void )

Save the document under a new file name.

References Gui::MainWindow::appendRecentFile(), Gui::Command::Doc, Base::Tools::escapedUnicodeFromUtf8(), Base::Tools::escapeEncodeFilename(), App::GetApplication(), getDocument(), App::Application::getDocumentName(), Gui::getMainWindow(), Gui::FileDialog::getSaveFileName(), setModified(), and Gui::MainWindow::showMessage().

Referenced by StdCmdSaveAs::activated(), PathScripts.PathToolBitCmd.CommandToolBitSave::Activated(), PathScripts.PathToolBitCmd.CommandToolBitSave::GetResources(), PathScripts.PathToolBitCmd.CommandToolBitSave::IsActive(), Gui::View3DInventor::onMsg(), SpreadsheetGui::SheetView::onMsg(), and save().

◆ saveCameraSettings()

bool Document::saveCameraSettings ( const char * settings ) const

Referenced by createView(), RestoreDocFile(), and SaveDocFile().

◆ saveCopy()

bool Document::saveCopy ( void )

Save a copy of the document under a new file name.

References Gui::Command::Doc, Base::Tools::escapeEncodeFilename(), App::GetApplication(), getDocument(), App::Application::getDocumentName(), Gui::getMainWindow(), Gui::FileDialog::getSaveFileName(), and Gui::MainWindow::showMessage().

Referenced by StdCmdSaveCopy::activated(), and Gui::View3DInventor::onMsg().

◆ SaveDocFile()

void Document::SaveDocFile ( Base::Writer & writer ) const

virtual

This method is used to save large amounts of data to a binary file.

Saves the properties of the view providers.

Reimplemented from Base::Persistence.

References Base::Writer::decInd(), Base::Persistence::encodeAttribute(), App::Expand, getCameraSettings(), getMDIViews(), Base::Writer::incInd(), Base::Writer::ind(), Gui::TreeWidget::instance(), Base::Writer::isForceXML(), saveCameraSettings(), Base::Writer::setForceXML(), and Base::Writer::Stream().

◆ sendMsgToFirstView()

bool Document::sendMsgToFirstView	(	const Base::Type &	typeId,
		const char *	pMsg,
		const char **	ppReturn
	)

Sends the message pMsg to the views of type typeid and stops with the first view that supports the message and returns ppReturn.

The very first checked view is the current active view. If a view supports the message true is returned and false otherwise.

References getActiveView(), and getMDIViewsOfType().

◆ sendMsgToViews()

bool Document::sendMsgToViews ( const char * pMsg )

send messages to the active view Send a specific massage to the active view and is able to receive a return message

send messages to the active view

send Messages to all views

References Gui::DocumentP::baseViews, and Gui::DocumentP::passiveViews.

◆ setActiveView()

MDIView * Document::setActiveView	(	ViewProviderDocumentObject *	vp = `nullptr`,
		Base::Type	typeId = `Base::Type()`
	)

References Gui::DocumentP::baseViews, Gui::MDIView::containsViewProvider(), createView(), getActiveView(), Base::BaseClass::getClassTypeId(), Gui::getMainWindow(), Gui::ViewProvider::getMDIView(), Gui::ViewProviderDocumentObject::getObject(), Gui::Application::getViewProvider(), Gui::Application::Instance, Base::Type::isBad(), and Gui::MainWindow::setActiveWindow().

Referenced by SpreadsheetGui::ViewProviderSheet::beforeDelete(), Gui::TreeWidget::dropEvent(), Gui::TreeWidget::mouseDoubleClickEvent(), Gui::Application::reopen(), setEdit(), and Gui::TreeWidget::syncView().

◆ setActiveWindow()

void Document::setActiveWindow ( Gui::MDIView * view )

Document::setActiveWindow If this document is active and the view is part of it then it will be activated.

If the document is not active of the view is already active nothing is done.

Parameters

view

References Gui::MainWindow::activeWindow(), DraftVecUtils::find(), Gui::getMainWindow(), getMDIViews(), and Gui::MainWindow::setActiveWindow().

◆ setAnnotationViewProvider()

void Document::setAnnotationViewProvider	(	const char *	name,
		ViewProvider *	pcProvider
	)

set an annotation view provider

References Gui::View3DInventorViewer::addViewProvider(), Gui::DocumentP::baseViews, Gui::View3DInventor::getViewer(), and removeAnnotationViewProvider().

Referenced by Gui::MainWindow::customEvent(), and Gui::View3DInventorPy::setAnnotation().

◆ setEdit()

bool Document::setEdit	(	Gui::ViewProvider *	p,
		int	ModNum = `0`,
		const char *	subname = `nullptr`
	)

set the ViewProvider in special edit mode

References Gui::ControlSingleton::activeDialog(), Gui::Control(), Data::ComplexGeoData::findElementName(), getActiveView(), Base::Persistence::getClassTypeId(), Gui::SelectionSingleton::getCompleteSelection(), Gui::ViewProviderDocumentObject::getDocument(), getDocument(), App::DocumentObject::getFullName(), Gui::getMainWindow(), Gui::ViewProviderDocumentObject::getObject(), App::DocumentObject::getSubObject(), Gui::View3DInventor::getViewer(), Gui::Application::getViewProvider(), Gui::Application::Instance, Gui::NoResolve, Gui::Selection(), setActiveView(), Gui::MainWindow::setActiveWindow(), Gui::TaskView::TaskDialog::setDocumentName(), setEdit(), Gui::Application::setEditDocument(), Gui::View3DInventorViewer::setEditingViewProvider(), App::AutoTransaction::setEnable(), and signalInEdit.

Referenced by StdCmdTransformManip::activated(), Gui::ViewProviderLink::doubleClicked(), ArchGrid.ViewProviderArchGrid::doubleClicked(), ArchReference.ViewProviderArchReference::doubleClicked(), draftviewproviders.view_dimension.ViewProviderDimensionBase::doubleClicked(), draftviewproviders.view_hatch.ViewProviderDraftHatch::doubleClicked(), draftviewproviders.view_text.ViewProviderText::doubleClicked(), PathScripts.PathPropertyBagGui.ViewProvider::doubleClicked(), PathScripts.PathSetupSheetGui.ViewProvider::doubleClicked(), PathScripts.PathToolBitGui.ViewProvider::doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet::doubleClicked(), Gui::ViewProviderAnnotationLabel::doubleClicked(), Gui::ViewProviderMaterialObject::doubleClicked(), FemGui::ViewProviderFemPostFunction::doubleClicked(), FemGui::ViewProviderFemPostObject::doubleClicked(), RaytracingGui::ViewProviderLux::doubleClicked(), RaytracingGui::ViewProviderPovray::doubleClicked(), Gui::ViewProviderDragger::doubleClicked(), SketcherGui::ViewProviderSketch::doubleClicked(), ArchSchedule.CommandArchSchedule::IsActive(), setEdit(), PartDesignGui::ViewProviderShapeBinder::setupContextMenu(), PathScripts.PathIconViewProvider.ViewProvider::setupContextMenu(), PathScripts.PathJobGui.ViewProvider::setupContextMenu(), PathScripts.PathOpGui.ViewProvider::setupContextMenu(), PathScripts.PathToolControllerGui.ViewProvider::setupContextMenu(), and Gui::ViewProviderDocumentObject::startDefaultEditMode().

◆ setEditingTransform()

void Document::setEditingTransform ( const Base::Matrix4D & mat )

References getActiveView(), Gui::View3DInventor::getViewer(), and Gui::View3DInventorViewer::setEditingTransform().

◆ setHide()

void Document::setHide ( const char * name )

set the feature in Noshow

References Base::Persistence::getClassTypeId(), Base::Persistence::getTypeId(), getViewProviderByName(), and Base::Type::isDerivedFrom().

Referenced by Gui::Application::sHide().

◆ setInEdit()

void Document::setInEdit	(	ViewProviderDocumentObject *	parentVp,
		const char *	subname
	)

set the in edit ViewProvider subname reference

◆ setModified()

void Document::setModified ( bool b )

Observer message from the App doc.

References getMDIViews().

Referenced by Gui::Dialog::DocumentRecovery::accept(), Gui::Application::importFrom(), Gui::ViewProviderDocumentObject::onChanged(), RestoreDocFile(), save(), saveAs(), slotChangedObject(), slotChangePropertyEditor(), slotDeletedObject(), slotFinishRestoreDocument(), slotNewObject(), and slotTouchedObject().

◆ setPos()

void Document::setPos	(	const char *	name,
		const Base::Matrix4D &	rclMtrx
	)

set the feature transformation (only viewing)

set the feature in Noshow

References getViewProviderByName(), and Gui::ViewProvider::setTransformation().

◆ setShow()

void Document::setShow ( const char * name )

put the feature in show

References Base::Persistence::getClassTypeId(), Base::Persistence::getTypeId(), getViewProviderByName(), and Base::Type::isDerivedFrom().

Referenced by Gui::Application::sShow().

◆ slotActivatedObject()

void Document::slotActivatedObject ( const App::DocumentObject & Obj )

protected

References Base::Persistence::getClassTypeId(), getViewProvider(), Base::BaseClass::isDerivedFrom(), and signalActivatedObject.

Referenced by Document().

◆ slotChangedObject()

void Document::slotChangedObject	(	const App::DocumentObject &	Obj,
		const App::Property &	Prop
	)

protected

References Base::Persistence::getClassTypeId(), App::Property::getFullName(), App::DocumentObject::getFullName(), Gui::getMainWindow(), App::Property::getName(), getViewProvider(), Base::BaseClass::isDerivedFrom(), isModified(), App::Property::NoModify, setModified(), signalChangedObject, App::Property::testStatus(), Gui::ViewProvider::update(), and Gui::MainWindow::updateActions().

Referenced by Document().

◆ slotChangePropertyEditor()

void Document::slotChangePropertyEditor	(	const App::Document &	doc,
		const App::Property &	Prop
	)

protected

References getDocument(), App::Property::getFullName(), and setModified().

Referenced by Document().

◆ slotDeletedObject()

void Document::slotDeletedObject ( const App::DocumentObject & Obj )

protected

References Gui::DocumentP::baseViews, Gui::ViewProvider::beforeDelete(), Gui::Application::editDocument(), Base::Persistence::getClassTypeId(), Base::Persistence::getTypeId(), Gui::View3DInventor::getViewer(), getViewProvider(), Gui::Application::Instance, Base::Type::isDerivedFrom(), Gui::ViewProvider::onDelete(), Gui::View3DInventorViewer::removeViewProvider(), Gui::Application::setEditDocument(), setModified(), and signalDeletedObject.

Referenced by Document().

◆ slotFinishImportObjects()

void Document::slotFinishImportObjects ( const std::vector< App::DocumentObject * > & objs )

protected

Referenced by Document().

◆ slotFinishRestoreDocument()

void Document::slotFinishRestoreDocument ( const App::Document & doc )

protected

References Gui::DocumentP::connectActObjectBlocker, Base::Persistence::getClassTypeId(), getViewProvider(), Base::BaseClass::isDerivedFrom(), App::Document::LinkStampChanged, setModified(), and signalActivatedObject.

Referenced by Document().

◆ slotFinishRestoreObject()

void Document::slotFinishRestoreObject ( const App::DocumentObject & obj )

protected

References getViewProvider(), Gui::isRestoring, Gui::ViewProvider::setStatus(), and toggleInSceneGraph().

Referenced by Document().

◆ slotNewObject()

void Document::slotNewObject ( const App::DocumentObject & Obj )

protected

This slot is connected to the App::Document::signalNewObject(...)

References Gui::View3DInventorViewer::addViewProvider(), Gui::ViewProviderDocumentObject::allowOverride(), Gui::ViewProviderDocumentObject::attach(), Gui::DocumentP::baseViews, Base::Persistence::getClassTypeId(), App::DocumentObject::getFullName(), Gui::ViewProvider::getRoot(), Base::Type::getTypeIfDerivedFrom(), Gui::View3DInventor::getViewer(), getViewProvider(), App::DocumentObject::getViewProviderName(), App::DocumentObject::getViewProviderNameStored(), Gui::ViewProviderDocumentObject::pcDocument, Gui::ViewProviderDocumentObject::reattach(), Gui::ViewProviderDocumentObject::setActiveMode(), setModified(), Gui::ViewProvider::setStatus(), signalNewObject, and Gui::ViewProviderDocumentObject::updateView().

Referenced by Document().

◆ slotRecomputed()

void Document::slotRecomputed ( const App::Document & doc )

protected

References Gui::getMainWindow(), Gui::MainWindow::updateActions(), and Gui::TreeWidget::updateStatus().

Referenced by Document().

◆ slotRedoDocument()

void Document::slotRedoDocument ( const App::Document & doc )

protected

References Gui::getMainWindow(), signalRedoDocument, and Gui::MainWindow::updateActions().

Referenced by Document().

◆ slotRelabelObject()

void Document::slotRelabelObject ( const App::DocumentObject & Obj )

protected

References Base::Persistence::getClassTypeId(), getViewProvider(), Base::BaseClass::isDerivedFrom(), and signalRelabelObject.

Referenced by Document().

◆ slotShowHidden()

void Document::slotShowHidden ( const App::Document & doc )

protected

References Gui::Application::Instance, and Gui::Application::signalShowHidden.

Referenced by Document().

◆ slotSkipRecompute()

void Document::slotSkipRecompute	(	const App::Document &	doc,
		const std::vector< App::DocumentObject * > &	objs
	)

protected

References App::Document::AllowPartialRecompute, Gui::Application::editDocument(), App::Application::getActiveDocument(), App::GetApplication(), Gui::ViewProviderDocumentObject::getObject(), and Gui::Application::Instance.

Referenced by Document().

◆ slotStartRestoreDocument()

void Document::slotStartRestoreDocument ( const App::Document & doc )

protected

References Gui::DocumentP::connectActObjectBlocker.

Referenced by Document().

◆ slotTouchedObject()

void Document::slotTouchedObject ( const App::DocumentObject & Obj )

protected

References App::DocumentObject::getFullName(), Gui::getMainWindow(), isModified(), setModified(), and Gui::MainWindow::updateActions().

Referenced by Document().

◆ slotTransactionAppend()

void Document::slotTransactionAppend	(	const App::DocumentObject &	obj,
		App::Transaction *	transaction
	)

protected

References App::Transaction::addObjectDel(), Base::Persistence::getClassTypeId(), getViewProvider(), and Base::BaseClass::isDerivedFrom().

Referenced by Document().

◆ slotTransactionRemove()

void Document::slotTransactionRemove	(	const App::DocumentObject &	obj,
		App::Transaction *	transaction
	)

protected

References App::Transaction::addObjectNew(), and Gui::ViewProvider::getRoot().

Referenced by Document().

◆ slotUndoDocument()

void Document::slotUndoDocument ( const App::Document & doc )

protected

References Gui::getMainWindow(), signalUndoDocument, and Gui::MainWindow::updateActions().

Referenced by Document().

◆ toggleInSceneGraph()

void Document::toggleInSceneGraph ( ViewProvider * vp )

Add or remove view provider from scene graphs of all views.

It calls ViewProvider::canAddToSceneGraph() to decide whether to add the view provider or remove it

References Gui::DocumentP::baseViews, Gui::ViewProvider::canAddToSceneGraph(), Gui::ViewProvider::getRoot(), and Gui::View3DInventor::getViewer().

Referenced by Gui::ViewProviderPythonFeatureT< ViewProviderT >::onChanged(), and slotFinishRestoreObject().

◆ undo()

void Document::undo ( int iSteps )

Will UNDO one or more steps.

References App::GetApplication(), getDocument(), App::Application::signalUndo, and App::Document::undo().

Referenced by Gui::View3DInventor::onMsg(), SpreadsheetGui::SheetView::onMsg(), TechDrawGui::TaskLeaderLine::removeFeature(), and TechDrawGui::TaskRichAnno::removeFeature().

Friends And Related Function Documentation

◆ TransactionViewProvider

friend class TransactionViewProvider

friend

Member Data Documentation

◆ signalActivatedObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalActivatedObject

mutable

signal on activated Object

Referenced by slotActivatedObject(), slotFinishRestoreDocument(), and Gui::Application::slotNewDocument().

◆ signalChangedObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&, const App::Property&)> Gui::Document::signalChangedObject

mutable

signal on changed Object, the 2nd argument is the changed property of the referenced document object, not of the view provider

Referenced by PartDesignGui::ViewProviderBody::attach(), Gui::ViewProviderOriginGroupExtension::extensionAttach(), Gui::ViewProviderLink::finishRestoring(), Gui::DAG::Model::Model(), slotChangedObject(), and Gui::Application::slotNewDocument().

◆ signalDeletedObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalDeletedObject

mutable

signal on deleted Object

Referenced by Gui::DAG::Model::Model(), slotDeletedObject(), Gui::Application::slotNewDocument(), Gui::ManualAlignment::startAlignment(), and PartGui::TaskAttacher::TaskAttacher().

◆ signalDeleteDocument

boost::signals2::signal<void (const Gui::Document& doc)> Gui::Document::signalDeleteDocument

mutable

signal on deleting Document

Referenced by PartGui::TaskAttacher::TaskAttacher().

◆ signalExpandObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&, const Gui::TreeItemMode&, App::DocumentObject *parent, const char *subname)> Gui::Document::signalExpandObject

mutable

signal on changed Object, the 2nd argument is the highlite mode to use

Referenced by importObjects(), and RestoreDocFile().

◆ signalHighlightObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&, const Gui::HighlightMode&, bool, App::DocumentObject *parent, const char *subname)> Gui::Document::signalHighlightObject

mutable

signal on changed Object, the 2nd argument is the highlite mode to use

Referenced by FemGui::ActiveAnalysisObserver::highlightActiveObject().

◆ signalInEdit

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalInEdit

mutable

signal on entering in edit mode

Referenced by Gui::DAG::Model::Model(), setEdit(), and Gui::Application::slotNewDocument().

◆ signalNewObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalNewObject

mutable

signal on new Object

Referenced by Gui::DAG::Model::Model(), Gui::Application::slotNewDocument(), and slotNewObject().

◆ signalRedoDocument

boost::signals2::signal<void (const Gui::Document& doc)> Gui::Document::signalRedoDocument

mutable

signal on redo Document

Referenced by SketcherGui::ViewProviderSketch::setEdit(), and slotRedoDocument().

◆ signalRelabelObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalRelabelObject

mutable

signal on renamed Object

Referenced by Gui::Application::slotNewDocument(), and slotRelabelObject().

◆ signalResetEdit

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalResetEdit

mutable

signal on leaving edit mode

Referenced by Gui::DAG::Model::Model(), and Gui::Application::slotNewDocument().

◆ signalScrollToObject

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalScrollToObject

mutable

signal on scrolling to an object

◆ signalShowItem

boost::signals2::signal<void (const Gui::ViewProviderDocumentObject&)> Gui::Document::signalShowItem

mutable

signal on changed ShowInTree property in view provider

◆ signalUndoDocument

boost::signals2::signal<void (const Gui::Document& doc)> Gui::Document::signalUndoDocument

mutable

signal on undo Document

Referenced by PartGui::FaceColors::FaceColors(), SketcherGui::ViewProviderSketch::setEdit(), and slotUndoDocument().

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

FreeCAD/src/Gui/Document.h
FreeCAD/src/Gui/Document.cpp

Public Member Functions

Public Attributes

methods for the UNDO REDO handling

attributes for the UNDO REDO facility

I/O of the document

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Document()

◆ ~Document()

Member Function Documentation

◆ abortCommand()

◆ addRootObjectsToGroup()

◆ addViewProvider()

◆ attachView()

◆ beforeDelete()

◆ canClose()

◆ cloneView()

◆ commitCommand()

◆ createView()

◆ detachView()

◆ exportObjects()

◆ getActiveView()

◆ getAnnotationViewProvider()

◆ getCameraSettings()

◆ getDocument()

◆ getEditingTransform()

◆ getEditingViewOfViewProvider()

◆ getInEdit()

◆ getMDIViews()

◆ getMDIViewsOfType()

◆ getMemSize()

◆ getPyObject()

◆ getRedoVector()

◆ getUndoVector()

◆ getViewOfNode()

◆ getViewOfViewProvider()

◆ getViewProvider() [1/2]

◆ getViewProvider() [2/2]

◆ getViewProviderByName()

◆ getViewProviderByPathFromHead()

◆ getViewProviderByPathFromTail()

◆ getViewProvidersByPath()

◆ getViewProvidersOfType()

◆ hasPendingCommand()

◆ importObjects()

◆ isLastView()

◆ isModified()

◆ isPerformingTransaction()

◆ isShow()

◆ onRelabel()

◆ onUpdate()

◆ openCommand()

◆ redo()

◆ removeAnnotationViewProvider()

◆ resetEdit()

◆ Restore()

◆ RestoreDocFile()

◆ Save()

◆ save()

◆ saveAll()

◆ saveAs()

◆ saveCameraSettings()

◆ saveCopy()

◆ SaveDocFile()

◆ sendMsgToFirstView()

◆ sendMsgToViews()

◆ setActiveView()

◆ setActiveWindow()

◆ setAnnotationViewProvider()

◆ setEdit()

◆ setEditingTransform()

◆ setHide()

◆ setInEdit()

◆ setModified()

◆ setPos()

◆ setShow()

◆ slotActivatedObject()

◆ slotChangedObject()

◆ slotChangePropertyEditor()