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

#include <qqmlformatoptions_p.h>

Collaboration diagram for QQmlFormatOptions:

Public Types

enum  Settings {
  UseTabs = 0 , IndentWidth , MaxColumnWidth , NormalizeOrder ,
  NewlineType , ObjectsSpacing , FunctionsSpacing , GroupAttributesTogether ,
  SortImports , SingleLineEmptyObjects , SemicolonRule , SettingsFile ,
  SettingsCount
}
using LineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings
using AttributesSequence = QQmlJS::Dom::LineWriterOptions::AttributesSequence

Public Member Functions

 QQmlFormatOptions ()
bool tabsEnabled () const
void setTabsEnabled (bool tabs)
bool normalizeEnabled () const
void setNormalizeEnabled (bool normalize)
bool objectsSpacing () const
void setObjectsSpacing (bool spacing)
bool functionsSpacing () const
void setFunctionsSpacing (bool spacing)
bool groupAttributesTogether () const
void setGroupAttributesTogether (bool keep)
bool sortImports () const
void setSortImports (bool sort)
bool singleLineEmptyObjects () const
void setSingleLineEmptyObjects (bool singleLineEmptyObjects)
int indentWidth () const
void setIndentWidth (int widthwidth)
int maxColumnWidth () const
void setMaxColumnWidth (int widthwidth)
bool isMaxColumnWidthSet () const
void setSemicolonRule (QQmlJS::Dom::LineWriterOptions::SemicolonRule rule)
QQmlJS::Dom::LineWriterOptions::SemicolonRule semicolonRule () const
QQmlJS::Dom::LineWriterOptions optionsForCode (const QString &code) const
QQmlFormatOptionLineEndings newline () const
void setNewline (const QQmlFormatOptionLineEndings &endings)
QStringList files () const
void setFiles (const QStringList &newFiles)
QStringList arguments () const
void setArguments (const QStringList &newArguments)
bool isVerbose () const
void setIsVerbose (bool newVerbose)
bool isValid () const
bool isInplace () const
void setIsInplace (bool newInplace)
bool ignoreSettingsEnabled () const
void setIgnoreSettingsEnabled (bool newIgnoreSettings)
bool writeDefaultSettingsEnabled () const
void setWriteDefaultSettingsEnabled (bool newWriteDefaultSettings)
bool outputOptionsEnabled () const
void setOutputOptionsEnabled (bool newOutputOptions)
bool indentWidthSet () const
void setIndentWidthSet (bool newIndentWidthSet)
bool dryRun () const
void setDryRun (bool newDryRun)
QString settingsFile () const
void setSettingsFile (const QString &newSettingsFile)
QStringList errors () const
void addError (const QString &newError)
void applySettings (const QQmlFormatSettings &settings)
QQmlFormatOptions optionsForFile (const QString &fileName, QQmlFormatSettings *settings) const

Static Public Member Functions

static LineEndings detectLineEndings (const QString &code)
static LineEndings lineEndings (QQmlFormatOptionLineEndings endings, const QString &code)
static QQmlFormatOptionLineEndings parseEndings (const QString &endings)
static QQmlFormatOptions buildCommandLineOptions (const QStringList &args)

Detailed Description

Definition at line 36 of file qqmlformatoptions_p.h.

Member Typedef Documentation

◆ AttributesSequence

using QQmlFormatOptions::AttributesSequence = QQmlJS::Dom::LineWriterOptions::AttributesSequence

Definition at line 42 of file qqmlformatoptions_p.h.

◆ LineEndings

using QQmlFormatOptions::LineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings

Definition at line 41 of file qqmlformatoptions_p.h.

Member Enumeration Documentation

◆ Settings

enum QQmlFormatOptions::Settings
Enumerator
UseTabs 
IndentWidth 
MaxColumnWidth 
NormalizeOrder 
NewlineType 
ObjectsSpacing 
FunctionsSpacing 
GroupAttributesTogether 
SortImports 
SingleLineEmptyObjects 
SemicolonRule 
SettingsFile 
SettingsCount 

Definition at line 154 of file qqmlformatoptions_p.h.

