Extending Qt Creator Manual | ModelManagerInterface

Extending Qt Creator Manual 4.7.2

# ModelManagerInterface Class

(Debugger::QmlJS::ModelManagerInterface)

Inherits: | QObject

- List of all members, including inherited members

## Public Types

class | CppData
class | ProjectInfo
class | WorkingCopy
typedef | CppDataHash
typedef | CppDataHashIterator
enum | QrcResourceSelector { ActiveQrcResources, AllQrcResources }

## Public Functions

| ModelManagerInterface(Debugger::QObject *parent = 0)
virtual | ~ModelManagerInterface() override
void | activateScan()
QmlJS::QmlLanguageBundles | activeBundles() const
QList<Debugger::QmlJS::ModelManagerInterface::ProjectInfo> | allProjectInfosForPath(const Debugger::QString &path) const
Debugger::QmlJS::LibraryInfo | builtins(const Document::Ptr &doc) const
Debugger::QmlJS::ViewerContext | completeVContext(const Debugger::QmlJS::ViewerContext &vCtx, const Document::Ptr &doc = Document::Ptr(0)) const
Debugger::QmlJS::ModelManagerInterface::CppDataHash | cppData() const
virtual Debugger::QmlJS::ModelManagerInterface::ProjectInfo | defaultProjectInfo() const
virtual Debugger::QmlJS::ModelManagerInterface::ProjectInfo | defaultProjectInfoForProject(ProjectExplorer::Project *project) const
Debugger::QmlJS::ViewerContext | defaultVContext(int language = ..., const Document::Ptr &doc = Document::Ptr(0), bool autoComplete = true) const
void | emitDocumentChangedOnDisk(QmlJS::Document::Ptr doc)
QmlJS::Document::Ptr | ensuredGetDocumentForPath(const Debugger::QString &filePath)
QmlJS::QmlLanguageBundles | extendedBundles() const
void | fileChangedOnDisk(const Debugger::QString &path)
Debugger::QStringList | filesAtQrcPath(const Debugger::QString &path, const Debugger::QLocale *locale = 0, ProjectExplorer::Project *project = 0, Debugger::QmlJS::ModelManagerInterface::QrcResourceSelector resources = AllQrcResources)
QMap<Debugger::QString, Debugger::QStringList> | filesInQrcPath(const Debugger::QString &path, const Debugger::QLocale *locale = 0, ProjectExplorer::Project *project = 0, bool addDirs = false, Debugger::QmlJS::ModelManagerInterface::QrcResourceSelector resources = AllQrcResources)
Debugger::QStringList | importPathsNames() const
bool | isIdle() const
void | joinAllThreads()
void | loadPluginTypes(const Debugger::QString &libraryPath, const Debugger::QString &importPath, const Debugger::QString &importUri, const Debugger::QString &importVersion)
void | maybeQueueCppQmlTypeUpdate(const int &doc)
QmlJS::Snapshot | newestSnapshot() const
Debugger::QmlJS::ModelManagerInterface::ProjectInfo | projectInfo(ProjectExplorer::Project *project, const ModelManagerInterface::ProjectInfo &defaultValue = ProjectInfo()) const
Debugger::QmlJS::ModelManagerInterface::ProjectInfo | projectInfoForPath(const Debugger::QString &path) const
QList<Debugger::QmlJS::ModelManagerInterface::ProjectInfo> | projectInfos() const
Debugger::QStringList | qrcPathsForFile(const Debugger::QString &file, const Debugger::QLocale *locale = 0, ProjectExplorer::Project *project = 0, Debugger::QmlJS::ModelManagerInterface::QrcResourceSelector resources = AllQrcResources)
void | removeFiles(const Debugger::QStringList &files)
void | removeProjectInfo(ProjectExplorer::Project *project)
virtual void | resetCodeModel()
void | setDefaultVContext(const Debugger::QmlJS::ViewerContext &vContext)
QmlJS::Snapshot | snapshot() const
void | updateDocument(QmlJS::Document::Ptr doc)
void | updateLibraryInfo(const Debugger::QString &path, const QmlJS::LibraryInfo &info)
void | updateProjectInfo(const Debugger::QmlJS::ModelManagerInterface::ProjectInfo &pinfo, ProjectExplorer::Project *p)
void | updateQrcFile(const Debugger::QString &path)
void | updateSourceFiles(const Debugger::QStringList &files, bool emitDocumentOnDiskChanged)

