FreeCAD: App::DocInfo Class Reference

Public Types
typedef boost::signals2::scoped_connection Connection

Public Member Functions
void attach (Document *doc)

void deinit ()

DocInfo ()

const char * filePath () const

QString getFullPath () const

bool hasXLink (const App::Document *doc) const

void init (DocInfoMap::iterator pos, const char objName, PropertyXLink l)

void remove (PropertyXLink *l)

void slotDeleteDocument (const App::Document &doc)

void slotFinishRestoreDocument (const App::Document &doc)

void slotSaveDocument (const App::Document &doc)

~DocInfo ()

Static Public Member Functions
static void breakLinks (App::DocumentObject *obj, bool clear)

static DocInfoPtr get (const char filename, App::Document pDoc, PropertyXLink l, const char objName)

static std::string getDocPath (const char filename, App::Document pDoc, bool relative, QString *fullPath=0)

static QString getFullPath (const char *p)

static void restoreDocument (const App::Document &doc)

Public Attributes
Connection connDeletedObject

Connection connDeleteDocument

Connection connFinishRestoreDocument

Connection connSaveDocument

std::set< PropertyXLink * > links

std::string myPath

DocInfoMap::iterator myPos

App::Document * pcDoc

Member Typedef Documentation

◆ Connection

typedef boost::signals2::scoped_connection App::DocInfo::Connection

Constructor & Destructor Documentation

◆ DocInfo()

App::DocInfo::DocInfo ( )

◆ ~DocInfo()

App::DocInfo::~DocInfo ( )

Member Function Documentation

◆ attach()

void App::DocInfo::attach ( Document * doc )

References App::PropertyLinkBase::LinkRestoring, links, and pcDoc.

Referenced by init(), and slotFinishRestoreDocument().

◆ breakLinks()

static void App::DocInfo::breakLinks	(	App::DocumentObject *	obj,
		bool	clear
	)

static

References links.

Referenced by App::PropertyLinkBase::breakLinks().

◆ deinit()

void App::DocInfo::deinit ( )

References connDeletedObject, connDeleteDocument, connFinishRestoreDocument, connSaveDocument, filePath(), App::Document::getName(), links, myPath, myPos, and pcDoc.

Referenced by remove(), and slotDeleteDocument().

◆ filePath()

const char* App::DocInfo::filePath ( ) const

References myPath.

Referenced by deinit(), and init().

◆ get()

static DocInfoPtr App::DocInfo::get	(	const char *	filename,
		App::Document *	pDoc,
		PropertyXLink *	l,
		const char *	objName
	)

static

References App::Application::addPendingDocument(), App::GetApplication(), getDocPath(), getFullPath(), and App::PropertyLinkBase::LinkAllowPartial.

Referenced by draftguitools.gui_trackers.editTracker::move(), App::PropertyXLink::setValue(), and slotSaveDocument().

◆ getDocPath()

static std::string App::DocInfo::getDocPath	(	const char *	filename,
		App::Document *	pDoc,
		bool	relative,
		QString *	fullPath = `0`
	)

static

References App::Document::FileName, and App::PropertyString::getValue().

Referenced by get(), and App::PropertyXLink::Save().

◆ getFullPath() [1/2]

QString App::DocInfo::getFullPath ( ) const

References myPos.

Referenced by get(), init(), restoreDocument(), slotFinishRestoreDocument(), and slotSaveDocument().

◆ getFullPath() [2/2]

static QString App::DocInfo::getFullPath ( const char * p )

static

◆ hasXLink()

bool App::DocInfo::hasXLink ( const App::Document * doc ) const

References links.

◆ init()

void App::DocInfo::init	(	DocInfoMap::iterator	pos,
		const char *	objName,
		PropertyXLink *	l
	)

References App::Application::addPendingDocument(), attach(), connDeleteDocument, connFinishRestoreDocument, connSaveDocument, filePath(), App::GetApplication(), getFullPath(), App::PropertyLinkBase::LinkAllowPartial, myPath, myPos, App::Application::signalDeleteDocument, App::Application::signalFinishRestoreDocument, App::Application::signalSaveDocument, slotDeleteDocument(), slotFinishRestoreDocument(), and slotSaveDocument().

Referenced by DocumentObject.DocumentObject::onChanged().

◆ remove()

void App::DocInfo::remove ( PropertyXLink * l )

References deinit(), and links.

◆ restoreDocument()

static void App::DocInfo::restoreDocument ( const App::Document & doc )

static

References getFullPath().

Referenced by App::PropertyXLink::restoreDocument().

◆ slotDeleteDocument()

void App::DocInfo::slotDeleteDocument ( const App::Document & doc )

References deinit(), App::PropertyLinkBase::LinkDetached, links, and pcDoc.

Referenced by init(), and slotSaveDocument().

◆ slotFinishRestoreDocument()

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

References attach(), getFullPath(), and pcDoc.

Referenced by init(), and slotSaveDocument().

◆ slotSaveDocument()

void App::DocInfo::slotSaveDocument ( const App::Document & doc )

References get(), getFullPath(), links, myPos, pcDoc, slotDeleteDocument(), slotFinishRestoreDocument(), and App::DocumentObject::touch().

Referenced by init().

Member Data Documentation

◆ connDeletedObject

Connection App::DocInfo::connDeletedObject

Referenced by deinit().

◆ connDeleteDocument

Connection App::DocInfo::connDeleteDocument

Referenced by deinit(), and init().

◆ connFinishRestoreDocument

Connection App::DocInfo::connFinishRestoreDocument

Referenced by deinit(), and init().

◆ connSaveDocument

Connection App::DocInfo::connSaveDocument

Referenced by deinit(), and init().

◆ links

std::set<PropertyXLink*> App::DocInfo::links

Referenced by attach(), breakLinks(), deinit(), hasXLink(), remove(), slotDeleteDocument(), and slotSaveDocument().

◆ myPath

std::string App::DocInfo::myPath

Referenced by deinit(), filePath(), and init().

◆ myPos

DocInfoMap::iterator App::DocInfo::myPos

Referenced by deinit(), getFullPath(), init(), and slotSaveDocument().

◆ pcDoc

App::Document* App::DocInfo::pcDoc

Referenced by attach(), deinit(), slotDeleteDocument(), slotFinishRestoreDocument(), and slotSaveDocument().

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

src/App/PropertyLinks.cpp