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
QQmlFormatSettings Class Reference

#include <qqmlformatsettings_p.h>

Inheritance diagram for QQmlFormatSettings:
Collaboration diagram for QQmlFormatSettings:

Public Member Functions

 QQmlFormatSettings (const QString &toolName=QLatin1String("qmlformat"))
void addOption (const QString &name, const QVariant &defaultValue, const QStringList &allowedValues={})
bool outputOptions () const
Public Member Functions inherited from QQmlToolingSettings
 QQmlToolingSettings (const QString &toolName, const QStringList &recognizedIniSections={ QStringLiteral("General") })
void addOption (const QString &name, const QVariant &defaultValue=QVariant())
SearchResult search (const QString &path, const SearchOptions &options={})
bool writeDefaults () const
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)

Static Public Attributes

static const QLatin1StringView s_useTabsSetting = QLatin1String("UseTabs")
static const QLatin1StringView s_indentWidthSetting = QLatin1String("IndentWidth")
static const QLatin1StringView s_maxColumnWidthSetting = QLatin1String("MaxColumnWidth")
static const QLatin1StringView s_normalizeSetting = QLatin1String("NormalizeOrder")
static const QLatin1StringView s_newlineSetting = QLatin1String("NewlineType")
static const QLatin1StringView s_objectsSpacingSetting = QLatin1String("ObjectsSpacing")
static const QLatin1StringView s_functionsSpacingSetting = QLatin1String("FunctionsSpacing")
static const QLatin1StringView s_sortImportsSetting = QLatin1String("SortImports")
static const QLatin1StringView s_singleLineEmptyObjectsSetting = QLatin1String("SingleLineEmptyObjects")
static const QLatin1StringView s_semiColonRuleSetting = QLatin1String("SemicolonRule")

Protected Attributes

QHash< QString, QStringList > m_allowedValues
Protected Attributes inherited from QQmlToolingSettings
QString m_currentSettingsPath
QVariantHash m_values
Searcher m_searcher
QStringList m_recognizedIniSections

Additional Inherited Members

Static Public Member Functions inherited from QQmlToolingSettings
static void resolveRelativeImportPaths (const QString &filePath, QStringList *paths)
Protected Member Functions inherited from QQmlToolingSettings
SearchResult read (const QString &settingsFilePath, SearchOptions options)

Detailed Description

Definition at line 23 of file qqmlformatsettings_p.h.

Constructor & Destructor Documentation

◆ QQmlFormatSettings()

QQmlFormatSettings::QQmlFormatSettings ( const QString & toolName = QLatin1String("qmlformat"))

Definition at line 14 of file qqmlformatsettings.cpp.

Member Function Documentation

◆ addOption()

void QQmlFormatSettings::addOption ( const QString & name,
const QVariant & defaultValue,
const QStringList & allowedValues = {} )

Definition at line 29 of file qqmlformatsettings.cpp.

◆ outputOptions()

bool QQmlFormatSettings::outputOptions ( ) const

Definition at line 38 of file qqmlformatsettings.cpp.

Member Data Documentation

◆ m_allowedValues

QHash<QString, QStringList> QQmlFormatSettings::m_allowedValues
protected

Definition at line 44 of file qqmlformatsettings_p.h.

◆ s_functionsSpacingSetting

const QLatin1StringView QQmlFormatSettings::s_functionsSpacingSetting = QLatin1String("FunctionsSpacing")
inlinestatic

Definition at line 38 of file qqmlformatsettings_p.h.

◆ s_indentWidthSetting

const QLatin1StringView QQmlFormatSettings::s_indentWidthSetting = QLatin1String("IndentWidth")
inlinestatic

Definition at line 33 of file qqmlformatsettings_p.h.

◆ s_maxColumnWidthSetting

const QLatin1StringView QQmlFormatSettings::s_maxColumnWidthSetting = QLatin1String("MaxColumnWidth")
inlinestatic

Definition at line 34 of file qqmlformatsettings_p.h.

◆ s_newlineSetting

const QLatin1StringView QQmlFormatSettings::s_newlineSetting = QLatin1String("NewlineType")
inlinestatic

Definition at line 36 of file qqmlformatsettings_p.h.

◆ s_normalizeSetting

const QLatin1StringView QQmlFormatSettings::s_normalizeSetting = QLatin1String("NormalizeOrder")
inlinestatic

Definition at line 35 of file qqmlformatsettings_p.h.

◆ s_objectsSpacingSetting

const QLatin1StringView QQmlFormatSettings::s_objectsSpacingSetting = QLatin1String("ObjectsSpacing")
inlinestatic

Definition at line 37 of file qqmlformatsettings_p.h.

◆ s_semiColonRuleSetting

const QLatin1StringView QQmlFormatSettings::s_semiColonRuleSetting = QLatin1String("SemicolonRule")
inlinestatic

Definition at line 41 of file qqmlformatsettings_p.h.

◆ s_singleLineEmptyObjectsSetting

const QLatin1StringView QQmlFormatSettings::s_singleLineEmptyObjectsSetting = QLatin1String("SingleLineEmptyObjects")
inlinestatic

Definition at line 40 of file qqmlformatsettings_p.h.

◆ s_sortImportsSetting

const QLatin1StringView QQmlFormatSettings::s_sortImportsSetting = QLatin1String("SortImports")
inlinestatic

Definition at line 39 of file qqmlformatsettings_p.h.

◆ s_useTabsSetting

const QLatin1StringView QQmlFormatSettings::s_useTabsSetting = QLatin1String("UseTabs")
inlinestatic

Definition at line 32 of file qqmlformatsettings_p.h.

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