- 34 public functions inherited from QObject

## Static Public Members

Debugger::QStringList | globPatternsForLanguages(const int languages)
int | guessLanguageOfFile(const Debugger::QString &)
void | importScan(int &future, Debugger::QmlJS::ModelManagerInterface::WorkingCopy workingCopyInternal, int paths, Debugger::QmlJS::ModelManagerInterface *modelManager, bool emitDocChangedOnDisk, bool libOnly = true, bool forceRescan = false)
Debugger::QmlJS::ModelManagerInterface * | instance()
Debugger::QmlJS::ModelManagerInterface::WorkingCopy | workingCopy()
void | writeWarning(const Debugger::QString &msg)

- 10 static public members inherited from QObject

## Protected Functions

void | aboutToRemoveFiles(const Debugger::QStringList &files)
virtual void | addTaskInternal(int result, const Debugger::QString &msg, const char *taskId) const
void | asyncReset()
void | documentChangedOnDisk(QmlJS::Document::Ptr doc)
void | documentUpdated(QmlJS::Document::Ptr doc)
int | languageForSuffix() const
void | libraryInfoUpdated(const Debugger::QString &path, const QmlJS::LibraryInfo &info)
void | loadQmlTypeDescriptionsInternal(const Debugger::QString &path)
void | maybeScan(const int &importPaths)
int * | mutex() const
void | projectInfoUpdated(const Debugger::QmlJS::ModelManagerInterface::ProjectInfo &pinfo)
void | projectPathChanged(const Debugger::QString &projectPath)
void | queueCppQmlTypeUpdate(const int &doc, bool scan)
int | refreshSourceFiles(const Debugger::QStringList &, bool)
void | setDefaultProject(const Debugger::QmlJS::ModelManagerInterface::ProjectInfo &pInfo, ProjectExplorer::Project *p)
virtual void | startCppQmlTypeUpdate()
void | updateImportPaths()
virtual Debugger::QmlJS::ModelManagerInterface::WorkingCopy | workingCopyInternal() const
virtual void | writeMessageInternal(const Debugger::QString &msg) const

- 9 protected functions inherited from QObject

## Static Protected Members

void | parse(int &future, Debugger::QmlJS::ModelManagerInterface::WorkingCopy workingCopyInternal, Debugger::QStringList files, Debugger::QmlJS::ModelManagerInterface *modelManager, int mainLanguage, bool emitDocChangedOnDisk)
void | parseLoop(QSet<Debugger::QString> &scannedPaths, QSet<Debugger::QString> &newLibraries, Debugger::QmlJS::ModelManagerInterface::WorkingCopy workingCopyInternal, Debugger::QStringList files, Debugger::QmlJS::ModelManagerInterface *modelManager, int mainLanguage, bool emitDocChangedOnDisk, int reportProgress)
void | updateCppQmlTypes(int &futureInterface, Debugger::QmlJS::ModelManagerInterface *qmlModelManager, CPlusPlus::Snapshot snapshot, int documents)

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 2 protected variables inherited from QObject

## Member Type Documentation

### typedef ModelManagerInterface::CppDataHash

### typedef ModelManagerInterface::CppDataHashIterator

### enum ModelManagerInterface::QrcResourceSelector

## Member Function Documentation

### ModelManagerInterface::ModelManagerInterface(Debugger::QObject *parent = 0)

Default constructs an instance of ModelManagerInterface.

### `[override virtual]` ModelManagerInterface::~ModelManagerInterface()

Destroys the instance of ModelManagerInterface. The destructor is virtual.

### `[protected]` void ModelManagerInterface::aboutToRemoveFiles(const Debugger::QStringList &files)

### void ModelManagerInterface::activateScan()

### QmlJS::QmlLanguageBundles ModelManagerInterface::activeBundles() const

### `[virtual protected]` void ModelManagerInterface::addTaskInternal(int result, const Debugger::QString &msg, const char *taskId) const