Constructor & Destructor Documentation

◆ QQmlFormatOptions()

QQmlFormatOptions::QQmlFormatOptions ( )

Definition at line 13 of file qqmlformatoptions.cpp.

References setFunctionsSpacing(), setIndentWidth(), setNormalizeEnabled(), setObjectsSpacing(), setSingleLineEmptyObjects(), and setTabsEnabled().

Here is the call graph for this function:

Member Function Documentation

◆ addError()

void QQmlFormatOptions::addError ( const QString & newError)
inline

Definition at line 146 of file qqmlformatoptions_p.h.

◆ applySettings()

void QQmlFormatOptions::applySettings ( const QQmlFormatSettings & settings)

Definition at line 81 of file qqmlformatoptions.cpp.

References FunctionsSpacing, GroupAttributesTogether, IndentWidth, MaxColumnWidth, NewlineType, NormalizeOrder, ObjectsSpacing, SemicolonRule, setFunctionsSpacing(), setGroupAttributesTogether(), setIndentWidth(), setMaxColumnWidth(), setNewline(), setNormalizeEnabled(), setObjectsSpacing(), setSingleLineEmptyObjects(), setSortImports(), setTabsEnabled(), SingleLineEmptyObjects, SortImports, and UseTabs.

Referenced by optionsForFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ arguments()

QStringList QQmlFormatOptions::arguments ( ) const
inline

Definition at line 122 of file qqmlformatoptions_p.h.

◆ buildCommandLineOptions()

QQmlFormatOptions QQmlFormatOptions::buildCommandLineOptions ( const QStringList & args)
static

Definition at line 149 of file qqmlformatoptions.cpp.

References FunctionsSpacing, GroupAttributesTogether, IndentWidth, MaxColumnWidth, NewlineType, NormalizeOrder, ObjectsSpacing, SemicolonRule, setDryRun(), setFunctionsSpacing(), setGroupAttributesTogether(), setIgnoreSettingsEnabled(), setIndentWidth(), setIsInplace(), setIsVerbose(), setMaxColumnWidth(), setNewline(), setNormalizeEnabled(), setObjectsSpacing(), setOutputOptionsEnabled(), setSingleLineEmptyObjects(), setSortImports(), setTabsEnabled(), SettingsFile, setWriteDefaultSettingsEnabled(), SingleLineEmptyObjects, SortImports, and UseTabs.

Here is the call graph for this function:

◆ detectLineEndings()

QQmlFormatOptions::LineEndings QQmlFormatOptions::detectLineEndings ( const QString & code)
static

Definition at line 23 of file qqmlformatoptions.cpp.

◆ dryRun()

bool QQmlFormatOptions::dryRun ( ) const
inline

Definition at line 141 of file qqmlformatoptions_p.h.

◆ errors()

QStringList QQmlFormatOptions::errors ( ) const
inline

Definition at line 145 of file qqmlformatoptions_p.h.

◆ files()

QStringList QQmlFormatOptions::files ( ) const
inline

Definition at line 120 of file qqmlformatoptions_p.h.

◆ functionsSpacing()

bool QQmlFormatOptions::functionsSpacing ( ) const
inline

Definition at line 74 of file qqmlformatoptions_p.h.

◆ groupAttributesTogether()

bool QQmlFormatOptions::groupAttributesTogether ( ) const
inline

Definition at line 77 of file qqmlformatoptions_p.h.

◆ ignoreSettingsEnabled()

bool QQmlFormatOptions::ignoreSettingsEnabled ( ) const
inline

Definition at line 129 of file qqmlformatoptions_p.h.

Referenced by optionsForFile().

Here is the caller graph for this function:

◆ indentWidth()

int QQmlFormatOptions::indentWidth ( ) const
inline

Definition at line 91 of file qqmlformatoptions_p.h.

◆ indentWidthSet()

bool QQmlFormatOptions::indentWidthSet ( ) const
inline

Definition at line 139 of file qqmlformatoptions_p.h.

◆ isInplace()

bool QQmlFormatOptions::isInplace ( ) const
inline

Definition at line 127 of file qqmlformatoptions_p.h.

