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 &fixDescription, const QQmlSA::SourceLocation &location, const QString &replacement=QString())
 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 ()
 Destorys the FixSuggestion instance.
QString fixDescription () const
 Returns the description of the fix.
QQmlSA::SourceLocation location () const
 Returns the location where the fix would be applied.
QString replacement () const
 Returns the fix that will replace the problematic source code.
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 setHint (const QString &)
 Sets hint as the hint for this fix suggestion.
QString hint () const
 Returns the hint for this fix suggestion.
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 396 of file qqmlsa.h.

Constructor & Destructor Documentation

◆ FixSuggestion() [1/3]

QQmlSA::FixSuggestion::FixSuggestion ( const QString & fixDescription,
const QQmlSA::SourceLocation & location,
const QString & replacement = QString() )

Creates a FixSuggestion object.

Definition at line 2103 of file qqmlsa.cpp.

◆ FixSuggestion() [2/3]

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

Creates a copy of other.

Definition at line 2112 of file qqmlsa.cpp.

◆ FixSuggestion() [3/3]

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

Move-constructs a FixSuggestion instance.

Definition at line 2120 of file qqmlsa.cpp.

◆ ~FixSuggestion()

QQmlSA::FixSuggestion::~FixSuggestion ( )
default

Destorys the FixSuggestion instance.

Member Function Documentation

◆ fileName()

QString QQmlSA::FixSuggestion::fileName ( ) const

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

Definition at line 2190 of file qqmlsa.cpp.

◆ fixDescription()

QString QQmlSA::FixSuggestion::fixDescription ( ) const

Returns the description of the fix.

Definition at line 2157 of file qqmlsa.cpp.

◆ hint()

QString QQmlSA::FixSuggestion::hint ( ) const

Returns the hint for this fix suggestion.

Definition at line 2206 of file qqmlsa.cpp.

◆ isAutoApplicable()

bool QQmlSA::FixSuggestion::isAutoApplicable ( ) const

Returns whether this suggested fix can be applied automatically.

Definition at line 2223 of file qqmlsa.cpp.

◆ location()

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

Returns the location where the fix would be applied.

Definition at line 2165 of file qqmlsa.cpp.

◆ operator=() [1/2]

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

Assigns other to this FixSuggestion instance.

Definition at line 2128 of file qqmlsa.cpp.

◆ operator=() [2/2]

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

Move-assigns other to this FixSuggestion instance.

Definition at line 2140 of file qqmlsa.cpp.

◆ replacement()

QString QQmlSA::FixSuggestion::replacement ( ) const

Returns the fix that will replace the problematic source code.

Definition at line 2174 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 2215 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 2182 of file qqmlsa.cpp.

◆ setHint()

void QQmlSA::FixSuggestion::setHint ( const QString & hint)

Sets hint as the hint for this fix suggestion.

Definition at line 2198 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 427 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 422 of file qqmlsa.h.


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