Na ovoj stranici

Core::ILocatorFilter Class

class Core::ILocatorFilter

Klasa ILocatorFilter dodaje filtar locatora. Više...

Header: #include <coreplugin/locator/ilocatorfilter.h>
Inherits: QObject

Javne vrste

enum class MatchLevel { Best, Better, Good, Normal, Count }
enum Priority { Highest, High, Medium, Low }

Javne funkcije

ILocatorFilter(QObject *parent = nullptr)
Utils::Id actionId() const
QString description() const
QString displayName() const
Utils::Id id() const
bool isConfigurable() const
bool isEnabled() const
bool isHidden() const
bool isIncludedByDefault() const
virtual bool openConfigDialog(QWidget *parent, bool &needsRefresh)
Core::ILocatorFilter::Priority priority() const
void restoreState(const QByteArray &state)
QByteArray saveState() const
void setDefaultIncludedByDefault(bool includedByDefault)
void setDefaultShortcutString(const QString &shortcut)
void setDescription(const QString &description)
void setDisplayName(const QString &displayString)
void setIncludedByDefault(bool includedByDefault)
void setShortcutString(const QString &shortcut)
QString shortcutString() const

Javni slotovi

void setEnabled(bool enabled)

Statični javni članovi

Qt::CaseSensitivity caseSensitivity(const QString &str)
QRegularExpression createRegExp(const QString &text, Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive, bool multiWord = false)
Core::LocatorFilterEntry::HighlightInfo highlightInfo(const QRegularExpressionMatch &match, Core::LocatorFilterEntry::HighlightInfo::DataType dataType = LocatorFilterEntry::HighlightInfo::DisplayName)
QString msgConfigureDialogTitle()
QString msgIncludeByDefault()
QString msgIncludeByDefaultToolTip()
QString msgPrefixLabel()
QString msgPrefixToolTip()

Zaštićene funkcije

bool openConfigDialog(QWidget *parent, QWidget *additionalWidget)
std::optional<Tasking::GroupItem> refreshRecipe() const
virtual void restoreState(const QJsonObject &object)
virtual void saveState(QJsonObject &object) const
void setConfigurable(bool configurable)
void setHidden(bool hidden)
void setId(Utils::Id id)
void setPriority(Core::ILocatorFilter::Priority priority)

Detaljan opis

Filter je dodan u Tools > Locate.

Dokumentacija o vrsti člana

enum class ILocatorFilter::MatchLevel

Ova enum vrijednost sadrži razinu za redoslijed rezultata na temelju toga koliko dobro odgovaraju kriterijima pretraživanja.

KonstantnoVrijednostOpis
Core::ILocatorFilter::MatchLevel::Best0Rezultat je najbolji podudaranje za regularni izraz.
Core::ILocatorFilter::MatchLevel::Better1 
Core::ILocatorFilter::MatchLevel::Good2 
Core::ILocatorFilter::MatchLevel::Normal3 
Core::ILocatorFilter::MatchLevel::Count4Rezultat ima najveći broj podudaranja za regularni izraz.

enum ILocatorFilter::Priority

Ova enum vrijednost sadrži prioritet koji se koristi za redoslijed rezultata kada se koristi više filtara.

KonstantaVrijednostOpis
Core::ILocatorFilter::Highest0Rezultati za ovaj filtar postavljaju se iznad rezultata filtara koji imaju drugačije prioritete.
Core::ILocatorFilter::High1 
Core::ILocatorFilter::Medium2Zadana vrijednost.
Core::ILocatorFilter::Low3Rezultati za ovaj filtar postavljeni su ispod rezultata filtara koji imaju drugačije prioritete.

Dokumentacija funkcija člana

ILocatorFilter::ILocatorFilter(QObject *parent = nullptr)

Konstruira locator filter pomoću parent. Poziva se iz podklasa.

Utils::Id ILocatorFilter::actionId() const

Vraća ID akcije filtra.

[static] Qt::CaseSensitivity ILocatorFilter::caseSensitivity(const QString &str)

Vraća istinit ili netočan rezultat o tome treba li za pojam za pretraživanje str izvršiti pretraživanje osjetljivo na velika i mala slova ili neosjetljivo na velika i mala slova.

[static] QRegularExpression ILocatorFilter::createRegExp(const QString &text, Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive, bool multiWord = false)

