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
QQmlSA::FixSuggestion Class Reference

\inmodule QtQmlCompiler More...

#include <qqmlsa.h>

Collaboration diagram for QQmlSA::FixSuggestion:

Public Member Functions

 FixSuggestion (const QString &description, const QQmlSA::SourceLocation &location, const DocumentEdit &documentEdit)
 Creates a FixSuggestion object.
 FixSuggestion (const QString &description, const QQmlSA::SourceLocation &location, const QList< DocumentEdit > &documentEdits={})
 Creates a FixSuggestion object.
 FixSuggestion (const FixSuggestion &)
 Creates a copy of other.
 FixSuggestion (FixSuggestion &&) noexcept
 Move-constructs a FixSuggestion instance.
FixSuggestionoperator= (const FixSuggestion &)
 Assigns other to this FixSuggestion instance.
FixSuggestionoperator= (FixSuggestion &&) noexcept
 Move-assigns other to this FixSuggestion instance.
 ~FixSuggestion ()
 Destroys the FixSuggestion instance.
QString description () const
 Returns the description of the fix.
QQmlSA::SourceLocation location () const
 Returns the location of the fix.
void addDocumentEdit (const DocumentEdit &)
 Adds a document edit to the list of edits for this fix.
QList< DocumentEditdocumentEdits () const
 Returns the list of document edits that applying this fix would make.
void setFileName (const QString &)
 Sets fileName as the name of the file where this fix suggestion applies.
QString fileName () const
 Returns the name of the file where this fix suggestion applies.
void setAutoApplicable (bool autoApplicable=true)
 Sets autoApplicable to determine whether this suggested fix can be applied automatically.
bool isAutoApplicable () const
 Returns whether this suggested fix can be applied automatically.

Friends

bool operator== (const FixSuggestion &lhs, const FixSuggestion &rhs)
 Returns true if lhs and rhs are equal, and false otherwise.
bool operator!= (const FixSuggestion &lhs, const FixSuggestion &rhs)
 Returns true if lhs and rhs are not equal, and false otherwise.

Detailed Description

\inmodule QtQmlCompiler

Represents a suggested fix for an issue in the source code.

Definition at line 405 of file qqmlsa.h.

Constructor & Destructor Documentation

◆ FixSuggestion() [1/4]

QQmlSA::FixSuggestion::FixSuggestion ( const QString & description,
const QQmlSA::SourceLocation & location,
const DocumentEdit & documentEdit )

Creates a FixSuggestion object.

Definition at line 2204 of file qqmlsa.cpp.

◆ FixSuggestion() [2/4]

QQmlSA::FixSuggestion::FixSuggestion ( const QString & description,
const QQmlSA::SourceLocation & location,
const QList< DocumentEdit > & documentEdits = {} )

Creates a FixSuggestion object.

Definition at line 2214 of file qqmlsa.cpp.

◆ FixSuggestion() [3/4]

QQmlSA::FixSuggestion::FixSuggestion ( const FixSuggestion & other)

Creates a copy of other.

Definition at line 2223 of file qqmlsa.cpp.

◆ FixSuggestion() [4/4]

QQmlSA::FixSuggestion::FixSuggestion ( FixSuggestion && other)
noexcept

Move-constructs a FixSuggestion instance.

Definition at line 2231 of file qqmlsa.cpp.

◆ ~FixSuggestion()

QQmlSA::FixSuggestion::~FixSuggestion ( )
default

Destroys the FixSuggestion instance.

Member Function Documentation

◆ addDocumentEdit()

void QQmlSA::FixSuggestion::addDocumentEdit ( const DocumentEdit & edit)

Adds a document edit to the list of edits for this fix.

Definition at line 2286 of file qqmlsa.cpp.

◆ description()

QString QQmlSA::FixSuggestion::description ( ) const

Returns the description of the fix.

Definition at line 2268 of file qqmlsa.cpp.

◆ documentEdits()

QList< DocumentEdit > QQmlSA::FixSuggestion::documentEdits ( ) const

Returns the list of document edits that applying this fix would make.

Definition at line 2295 of file qqmlsa.cpp.

◆ fileName()

QString QQmlSA::FixSuggestion::fileName ( ) const

Returns the name of the file where this fix suggestion applies.

Definition at line 2312 of file qqmlsa.cpp.

◆ isAutoApplicable()

bool QQmlSA::FixSuggestion::isAutoApplicable ( ) const

Returns whether this suggested fix can be applied automatically.

Definition at line 2330 of file qqmlsa.cpp.

◆ location()

QQmlSA::SourceLocation QQmlSA::FixSuggestion::location ( ) const

Returns the location of the fix.

Definition at line 2277 of file qqmlsa.cpp.

◆ operator=() [1/2]

FixSuggestion & QQmlSA::FixSuggestion::operator= ( const FixSuggestion & other)

Assigns other to this FixSuggestion instance.

Definition at line 2239 of file qqmlsa.cpp.

◆ operator=() [2/2]

FixSuggestion & QQmlSA::FixSuggestion::operator= ( FixSuggestion && other)
noexcept

Move-assigns other to this FixSuggestion instance.

Definition at line 2251 of file qqmlsa.cpp.

◆ setAutoApplicable()

void QQmlSA::FixSuggestion::setAutoApplicable ( bool autoApplicable = true)

Sets autoApplicable to determine whether this suggested fix can be applied automatically.

Definition at line 2321 of file qqmlsa.cpp.

◆ setFileName()

void QQmlSA::FixSuggestion::setFileName ( const QString & fileName)

Sets fileName as the name of the file where this fix suggestion applies.

Definition at line 2304 of file qqmlsa.cpp.

◆ operator!=

bool operator!= ( const FixSuggestion & lhs,
const FixSuggestion & rhs )
friend

Returns true if lhs and rhs are not equal, and false otherwise.

Definition at line 437 of file qqmlsa.h.

◆ operator==

bool operator== ( const FixSuggestion & lhs,
const FixSuggestion & rhs )
friend

Returns true if lhs and rhs are equal, and false otherwise.

Definition at line 432 of file qqmlsa.h.


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