CSMDoc::DocumentManager Class Reference

#include <documentmanager.hpp>

Inheritance diagram for CSMDoc::DocumentManager:

Collaboration diagram for CSMDoc::DocumentManager:

Public Slots
void	removeDocument (CSMDoc::Document *document)
	Emits the lastDocumentDeleted signal, if applicable. More...
void	insertDocument (CSMDoc::Document *document)

Signals
void	documentAdded (CSMDoc::Document *document)
void	documentAboutToBeRemoved (CSMDoc::Document *document)
void	loadRequest (CSMDoc::Document *document)
void	lastDocumentDeleted ()
void	loadingStopped (CSMDoc::Document *document, bool completed, const std::string &error)
void	nextStage (CSMDoc::Document *document, const std::string &name, int totalRecords)
void	nextRecord (CSMDoc::Document *document, int records)
void	cancelLoading (CSMDoc::Document *document)
void	loadMessage (CSMDoc::Document *document, const std::string &message)

Public Member Functions
	DocumentManager (const Files::ConfigurationManager &configuration)
	~DocumentManager ()
void	addDocument (const std::vector< boost::filesystem::path > &files, const boost::filesystem::path &savePath, bool new_)
Document *	makeDocument (const std::vector< boost::filesystem::path > &files, const boost::filesystem::path &savePath, bool new_)
void	setResourceDir (const boost::filesystem::path &parResDir)
void	setFallbackMap (const std::map< std::string, std::string > &fallbackMap)
void	setEncoding (ToUTF8::FromType encoding)
void	setBlacklistedScripts (const std::vector< std::string > &scriptIds)
void	setFileData (bool strict, const Files::PathContainer &dataPaths, const std::vector< std::string > &archives)
	Sets the file data that gets passed to newly created documents. More...
bool	isEmpty ()

Private Slots
void	documentLoaded (Document *document)
	The ownership of document is not transferred. More...
void	documentNotLoaded (Document *document, const std::string &error)

Private Member Functions
	DocumentManager (const DocumentManager &)
DocumentManager &	operator= (const DocumentManager &)

Private Attributes
std::vector< Document * >	mDocuments
const Files::ConfigurationManager &	mConfiguration
QThread	mLoaderThread
Loader	mLoader
ToUTF8::FromType	mEncoding
std::vector< std::string >	mBlacklistedScripts
boost::filesystem::path	mResDir
Fallback::Map	mFallbackMap
bool	mFsStrict
Files::PathContainer	mDataPaths
std::vector< std::string >	mArchives

Constructor & Destructor Documentation

CSMDoc::DocumentManager::DocumentManager ( const DocumentManager &  )

private

CSMDoc::DocumentManager::DocumentManager

(

const Files::ConfigurationManager &

configuration

)

Here is the call graph for this function:

CSMDoc::DocumentManager::~DocumentManager

(

)

Member Function Documentation

void CSMDoc::DocumentManager::addDocument	(	const std::vector< boost::filesystem::path > &	files,
		const boost::filesystem::path &	savePath,
		bool	new_
	)

Parameters

new_	Do not load the last content file in files and instead create in an appropriate way.

void CSMDoc::DocumentManager::cancelLoading ( CSMDoc::Document *  document )

signal

Here is the caller graph for this function:

void CSMDoc::DocumentManager::documentAboutToBeRemoved ( CSMDoc::Document *  document )

signal

void CSMDoc::DocumentManager::documentAdded ( CSMDoc::Document *  document )

signal

void CSMDoc::DocumentManager::documentLoaded ( Document *  document )

privateslot

The ownership of document is not transferred.

Here is the caller graph for this function:

void CSMDoc::DocumentManager::documentNotLoaded ( Document *  document, const std::string &  error  )

privateslot

Document load has been interrupted either because of a call to abortLoading or a problem during loading). In the former case error will be an empty string.

Here is the caller graph for this function:

void CSMDoc::DocumentManager::insertDocument ( CSMDoc::Document *  document )

slot

Hand over document to *this. The ownership is transferred. The DocumentManager will initiate the load procedure, if necessary

bool CSMDoc::DocumentManager::isEmpty

(

)

void CSMDoc::DocumentManager::lastDocumentDeleted ( )

signal

void CSMDoc::DocumentManager::loadingStopped ( CSMDoc::Document *  document, bool  completed, const std::string &  error  )

signal

void CSMDoc::DocumentManager::loadMessage ( CSMDoc::Document *  document, const std::string &  message  )

signal

Here is the caller graph for this function:

void CSMDoc::DocumentManager::loadRequest ( CSMDoc::Document *  document )

signal

Here is the caller graph for this function:

CSMDoc::Document * CSMDoc::DocumentManager::makeDocument	(	const std::vector< boost::filesystem::path > &	files,
		const boost::filesystem::path &	savePath,
		bool	new_
	)

Create a new document. The ownership of the created document is transferred to the calling function. The DocumentManager does not manage it. Loading has not taken place at the point when the document is returned.

Parameters

new_	Do not load the last content file in files and instead create in an appropriate way.

void CSMDoc::DocumentManager::nextRecord ( CSMDoc::Document *  document, int  records  )

signal

Here is the caller graph for this function:

void CSMDoc::DocumentManager::nextStage ( CSMDoc::Document *  document, const std::string &  name, int  totalRecords  )

signal

Here is the caller graph for this function:

DocumentManager& CSMDoc::DocumentManager::operator= ( const DocumentManager &  )

private

void CSMDoc::DocumentManager::removeDocument ( CSMDoc::Document *  document )

slot

Emits the lastDocumentDeleted signal, if applicable.

void CSMDoc::DocumentManager::setBlacklistedScripts

(

const std::vector< std::string > &

scriptIds

)

void CSMDoc::DocumentManager::setEncoding

(

ToUTF8::FromType

encoding

)

void CSMDoc::DocumentManager::setFallbackMap

(

const std::map< std::string, std::string > &

fallbackMap

)

void CSMDoc::DocumentManager::setFileData	(	bool	strict,
		const Files::PathContainer &	dataPaths,
		const std::vector< std::string > &	archives
	)

Sets the file data that gets passed to newly created documents.

Here is the caller graph for this function:

void CSMDoc::DocumentManager::setResourceDir

(

const boost::filesystem::path &

parResDir

)

Member Data Documentation

std::vector<std::string> CSMDoc::DocumentManager::mArchives

private

std::vector<std::string> CSMDoc::DocumentManager::mBlacklistedScripts

private

const Files::ConfigurationManager& CSMDoc::DocumentManager::mConfiguration

private

Files::PathContainer CSMDoc::DocumentManager::mDataPaths

private

std::vector<Document *> CSMDoc::DocumentManager::mDocuments

private

ToUTF8::FromType CSMDoc::DocumentManager::mEncoding

private

Fallback::Map CSMDoc::DocumentManager::mFallbackMap

private

bool CSMDoc::DocumentManager::mFsStrict

private

Loader CSMDoc::DocumentManager::mLoader

private

QThread CSMDoc::DocumentManager::mLoaderThread

private

boost::filesystem::path CSMDoc::DocumentManager::mResDir

private

---

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

• /home/travis/build/elsid/openmw/apps/opencs/model/doc/documentmanager.hpp
• /home/travis/build/elsid/openmw/apps/opencs/model/doc/documentmanager.cpp