Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlToolingSettings Class Reference

#include <qqmltoolingsettings_p.h>

Inheritance diagram for QQmlToolingSettings:
Collaboration diagram for QQmlToolingSettings:

Classes

struct  SearchOptions
struct  SearchResult
class  Searcher

Public Member Functions

 QQmlToolingSettings (const QString &toolName, const QStringList &recognizedIniSections={ QStringLiteral("General") }, const QString &localSettingsFile={ }, const QString &globalSettingsFile={ })
void addOption (const QString &name, const QVariant &defaultValue=QVariant())
SearchResult search (const QString &path, const SearchOptions &options={})
bool writeDefaults () const
void setValue (const QString &name, QVariant value)
QVariant value (const QString &name) const
QStringList valueAsStringList (const QString &name) const
QStringList valueAsAbsolutePathList (const QString &name, const QString &baseForRelativePaths) const
bool isSet (const QString &name) const
bool reportConfigForFiles (const QStringList &files)
auto asKeyValueRange () const
QString currentSettingsPath () const

Static Public Member Functions

static void resolveRelativeImportPaths (const QString &filePath, QStringList *paths)

Protected Member Functions

SearchResult read (const QString &settingsFilePath, SearchOptions options)

Protected Attributes

QString m_currentSettingsPath
QVariantHash m_values
Searcher m_searcher
QStringList m_recognizedIniSections

Detailed Description

Definition at line 28 of file qqmltoolingsettings_p.h.

Constructor & Destructor Documentation

◆ QQmlToolingSettings()

QQmlToolingSettings::QQmlToolingSettings ( const QString & toolName,
const QStringList & recognizedIniSections = { QStringLiteral("General") },
const QString & localSettingsFile = { },
const QString & globalSettingsFile = { } )

Definition at line 35 of file qqmltoolingsettings.cpp.

Member Function Documentation

◆ addOption()

void QQmlToolingSettings::addOption ( const QString & name,
const QVariant & defaultValue = QVariant() )

Definition at line 28 of file qqmltoolingsettings.cpp.

◆ asKeyValueRange()

auto QQmlToolingSettings::asKeyValueRange ( ) const
inline

Definition at line 87 of file qqmltoolingsettings_p.h.

◆ currentSettingsPath()

QString QQmlToolingSettings::currentSettingsPath ( ) const
inline

Definition at line 89 of file qqmltoolingsettings_p.h.

◆ isSet()

bool QQmlToolingSettings::isSet ( const QString & name) const

Definition at line 247 of file qqmltoolingsettings.cpp.

◆ read()

QQmlToolingSettings::SearchResult QQmlToolingSettings::read ( const QString & settingsFilePath,
SearchOptions options )
protected

Definition at line 45 of file qqmltoolingsettings.cpp.

◆ reportConfigForFiles()

bool QQmlToolingSettings::reportConfigForFiles ( const QStringList & files)

Definition at line 258 of file qqmltoolingsettings.cpp.

◆ resolveRelativeImportPaths()

void QQmlToolingSettings::resolveRelativeImportPaths ( const QString & filePath,
QStringList * paths )
static

Definition at line 228 of file qqmltoolingsettings.cpp.

◆ search()

QQmlToolingSettings::SearchResult QQmlToolingSettings::search ( const QString & path,
const SearchOptions & options = {} )

Definition at line 193 of file qqmltoolingsettings.cpp.

◆ setValue()

void QQmlToolingSettings::setValue ( const QString & name,
QVariant value )

Definition at line 213 of file qqmltoolingsettings.cpp.

◆ value()

QVariant QQmlToolingSettings::value ( const QString & name) const

Definition at line 218 of file qqmltoolingsettings.cpp.

◆ valueAsAbsolutePathList()

QStringList QQmlToolingSettings::valueAsAbsolutePathList ( const QString & name,
const QString & baseForRelativePaths ) const

Definition at line 239 of file qqmltoolingsettings.cpp.

◆ valueAsStringList()

QStringList QQmlToolingSettings::valueAsStringList ( const QString & name) const

Definition at line 223 of file qqmltoolingsettings.cpp.

◆ writeDefaults()

bool QQmlToolingSettings::writeDefaults ( ) const

Definition at line 79 of file qqmltoolingsettings.cpp.

Member Data Documentation

◆ m_currentSettingsPath

QString QQmlToolingSettings::m_currentSettingsPath
protected

Definition at line 92 of file qqmltoolingsettings_p.h.

◆ m_recognizedIniSections

QStringList QQmlToolingSettings::m_recognizedIniSections
protected

Definition at line 95 of file qqmltoolingsettings_p.h.

◆ m_searcher

Searcher QQmlToolingSettings::m_searcher
protected

Definition at line 94 of file qqmltoolingsettings_p.h.

◆ m_values

QVariantHash QQmlToolingSettings::m_values
protected

Definition at line 93 of file qqmltoolingsettings_p.h.

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