◆ isMaxColumnWidthSet()

bool QQmlFormatOptions::isMaxColumnWidthSet ( ) const
inline

Definition at line 96 of file qqmlformatoptions_p.h.

◆ isValid()

bool QQmlFormatOptions::isValid ( ) const
inline

Definition at line 126 of file qqmlformatoptions_p.h.

◆ isVerbose()

bool QQmlFormatOptions::isVerbose ( ) const
inline

Definition at line 124 of file qqmlformatoptions_p.h.

◆ lineEndings()

LineEndings QQmlFormatOptions::lineEndings ( QQmlFormatOptionLineEndings endings,
const QString & code )
inlinestatic

Definition at line 46 of file qqmlformatoptions_p.h.

◆ maxColumnWidth()

int QQmlFormatOptions::maxColumnWidth ( ) const
inline

Definition at line 94 of file qqmlformatoptions_p.h.

◆ newline()

QQmlFormatOptionLineEndings QQmlFormatOptions::newline ( ) const
inline

Definition at line 117 of file qqmlformatoptions_p.h.

◆ normalizeEnabled()

bool QQmlFormatOptions::normalizeEnabled ( ) const
inline

Definition at line 63 of file qqmlformatoptions_p.h.

◆ objectsSpacing()

bool QQmlFormatOptions::objectsSpacing ( ) const
inline

Definition at line 72 of file qqmlformatoptions_p.h.

◆ optionsForCode()

QQmlJS::Dom::LineWriterOptions QQmlFormatOptions::optionsForCode ( const QString & code) const
inline

Definition at line 108 of file qqmlformatoptions_p.h.

◆ optionsForFile()

QQmlFormatOptions QQmlFormatOptions::optionsForFile ( const QString & fileName,
QQmlFormatSettings * settings ) const

Definition at line 426 of file qqmlformatoptions.cpp.

References applySettings(), ignoreSettingsEnabled(), and setIsInplace().

Here is the call graph for this function:

◆ outputOptionsEnabled()

bool QQmlFormatOptions::outputOptionsEnabled ( ) const
inline

Definition at line 136 of file qqmlformatoptions_p.h.

◆ parseEndings()

QQmlFormatOptionLineEndings QQmlFormatOptions::parseEndings ( const QString & endings)
static

Definition at line 52 of file qqmlformatoptions.cpp.

◆ semicolonRule()

QQmlJS::Dom::LineWriterOptions::SemicolonRule QQmlFormatOptions::semicolonRule ( ) const
inline

Definition at line 103 of file qqmlformatoptions_p.h.

◆ setArguments()

void QQmlFormatOptions::setArguments ( const QStringList & newArguments)
inline

Definition at line 123 of file qqmlformatoptions_p.h.

◆ setDryRun()

void QQmlFormatOptions::setDryRun ( bool newDryRun)
inline

Definition at line 142 of file qqmlformatoptions_p.h.

Referenced by buildCommandLineOptions().

Here is the caller graph for this function:

◆ setFiles()

void QQmlFormatOptions::setFiles ( const QStringList & newFiles)
inline

Definition at line 121 of file qqmlformatoptions_p.h.

◆ setFunctionsSpacing()

void QQmlFormatOptions::setFunctionsSpacing ( bool spacing)
inline

Definition at line 75 of file qqmlformatoptions_p.h.

Referenced by QQmlFormatOptions(), applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setGroupAttributesTogether()

void QQmlFormatOptions::setGroupAttributesTogether ( bool keep)
inline

Definition at line 78 of file qqmlformatoptions_p.h.

Referenced by applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setIgnoreSettingsEnabled()

void QQmlFormatOptions::setIgnoreSettingsEnabled ( bool newIgnoreSettings)
inline

Definition at line 130 of file qqmlformatoptions_p.h.

Referenced by buildCommandLineOptions().

Here is the caller graph for this function:

◆ setIndentWidth()

void QQmlFormatOptions::setIndentWidth ( int width)
inline

Definition at line 92 of file qqmlformatoptions_p.h.

Referenced by QQmlFormatOptions(), applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setIndentWidthSet()

