OpenMW
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Signals | Public Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
CSMDoc::Document Class Reference

#include <document.hpp>

Inheritance diagram for CSMDoc::Document:
Collaboration diagram for CSMDoc::Document:

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)
 
void mergeDone (CSMDoc::Document *document)
 

Public Member Functions

 Document (const VFS::Manager *vfs, const Files::ConfigurationManager &configuration, const std::vector< boost::filesystem::path > &files, bool new_, const boost::filesystem::path &savePath, const boost::filesystem::path &resDir, const Fallback::Map *fallback, ToUTF8::FromType encoding, const CSMWorld::ResourcesManager &resourcesManager, const std::vector< std::string > &blacklistedScripts)
 
 ~Document ()
 
const VFS::ManagergetVFS () const
 
QUndoStack & getUndoStack ()
 
int getState () const
 
const boost::filesystem::path & getSavePath () const
 
const boost::filesystem::path & getProjectPath () const
 
const std::vector
< boost::filesystem::path > & 
getContentFiles () const
 
bool isNew () const
 Is this a newly created content file? More...
 
void save ()
 
CSMWorld::UniversalId verify (const CSMWorld::UniversalId &reportId=CSMWorld::UniversalId())
 
CSMWorld::UniversalId newSearch ()
 
void runSearch (const CSMWorld::UniversalId &searchId, const CSMTools::Search &search)
 
void runMerge (std::auto_ptr< CSMDoc::Document > target)
 
void abortOperation (int type)
 
const CSMWorld::DatagetData () const
 
CSMWorld::DatagetData ()
 
CSMTools::ReportModelgetReport (const CSMWorld::UniversalId &id)
 The ownership of the returned report is not transferred. More...
 
bool isBlacklisted (const CSMWorld::UniversalId &id) const
 
void startRunning (const std::string &profile, const std::string &startupInstruction="")
 
void stopRunning ()
 
QTextDocument * getRunLog ()
 
CSMWorld::IdCompletionManagergetIdCompletionManager ()
 
void flagAsDirty ()
 

Private Slots

void modificationStateChanged (bool clean)
 
void reportMessage (const CSMDoc::Message &message, int type)
 
void operationDone (int type, bool failed)
 
void runStateChanged ()
 

Private Member Functions

 Document (const Document &)
 
Documentoperator= (const Document &)
 
void createBase ()
 
void addGmsts ()
 
void addOptionalGmsts ()
 
void addOptionalGlobals ()
 
void addOptionalMagicEffects ()
 
void addOptionalGmst (const ESM::GameSetting &gmst)
 
void addOptionalGlobal (const ESM::Global &global)
 
void addOptionalMagicEffect (const ESM::MagicEffect &effect)
 

Private Attributes

const VFS::ManagermVFS
 
boost::filesystem::path mSavePath
 
std::vector
< boost::filesystem::path > 
mContentFiles
 
bool mNew
 
CSMWorld::Data mData
 
CSMTools::Tools mTools
 
boost::filesystem::path mProjectPath
 
Saving mSavingOperation
 
OperationHolder mSaving
 
boost::filesystem::path mResDir
 
const Fallback::MapmFallbackMap
 
Blacklist mBlacklist
 
Runner mRunner
 
bool mDirty
 
CSMWorld::IdCompletionManager mIdCompletionManager
 
QUndoStack mUndoStack
 

Constructor & Destructor Documentation

CSMDoc::Document::Document ( const Document )
private
CSMDoc::Document::Document ( const VFS::Manager vfs,
const Files::ConfigurationManager configuration,
const std::vector< boost::filesystem::path > &  files,
bool  new_,
const boost::filesystem::path &  savePath,
const boost::filesystem::path &  resDir,
const Fallback::Map fallback,
ToUTF8::FromType  encoding,
const CSMWorld::ResourcesManager resourcesManager,
const std::vector< std::string > &  blacklistedScripts 
)

Here is the call graph for this function:

CSMDoc::Document::~Document ( )

Member Function Documentation

void CSMDoc::Document::abortOperation ( int  type)
void CSMDoc::Document::addGmsts ( )
private

Here is the call graph for this function:

void CSMDoc::Document::addOptionalGlobal ( const ESM::Global global)
private

Here is the call graph for this function:

void CSMDoc::Document::addOptionalGlobals ( )
private

Here is the call graph for this function:

Here is the caller graph for this function:

void CSMDoc::Document::addOptionalGmst ( const ESM::GameSetting gmst)
private

Here is the call graph for this function:

void CSMDoc::Document::addOptionalGmsts ( )
private