### QList<Debugger::QmlJS::ModelManagerInterface::ProjectInfo> ModelManagerInterface::allProjectInfosForPath(const Debugger::QString &path) const

### `[protected]` void ModelManagerInterface::asyncReset()

### Debugger::QmlJS::LibraryInfo ModelManagerInterface::builtins(const Document::Ptr &doc) const

### Debugger::QmlJS::ViewerContext ModelManagerInterface::completeVContext(const Debugger::QmlJS::ViewerContext &vCtx, const Document::Ptr &doc = Document::Ptr(0)) const

### Debugger::QmlJS::ModelManagerInterface::CppDataHash ModelManagerInterface::cppData() const

### `[virtual]` Debugger::QmlJS::ModelManagerInterface::ProjectInfo ModelManagerInterface::defaultProjectInfo() const

### `[virtual]` Debugger::QmlJS::ModelManagerInterface::ProjectInfo ModelManagerInterface::defaultProjectInfoForProject(ProjectExplorer::Project *project) const

### Debugger::QmlJS::ViewerContext ModelManagerInterface::defaultVContext(int language = ..., const Document::Ptr &doc = Document::Ptr(0), bool autoComplete = true) const

See also setDefaultVContext().

### `[protected]` void ModelManagerInterface::documentChangedOnDisk(QmlJS::Document::Ptr doc)

### `[protected]` void ModelManagerInterface::documentUpdated(QmlJS::Document::Ptr doc)

### void ModelManagerInterface::emitDocumentChangedOnDisk(QmlJS::Document::Ptr doc)

### QmlJS::Document::Ptr ModelManagerInterface::ensuredGetDocumentForPath(const Debugger::QString &filePath)

### QmlJS::QmlLanguageBundles ModelManagerInterface::extendedBundles() const

### void ModelManagerInterface::fileChangedOnDisk(const Debugger::QString &path)

### Debugger::QStringList ModelManagerInterface::filesAtQrcPath(const Debugger::QString &path, const Debugger::QLocale *locale = 0, ProjectExplorer::Project *project = 0, Debugger::QmlJS::ModelManagerInterface::QrcResourceSelector resources = AllQrcResources)

### QMap<Debugger::QString, Debugger::QStringList> ModelManagerInterface::filesInQrcPath(const Debugger::QString &path, const Debugger::QLocale *locale = 0, ProjectExplorer::Project *project = 0, bool addDirs = false, Debugger::QmlJS::ModelManagerInterface::QrcResourceSelector resources = AllQrcResources)

### `[static]` Debugger::QStringList ModelManagerInterface::globPatternsForLanguages(const int languages)

### `[static]` int ModelManagerInterface::guessLanguageOfFile(const Debugger::QString &)

### Debugger::QStringList ModelManagerInterface::importPathsNames() const

### `[static]` void ModelManagerInterface::importScan(int &future, Debugger::QmlJS::ModelManagerInterface::WorkingCopy workingCopyInternal, int paths, Debugger::QmlJS::ModelManagerInterface *modelManager, bool emitDocChangedOnDisk, bool libOnly = true, bool forceRescan = false)

### `[static]` Debugger::QmlJS::ModelManagerInterface *ModelManagerInterface::instance()

### bool ModelManagerInterface::isIdle() const

### void ModelManagerInterface::joinAllThreads()

### `[protected]` int ModelManagerInterface::languageForSuffix() const

### `[protected]` void ModelManagerInterface::libraryInfoUpdated(const Debugger::QString &path, const QmlJS::LibraryInfo &info)

### void ModelManagerInterface::loadPluginTypes(const Debugger::QString &libraryPath, const Debugger::QString &importPath, const Debugger::QString &importUri, const Debugger::QString &importVersion)

### `[protected]` void ModelManagerInterface::loadQmlTypeDescriptionsInternal(const Debugger::QString &path)

### void ModelManagerInterface::maybeQueueCppQmlTypeUpdate(const int &doc)

### `[protected]` void ModelManagerInterface::maybeScan(const int &importPaths)

### `[protected]` int *ModelManagerInterface::mutex() const

### QmlJS::Snapshot ModelManagerInterface::newestSnapshot() const

