CSMDoc::Document Class Reference

#include <document.hpp>

List of all members.

Public Slots
void	progress (int current, int max, int type)
Signals
void	stateChanged (int state, CSMDoc::Document *document)
void	progress (int current, int max, int type, int threads, CSMDoc::Document *document)
Public Member Functions
	Document (const Files::ConfigurationManager &configuration, const std::vector< boost::filesystem::path > &files, const boost::filesystem::path &savePath, const boost::filesystem::path &resDir, bool new_)
	~Document ()
QUndoStack &	getUndoStack ()
int	getState () const
const boost::filesystem::path &	getSavePath () const
const std::vector < boost::filesystem::path > &	getContentFiles () const
void	save ()
CSMWorld::UniversalId	verify ()
void	abortOperation (int type)
const CSMWorld::Data &	getData () const
CSMWorld::Data &	getData ()
CSMTools::ReportModel *	getReport (const CSMWorld::UniversalId &id)
	The ownership of the returned report is not transferred.
Private Slots
void	modificationStateChanged (bool clean)
void	reportMessage (const QString &message, int type)
void	operationDone (int type)
Private Member Functions
	Document (const Document &)
Document &	operator= (const Document &)
void	load (const std::vector< boost::filesystem::path >::const_iterator &begin, const std::vector< boost::filesystem::path >::const_iterator &end, bool lastAsModified)
void	createBase ()
void	addGmsts ()
void	addOptionalGmsts ()
void	addOptionalGlobals ()
void	addOptionalGmst (const ESM::GameSetting &gmst)
void	addOptionalGlobal (const ESM::Global &global)
Private Attributes
boost::filesystem::path	mSavePath
std::vector < boost::filesystem::path >	mContentFiles
CSMWorld::Data	mData
CSMTools::Tools	mTools
boost::filesystem::path	mProjectPath
Saving	mSaving
boost::filesystem::path	mResDir
QUndoStack	mUndoStack

---

Constructor & Destructor Documentation

CSMDoc::Document::Document

(

const Document &

)

[private]

CSMDoc::Document::Document	(	const Files::ConfigurationManager &	configuration,
		const std::vector< boost::filesystem::path > &	files,
		const boost::filesystem::path &	savePath,
		const boost::filesystem::path &	resDir,
		bool	new_
	)

CSMDoc::Document::~Document

(

)

---

Member Function Documentation

void CSMDoc::Document::abortOperation

(

int

type

)

void CSMDoc::Document::addGmsts

(

)

[private]

void CSMDoc::Document::addOptionalGlobal

(

const ESM::Global &

global

)

[private]

void CSMDoc::Document::addOptionalGlobals

(

)

[private]

void CSMDoc::Document::addOptionalGmst

(

const ESM::GameSetting &

gmst

)

[private]

void CSMDoc::Document::addOptionalGmsts

(

)

[private]

void CSMDoc::Document::createBase

(

)

[private]

const std::vector< boost::filesystem::path > & CSMDoc::Document::getContentFiles

(

)

const

Attention:

The last element in this collection is the file that is being edited, but with its original path instead of the save path.

const CSMWorld::Data & CSMDoc::Document::getData

(

)

const

CSMWorld::Data & CSMDoc::Document::getData

(

)

CSMTools::ReportModel * CSMDoc::Document::getReport

(

const CSMWorld::UniversalId &

id

)

The ownership of the returned report is not transferred.

const boost::filesystem::path & CSMDoc::Document::getSavePath

(

)

const

int CSMDoc::Document::getState

(

)

const

QUndoStack & CSMDoc::Document::getUndoStack

(

)

void CSMDoc::Document::load	(	const std::vector< boost::filesystem::path >::const_iterator &	begin,
		const std::vector< boost::filesystem::path >::const_iterator &	end,
		bool	lastAsModified
	)		[private]

Parameters:

lastAsModified

Store the last file in Modified instead of merging it into Base.

void CSMDoc::Document::modificationStateChanged

(

bool

clean

)

[private, slot]

void CSMDoc::Document::operationDone

(

int

type

)

[private, slot]

Document& CSMDoc::Document::operator=

(

const Document &

)

[private]

void CSMDoc::Document::progress	(	int	current,
		int	max,
		int	type,
		int	threads,
		CSMDoc::Document *	document
	)		[signal]

void CSMDoc::Document::progress	(	int	current,
		int	max,
		int	type
	)		[slot]

void CSMDoc::Document::reportMessage	(	const QString &	message,
		int	type
	)		[private, slot]

Todo:

find a better way to get these messages to the user.

void CSMDoc::Document::save

(

)

void CSMDoc::Document::stateChanged	(	int	state,
		CSMDoc::Document *	document
	)		[signal]

CSMWorld::UniversalId CSMDoc::Document::verify

(

)

---

Member Data Documentation

std::vector<boost::filesystem::path> CSMDoc::Document::mContentFiles [private]

CSMWorld::Data CSMDoc::Document::mData [private]

boost::filesystem::path CSMDoc::Document::mProjectPath [private]

boost::filesystem::path CSMDoc::Document::mResDir [private]

boost::filesystem::path CSMDoc::Document::mSavePath [private]

Saving CSMDoc::Document::mSaving [private]

CSMTools::Tools CSMDoc::Document::mTools [private]

QUndoStack CSMDoc::Document::mUndoStack [private]

---

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

• apps/opencs/model/doc/document.hpp
• apps/opencs/model/doc/document.cpp