Stvara pojam za pretraživanje " text " kao regularni izraz s osjetljivošću na velika i mala slova postavljenom na caseSensitivity. Proslijedite true u multiWord ako se očekuje da obrazac sadrži razmake.

QString ILocatorFilter::description() const

Vraća duži, ljudski čitljiv opis onoga što filtar radi.

Vidi također setDescription().

QString ILocatorFilter::displayName() const

Vraća prevedeno prikazno ime filtra.

Vidi također setDisplayName().

[static] Core::LocatorFilterEntry::HighlightInfo ILocatorFilter::highlightInfo(const QRegularExpressionMatch &match, Core::LocatorFilterEntry::HighlightInfo::DataType dataType = LocatorFilterEntry::HighlightInfo::DisplayName)

Vraća informacije za isticanje rezultata podudaranja regularnog izraza, specificiranog pomoću match, za podatke tipa dataType.

Utils::Id ILocatorFilter::id() const

Vraća jedinstveni ID filtra.

Vidi također setId().

bool ILocatorFilter::isConfigurable() const

Vraća je li za ovaj filtar dostupan dijalog konfiguracije.

Zadano je true.

Vidi također setConfigurable().

bool ILocatorFilter::isEnabled() const

Vraća je li filtar trenutno dostupan. Onemogućeni filtri nisu vidljivi ni u izbornicima ni u pretraživanjima, čak ni kada je pretraživanje započeto njihovom kraticom.

Zadano je true.

Vidi također setEnabled().

bool ILocatorFilter::isHidden() const

Locator filters Vraća je li filtar skriven u filtru za prikaz/skrivanje, izbornicima i postavkama lokatora.

Zadano je false.

Vidi također setHidden().

bool ILocatorFilter::isIncludedByDefault() const

Vraća je li za korištenje ovog filtera potrebno koristiti kraticu. Zadano je false.

Vidi također shortcutString() i setIncludedByDefault().

[static] QString ILocatorFilter::msgConfigureDialogTitle()

Određuje naslov za dijaloške okvire za konfiguraciju.

[static] QString ILocatorFilter::msgIncludeByDefault()

Određuje oznaku za polje za uključivanje prema zadanim postavkama u dijaloškim okvirima za konfiguraciju.

[static] QString ILocatorFilter::msgIncludeByDefaultToolTip()

Određuje alatnu pomoć za polje za uključivanje prema zadanim postavkama u dijaloškim okvirima za konfiguraciju.

[static] QString ILocatorFilter::msgPrefixLabel()

Određuje oznaku za polje unosa prefiksa u dijaloškim okvirima za konfiguraciju.

[static] QString ILocatorFilter::msgPrefixToolTip()

Određuje alatni savjet za polje za unos prefiksa u dijaloškim okvirima za konfiguraciju.

[protected] bool ILocatorFilter::openConfigDialog(QWidget *parent, QWidget *additionalWidget)

Prikazuje standardni konfiguracijski dijalog s opcijama za prefiksni niz i za isIncludedByDefault(). parent se koristi kao roditelj dijaloga. additionalWidget se dodaje na vrh. Vlasništvo nad additionalWidget ostaje kod pozivatelja, ali njegov roditelj se resetira na nullptr.

Vraća false ako je korisnik otkazao dijalog.

[virtual] bool ILocatorFilter::openConfigDialog(QWidget *parent, bool &needsRefresh)

Otvara dijalog za widget parent koji korisniku omogućuje konfiguraciju različitih aspekata filtra. Poziva se kada korisnik zatraži konfiguraciju filtra.

Postavite needsRefresh na true ako se osvježenje treba izvršiti nakon zatvaranja dijaloga. Vratite false ako je korisnik otkazao dijalog.

Zadana implementacija omogućuje promjenu prečaca i to da li je filtar uključен po zadanome.

Vidi također refreshRecipe().

Core::ILocatorFilter::Priority ILocatorFilter::priority() const

Vraća prioritet koji se koristi za redoslijed rezultata kada se koristi više filtara.

Zadano je ILocatorFilter::Medium.

Vidi također setPriority().

[protected] std::optional<Tasking::GroupItem> ILocatorFilter::refreshRecipe() const

Vraća recept za osvježavanje keširanih podataka. Po zadanome filtru locatora nije postavljen recept, pa se neće osvježiti.