### `[static protected]` void ModelManagerInterface::parse(int &future, Debugger::QmlJS::ModelManagerInterface::WorkingCopy workingCopyInternal, Debugger::QStringList files, Debugger::QmlJS::ModelManagerInterface *modelManager, int mainLanguage, bool emitDocChangedOnDisk)

### `[static protected]` void ModelManagerInterface::parseLoop(QSet<Debugger::QString> &scannedPaths, QSet<Debugger::QString> &newLibraries, Debugger::QmlJS::ModelManagerInterface::WorkingCopy workingCopyInternal, Debugger::QStringList files, Debugger::QmlJS::ModelManagerInterface *modelManager, int mainLanguage, bool emitDocChangedOnDisk, int reportProgress)

### Debugger::QmlJS::ModelManagerInterface::ProjectInfo ModelManagerInterface::projectInfo(ProjectExplorer::Project *project, const ModelManagerInterface::ProjectInfo &defaultValue = ProjectInfo()) const

### Debugger::QmlJS::ModelManagerInterface::ProjectInfo ModelManagerInterface::projectInfoForPath(const Debugger::QString &path) const

### `[protected]` void ModelManagerInterface::projectInfoUpdated(const Debugger::QmlJS::ModelManagerInterface::ProjectInfo &pinfo)

### QList<Debugger::QmlJS::ModelManagerInterface::ProjectInfo> ModelManagerInterface::projectInfos() const

### `[protected]` void ModelManagerInterface::projectPathChanged(const Debugger::QString &projectPath)

### Debugger::QStringList ModelManagerInterface::qrcPathsForFile(const Debugger::QString &file, const Debugger::QLocale *locale = 0, ProjectExplorer::Project *project = 0, Debugger::QmlJS::ModelManagerInterface::QrcResourceSelector resources = AllQrcResources)

### `[protected]` void ModelManagerInterface::queueCppQmlTypeUpdate(const int &doc, bool scan)

### `[protected]` int ModelManagerInterface::refreshSourceFiles(const Debugger::QStringList &, bool)

### void ModelManagerInterface::removeFiles(const Debugger::QStringList &files)

### void ModelManagerInterface::removeProjectInfo(ProjectExplorer::Project *project)

### `[virtual]` void ModelManagerInterface::resetCodeModel()

### `[protected]` void ModelManagerInterface::setDefaultProject(const Debugger::QmlJS::ModelManagerInterface::ProjectInfo &pInfo, ProjectExplorer::Project *p)

### void ModelManagerInterface::setDefaultVContext(const Debugger::QmlJS::ViewerContext &vContext)

See also defaultVContext().

### QmlJS::Snapshot ModelManagerInterface::snapshot() const

### `[virtual protected]` void ModelManagerInterface::startCppQmlTypeUpdate()

### `[static protected]` void ModelManagerInterface::updateCppQmlTypes(int &futureInterface, Debugger::QmlJS::ModelManagerInterface *qmlModelManager, CPlusPlus::Snapshot snapshot, int documents)

### void ModelManagerInterface::updateDocument(QmlJS::Document::Ptr doc)

### `[protected]` void ModelManagerInterface::updateImportPaths()

### void ModelManagerInterface::updateLibraryInfo(const Debugger::QString &path, const QmlJS::LibraryInfo &info)

### void ModelManagerInterface::updateProjectInfo(const Debugger::QmlJS::ModelManagerInterface::ProjectInfo &pinfo, ProjectExplorer::Project *p)

### void ModelManagerInterface::updateQrcFile(const Debugger::QString &path)

### void ModelManagerInterface::updateSourceFiles(const Debugger::QStringList &files, bool emitDocumentOnDiskChanged)

### `[static]` Debugger::QmlJS::ModelManagerInterface::WorkingCopy ModelManagerInterface::workingCopy()

### `[virtual protected]` Debugger::QmlJS::ModelManagerInterface::WorkingCopy ModelManagerInterface::workingCopyInternal() const

### `[virtual protected]` void ModelManagerInterface::writeMessageInternal(const Debugger::QString &msg) const

### `[static]` void ModelManagerInterface::writeWarning(const Debugger::QString &msg)