void QQmlFormatOptions::setIndentWidthSet ( bool newIndentWidthSet)
inline

Definition at line 140 of file qqmlformatoptions_p.h.

◆ setIsInplace()

void QQmlFormatOptions::setIsInplace ( bool newInplace)
inline

Definition at line 128 of file qqmlformatoptions_p.h.

Referenced by buildCommandLineOptions(), and optionsForFile().

Here is the caller graph for this function:

◆ setIsVerbose()

void QQmlFormatOptions::setIsVerbose ( bool newVerbose)
inline

Definition at line 125 of file qqmlformatoptions_p.h.

Referenced by buildCommandLineOptions().

Here is the caller graph for this function:

◆ setMaxColumnWidth()

void QQmlFormatOptions::setMaxColumnWidth ( int width)
inline

Definition at line 95 of file qqmlformatoptions_p.h.

Referenced by applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setNewline()

void QQmlFormatOptions::setNewline ( const QQmlFormatOptionLineEndings & endings)
inline

Definition at line 118 of file qqmlformatoptions_p.h.

Referenced by applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setNormalizeEnabled()

void QQmlFormatOptions::setNormalizeEnabled ( bool normalize)
inline

Definition at line 67 of file qqmlformatoptions_p.h.

Referenced by QQmlFormatOptions(), applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setObjectsSpacing()

void QQmlFormatOptions::setObjectsSpacing ( bool spacing)
inline

Definition at line 73 of file qqmlformatoptions_p.h.

Referenced by QQmlFormatOptions(), applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setOutputOptionsEnabled()

void QQmlFormatOptions::setOutputOptionsEnabled ( bool newOutputOptions)
inline

Definition at line 137 of file qqmlformatoptions_p.h.

Referenced by buildCommandLineOptions().

Here is the caller graph for this function:

◆ setSemicolonRule()

void QQmlFormatOptions::setSemicolonRule ( QQmlJS::Dom::LineWriterOptions::SemicolonRule rule)
inline

Definition at line 98 of file qqmlformatoptions_p.h.

◆ setSettingsFile()

void QQmlFormatOptions::setSettingsFile ( const QString & newSettingsFile)
inline

Definition at line 144 of file qqmlformatoptions_p.h.

◆ setSingleLineEmptyObjects()

void QQmlFormatOptions::setSingleLineEmptyObjects ( bool singleLineEmptyObjects)
inline

Definition at line 89 of file qqmlformatoptions_p.h.

Referenced by QQmlFormatOptions(), applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setSortImports()

void QQmlFormatOptions::setSortImports ( bool sort)
inline

Definition at line 86 of file qqmlformatoptions_p.h.

Referenced by applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ setTabsEnabled()

void QQmlFormatOptions::setTabsEnabled ( bool tabs)
inline

Definition at line 62 of file qqmlformatoptions_p.h.

Referenced by QQmlFormatOptions(), applySettings(), and buildCommandLineOptions().

Here is the caller graph for this function:

◆ settingsFile()

QString QQmlFormatOptions::settingsFile ( ) const
inline

Definition at line 143 of file qqmlformatoptions_p.h.

◆ setWriteDefaultSettingsEnabled()

void QQmlFormatOptions::setWriteDefaultSettingsEnabled ( bool newWriteDefaultSettings)
inline

Definition at line 132 of file qqmlformatoptions_p.h.

Referenced by buildCommandLineOptions().

Here is the caller graph for this function:

◆ singleLineEmptyObjects()

bool QQmlFormatOptions::singleLineEmptyObjects ( ) const
inline

Definition at line 88 of file qqmlformatoptions_p.h.

◆ sortImports()

bool QQmlFormatOptions::sortImports ( ) const
inline

Definition at line 85 of file qqmlformatoptions_p.h.

◆ tabsEnabled()

bool QQmlFormatOptions::tabsEnabled ( ) const
inline

Definition at line 61 of file qqmlformatoptions_p.h.

◆ writeDefaultSettingsEnabled()

bool QQmlFormatOptions::writeDefaultSettingsEnabled ( ) const
inline

Definition at line 131 of file qqmlformatoptions_p.h.

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