void ILocatorFilter::restoreState(const QByteArray &state)

Obnavlja state filtra iz podataka prethodno stvorenih pomoću saveState().

Vidi također saveState().

[virtual protected] void ILocatorFilter::restoreState(const QJsonObject &object)

Čita postavke filtra i stanje iz JSON-a object

Zadana implementacija ne radi ništa.

objectImplementacije bi trebale čitati svoje prilagođene postavke iz JSON-a, resetirajući svaku nedostajuću postavku na njezinu zadanu vrijednost.

QByteArray ILocatorFilter::saveState() const

Vraća podatke koji se mogu koristiti za vraćanje postavki ovog filtera (na primjer pri pokretanju). Po zadanome dodaje osnovne postavke (niz prečaca, uključen po zadanome) i poziva saveState() s JSON objektom u koji nasljedne klase trebaju zapisati svoje prilagođene postavke.

Vidi također restoreState().

[virtual protected] void ILocatorFilter::saveState(QJsonObject &object) const

Sačuvajte postavke filtra i stanje u JSON object.

Zadana implementacija ne radi ništa.

Implementacije bi trebale zapisivati parove ključ-vrijednost u object za svoje prilagođene postavke koje su promijenjene u odnosu na zadano. Zadane vrijednosti nikada ne bi smjele biti spremljene.

[protected] void ILocatorFilter::setConfigurable(bool configurable)

Postavlja hoće li filtar pružiti konfiguracijski dijalog za configurable. Većina filtara trebala bi barem pružiti zadani dijalog.

Vidi također isConfigurable().

void ILocatorFilter::setDefaultIncludedByDefault(bool includedByDefault)

Postavlja zadano postavljanje za to je li potrebno koristiti kraticu naredke za korištenje ovog filtera na includedByDefault.

Pozovite na primjer iz konstruktora podklasa.

Vidi također isIncludedByDefault().

void ILocatorFilter::setDefaultShortcutString(const QString &shortcut)

Postavlja zadani niz shortcut koji se može koristiti za eksplicitno odabiranje ovog filtera u polju za unos lokatora. Nazovite, na primjer, iz konstruktora podklasa.

Vidi također shortcutString().

void ILocatorFilter::setDescription(const QString &description)

Postavlja duži, ljudski čitljiv opis ( description ) onoga što filtar radi.

Vidi također description().

void ILocatorFilter::setDisplayName(const QString &displayString)

Postavlja prevedeno ime prikaza ovog filtera na displayString.

Podklase moraju postaviti prikazano ime u svom konstruktoru.

Vidi također displayName().

[slot] void ILocatorFilter::setEnabled(bool enabled)

Postavlja je li filtar trenutačno dostupan za enabled.

Vidi također isEnabled().

[protected] void ILocatorFilter::setHidden(bool hidden)

Postavlja filtar u filtru Locator filters, izbornicima i postavkama locatora na hidden. Poziva konstruktor podklasa.

Vidi također isHidden().

[protected] void ILocatorFilter::setId(Utils::Id id)

idPostavlja jedinstveni identifikator filtra. Podklase moraju postaviti ID u svom konstruktoru.

Vidi također id().

void ILocatorFilter::setIncludedByDefault(bool includedByDefault)

Postavlja je li za korištenje ovog filtera potrebno koristiti skraćeni string includedByDefault. Koristite setDefaultIncludedByDefault() ako umjesto toga želite postaviti zadano vrijednost.

Vidi također isIncludedByDefault() i setDefaultIncludedByDefault().

[protected] void ILocatorFilter::setPriority(Core::ILocatorFilter::Priority priority)

Postavlja priority rezultata ovog filtra u popis rezultata.

Vidi također priority().

void ILocatorFilter::setShortcutString(const QString &shortcut)

Postavlja trenutni niz prečaca filtra na shortcut. Koristite setDefaultShortcutString() ako umjesto toga želite postaviti zadani niz prečaca.

Vidi također shortcutString() i setDefaultShortcutString().

QString ILocatorFilter::shortcutString() const

Određuje kraticu koja se može koristiti za izričito odabiranje ovog filtera u polju za unos lokatora tako da se ispred pojma za pretraživanje stavi ta kratica i razmak.

Zadana vrijednost je prazan niz.

Vidi također setShortcutString().

Copyright © The Qt Company Ltd. and other contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.