Here is the call graph for this function:

Here is the caller graph for this function:

void CSMDoc::Document::addOptionalMagicEffect ( const ESM::MagicEffect effect)
private

Here is the call graph for this function:

void CSMDoc::Document::addOptionalMagicEffects ( )
private

Here is the call graph for this function:

Here is the caller graph for this function:

void CSMDoc::Document::createBase ( )
private

Here is the call graph for this function:

Here is the caller graph for this function:

void CSMDoc::Document::flagAsDirty ( )

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

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

Here is the caller graph for this function:

CSMWorld::Data & CSMDoc::Document::getData ( )
CSMWorld::IdCompletionManager & CSMDoc::Document::getIdCompletionManager ( )

Here is the caller graph for this function:

const boost::filesystem::path & CSMDoc::Document::getProjectPath ( ) const

Here is the caller graph for this function:

CSMTools::ReportModel * CSMDoc::Document::getReport ( const CSMWorld::UniversalId id)

The ownership of the returned report is not transferred.

Here is the caller graph for this function:

QTextDocument * CSMDoc::Document::getRunLog ( )

Here is the caller graph for this function:

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

Here is the caller graph for this function:

int CSMDoc::Document::getState ( ) const

Here is the caller graph for this function:

QUndoStack & CSMDoc::Document::getUndoStack ( )

Here is the caller graph for this function:

const VFS::Manager * CSMDoc::Document::getVFS ( ) const
bool CSMDoc::Document::isBlacklisted ( const CSMWorld::UniversalId id) const
bool CSMDoc::Document::isNew ( ) const

Is this a newly created content file?

Here is the caller graph for this function:

void CSMDoc::Document::mergeDone ( CSMDoc::Document document)
signal
Attention
When this signal is emitted, *this hands over the ownership of the document. This signal must be handled to avoid a leak.

Here is the caller graph for this function:

void CSMDoc::Document::modificationStateChanged ( bool  clean)
privateslot

Here is the caller graph for this function:

CSMWorld::UniversalId CSMDoc::Document::newSearch ( )
void CSMDoc::Document::operationDone ( int  type,
bool  failed 
)
privateslot

Here is the caller graph for this function:

Document& CSMDoc::Document::operator= ( const Document )
private
void CSMDoc::Document::progress ( int  current,
int  max,
int  type,
int  threads,
CSMDoc::Document document 
)
signal

Here is the caller graph for this function:

void CSMDoc::Document::progress ( int  current,
int  max,
int  type 
)
slot
void CSMDoc::Document::reportMessage ( const CSMDoc::Message message,
int  type 
)
privateslot
Todo:
find a better way to get these messages to the user.

Here is the caller graph for this function:

void CSMDoc::Document::runMerge ( std::auto_ptr< CSMDoc::Document target)
void CSMDoc::Document::runSearch ( const CSMWorld::UniversalId searchId,
const CSMTools::Search search 
)
void CSMDoc::Document::runStateChanged ( )
privateslot

Here is the caller graph for this function:

void CSMDoc::Document::save ( )

Here is the caller graph for this function:

void CSMDoc::Document::startRunning ( const std::string &  profile,
const std::string &  startupInstruction = "" 
)

Here is the call graph for this function:

void CSMDoc::Document::stateChanged ( int  state,
CSMDoc::Document document 
)
signal
void CSMDoc::Document::stopRunning ( )
CSMWorld::UniversalId CSMDoc::Document::verify ( const CSMWorld::UniversalId reportId = CSMWorld::UniversalId())

Member Data Documentation

Blacklist CSMDoc::Document::mBlacklist
private
std::vector<boost::filesystem::path> CSMDoc::Document::mContentFiles
private
CSMWorld::Data CSMDoc::Document::mData
private
bool CSMDoc::Document::mDirty
private
const Fallback::Map* CSMDoc::Document::mFallbackMap
private
CSMWorld::IdCompletionManager CSMDoc::Document::mIdCompletionManager
private
bool CSMDoc::Document::mNew
private
boost::filesystem::path CSMDoc::Document::mProjectPath
private
boost::filesystem::path CSMDoc::Document::mResDir
private
Runner CSMDoc::Document::mRunner
private
boost::filesystem::path CSMDoc::Document::mSavePath
private
OperationHolder CSMDoc::Document::mSaving
private
Saving CSMDoc::Document::mSavingOperation
private
CSMTools::Tools CSMDoc::Document::mTools
private
QUndoStack CSMDoc::Document::mUndoStack
private
const VFS::Manager* CSMDoc::Document::mVFS
private

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