ExtensionSystem::PluginSpec Class
class ExtensionSystem::PluginSpecKlasa PluginSpec sadrži informacije o ugrađenim metapodacima dodatka i o trenutnom stanju dodatka. Više...
| Header: | #include <extensionsystem/pluginspec.h> |
Javne vrste
| enum | State { Invalid, Read, Resolved, Loaded, Initialized, …, Deleted } |
Javne funkcije
| virtual void | addArgument(const QString &argument) |
| virtual ExtensionSystem::PluginSpec::PluginArgumentDescriptions | argumentDescriptions() const |
| virtual QStringList | arguments() const |
| virtual QString | category() const |
| virtual QString | compatVersion() const |
| virtual QString | copyright() const |
| virtual QList<ExtensionSystem::PluginDependency> | dependencies() const |
| virtual QHash<ExtensionSystem::PluginDependency, ExtensionSystem::PluginSpec *> | dependencySpecs() const |
| virtual QString | description() const |
| virtual QString | displayName() const |
| virtual QString | documentationUrl() const |
| virtual QString | errorString() const |
| virtual Utils::FilePath | filePath() const |
| virtual bool | hasError() const |
| virtual QString | id() const |
| virtual bool | isAvailableForHostPlatform() const |
| virtual bool | isDeprecated() const |
| virtual bool | isEffectivelyEnabled() const |
| virtual bool | isEnabledByDefault() const |
| virtual bool | isEnabledBySettings() const |
| virtual bool | isEnabledIndirectly() const |
| virtual bool | isExperimental() const |
| virtual bool | isForceDisabled() const |
| virtual bool | isForceEnabled() const |
| virtual bool | isRequired() const |
| virtual bool | isSoftLoadable() const |
| virtual QString | license() const |
| virtual Utils::FilePath | location() const |
| virtual QString | longDescription() const |
| virtual QJsonObject | metaData() const |
| virtual QString | name() const |
(since 3.0) virtual QRegularExpression | platformSpecification() const |
| virtual bool | provides(ExtensionSystem::PluginSpec *spec, const ExtensionSystem::PluginDependency &dependency) const |
| virtual QStringList | recommends() const |
| virtual QSet<ExtensionSystem::PluginSpec *> | recommendsSpecs() const |
| virtual bool | requiresAny(const QSet<ExtensionSystem::PluginSpec *> &plugins) const |
| virtual void | setArguments(const QStringList &arguments) |
| virtual void | setEnabledBySettings(bool value) |
| virtual ExtensionSystem::PluginSpec::State | state() const |
| virtual QString | url() const |
| virtual QString | vendor() const |
| virtual QString | vendorId() const |
| virtual QString | version() const |
Detaljan opis
Specifikacija dodatka se također popunjava dodatnim informacijama tijekom procesa učitavanja dodatka (vidi PluginSpec::State). Ako dođe do pogreške, specifikacija dodatka je mjesto za traženje detalja o pogrešci.
Dokumentacija o vrsti člana
enum PluginSpec::State
Enum State označava stanja kroz koja prolazi dodatak tijekom učitavanja.
Stanje daje naznaku što je pošlo po zlu u slučaju pogreške.
| Konstanta | Vrijednost | Opis |
|---|---|---|
ExtensionSystem::PluginSpec::Invalid | 0 | Polazna točka: Čak ni metapodaci dodatka nisu pročitani. |
ExtensionSystem::PluginSpec::Read | 1 | Meta-podaci dodatka uspješno su pročitani, a njihove su informacije dostupne putem funkcije PluginSpec. |
ExtensionSystem::PluginSpec::Resolved | 2 | Ovisnosti navedene u datoteci s opisom uspješno su pronađene i dostupne putem funkcije dependencySpecs()". |
ExtensionSystem::PluginSpec::Loaded | 3 | Knjižnica dodatka je učitana i instanca dodatka je stvorena (dostupna putem plugin()). |
ExtensionSystem::PluginSpec::Initialized | 4 | Pozvana je funkcija IPlugin::initialize() instance plugina i vratila je vrijednost uspjeha. |
ExtensionSystem::PluginSpec::Running | 5 | Ovisnosti dodatka su uspješno inicijalizirane i pozvana je funkcija extensionsInitialized. Proces učitavanja je dovršen. |
ExtensionSystem::PluginSpec::Stopped | 6 | Plugin je isključen, tj. pozvana je funkcija IPlugin::aboutToShutdown() plugina. |
ExtensionSystem::PluginSpec::Deleted | 7 | Instanca dodatka je izbrisana. |
Dokumentacija funkcija člana
[virtual] void PluginSpec::addArgument(const QString &argument)
Dodaje argument u argumente naredbenog retka specifične za dodatak.
[virtual] ExtensionSystem::PluginSpec::PluginArgumentDescriptions PluginSpec::argumentDescriptions() const
Vraća popis opisa argumenata naredbenog retka koje dodatak obrađuje.
[virtual] QStringList PluginSpec::arguments() const
Vraća argumente naredbenog retka specifične za dodatak. Postavlja se pri pokretanju.
Vidi također setArguments().
[virtual] QString PluginSpec::category() const
Vraća kategoriju kojoj pripada dodatak. Kategorije se koriste za grupiranje dodataka u korisničkom sučelju. Vraća prazan niz ako dodatak ne pripada nijednoj kategoriji.
[virtual] QString PluginSpec::compatVersion() const
Vraća verziju kompatibilnosti dodatka. Ovo vrijedi nakon što se dosegne stanje ' PluginSpec::Read '.
[virtual] QString PluginSpec::copyright() const
Vraća autorska prava dodatka. Ovo je važeće nakon što se dosegne stanje PluginSpec::Read.
[virtual] QList<ExtensionSystem::PluginDependency> PluginSpec::dependencies() const
Ovisnosti dodatka. Ovo vrijedi nakon što se dosegne stanje " PluginSpec::Read ".
[virtual] QHash<ExtensionSystem::PluginDependency, ExtensionSystem::PluginSpec *> PluginSpec::dependencySpecs() const
Vraća popis ovisnosti, već riješenih prema postojećim specifikacijama dodataka. Valjano je ako je stanje PluginSpec::Resolved postignuto.
Vidi također PluginSpec::dependencies().
[virtual] QString PluginSpec::description() const
Vraća opis dodatka. Ovo je važeće nakon što se dosegne stanje ' PluginSpec::Read '.
[virtual] QString PluginSpec::displayName() const
Vraća DisplayName, name() ili id() ako je name() prazan. Ako su svi prazni, vraća "<unknown>".
[virtual] QString PluginSpec::documentationUrl() const
Vraća URL dokumentacije na kojem možete pronaći online priručnik o dodatku. Ovo vrijedi nakon što se dosegne stanje ' PluginSpec::Read '.
[virtual] QString PluginSpec::errorString() const
Vraća detaljan, moguće višestruki opis pogreške u slučaju pogreške.
[virtual] Utils::FilePath PluginSpec::filePath() const
Vraća apsolutnu putanju do dodatka.
[virtual] bool PluginSpec::hasError() const
Vraća istinu ako je došlo do pogreške tijekom čitanja ili pokretanja dodatka.
[virtual] QString PluginSpec::id() const
Vraća prikazno ime dodatka. Ovo je važeće nakon što se dosegne stanje PluginSpec::Read.
[virtual] bool PluginSpec::isAvailableForHostPlatform() const
Vraća informaciju o tome radi li dodatak na host platformi.
[virtual] bool PluginSpec::isDeprecated() const
Vraća da li je za dodatak postavljena oznaka zastarjelosti.
[virtual] bool PluginSpec::isEffectivelyEnabled() const
Vraća je li dodatak učitano pri pokretanju.
Vidi također isEnabledBySettings().
[virtual] bool PluginSpec::isEnabledByDefault() const
Vraća se da li je dodatak omogućen prema zadanim postavkama. Dodatak može biti onemogućen jer je eksperimentalni ili zastarjeli, ili zato što ga postavke instalacije definiraju kao onemogućeno prema zadanim postavkama.
[virtual] bool PluginSpec::isEnabledBySettings() const
Vraća je li dodatak potrebno učitati pri pokretanju, uzimajući u obzir zadano omogućenje i korisnikove postavke.
Napomena: Ova funkcija može vratiti false čak i ako je dodatak učitan kao zahtjev drugog omogućenog dodatka.
Vidi također isEffectivelyEnabled().
[virtual] bool PluginSpec::isEnabledIndirectly() const
Vraća true ako učitavanje nije izvršeno zbog toga što je korisnik odabrao ukloniti ovaj dodatak ili njegove ovisnosti.
[virtual] bool PluginSpec::isExperimental() const
Vraća da li je za dodatak postavljena eksperimentalna oznaka.
[virtual] bool PluginSpec::isForceDisabled() const
Vraća istinitu vrijednost ako je dodatak onemogućen putem opcije -noload na naredbenom retku.
[virtual] bool PluginSpec::isForceEnabled() const
Vraća istinu ako je dodatak omogućen putem opcije -load na naredbenom retku.
[virtual] bool PluginSpec::isRequired() const
Vraća je li dodatak potreban.
[virtual] bool PluginSpec::isSoftLoadable() const
Vraća istinu ako je dodatku dopušteno da se učita tijekom izvršavanja bez ponovnog pokretanja.
[virtual] QString PluginSpec::license() const
Vraća licencu dodatka. Ovo je važeće nakon što se dosegne stanje PluginSpec::Read.
[virtual] Utils::FilePath PluginSpec::location() const
Vraća apsolutnu putanju do direktorija koji sadrži dodatak.
[virtual] QString PluginSpec::longDescription() const
Vraća dugi opis dodatka. Ovo je važeće nakon što se dosegne stanje ' PluginSpec::Read '.
[virtual] QJsonObject PluginSpec::metaData() const
Vraća metapodatke dodatka.
[virtual] QString PluginSpec::name() const
Vraća naziv dodatka. Ovo je važeće nakon što se dosegne stanje PluginSpec::Read.
[virtual, since 3.0] QRegularExpression PluginSpec::platformSpecification() const
Vraća QRegularExpression koji odgovara platformama na kojima ovaj dodatak radi. Prazan uzorak podrazumijeva sve platforme.
Ova je funkcija uvedena u verziji 3.0.
[virtual] bool PluginSpec::provides(ExtensionSystem::PluginSpec *spec, const ExtensionSystem::PluginDependency &dependency) const
Vraća je li dodatak spec moguće koristiti za popunjavanje dependency ovog dodatka.
Vidi također PluginSpec::dependencies().
[virtual] QStringList PluginSpec::recommends() const
Vraća popis ID-ova dodataka koje se korisniku preporučuje omogućiti ako je ovaj dodatak omogućen. Ovo vrijedi nakon što se dosegne stanje PluginSpec::Read.
[virtual] QSet<ExtensionSystem::PluginSpec *> PluginSpec::recommendsSpecs() const
Vraća popis preporučenih dodataka, već riješenih prema postojećim specifikacijama dodataka. Valjano je ako je stanje PluginSpec::Resolved postignuto.
Vidi također PluginSpec::recommends().
[virtual] bool PluginSpec::requiresAny(const QSet<ExtensionSystem::PluginSpec *> &plugins) const
Vraća istinu ako dodatak zahtijeva bilo koji od dodataka navedenih u plugins.
[virtual] void PluginSpec::setArguments(const QStringList &arguments)
Postavlja argumente naredbenog retka specifične za dodatak na arguments.
Vidi također arguments().
[virtual] void PluginSpec::setEnabledBySettings(bool value)
Postavlja hoće li se dodatak učitati pri pokretanju na value.
Vidi također isEnabledBySettings().
[virtual] ExtensionSystem::PluginSpec::State PluginSpec::state() const
Vraća stanje u kojem se dodatak trenutno nalazi. Pogledajte opis enuma PluginSpec::State za detalje.
[virtual] QString PluginSpec::url() const
Vraća URL dodatka na kojem možete pronaći više informacija o dodatku. Ovo je važeće nakon što se dosegne stanje ' PluginSpec::Read '.
[virtual] QString PluginSpec::vendor() const
Vraća dobavljača dodatka. Ovo je važeće nakon što se dosegne stanje PluginSpec::Read.
[virtual] QString PluginSpec::vendorId() const
Vraća prikazno ime dobavljača dodatka. Ovo je važeće nakon što se dosegne stanje PluginSpec::Read.
[virtual] QString PluginSpec::version() const
Vraća verziju dodatka. Ovo je važeće nakon što se dosegne stanje ' PluginSpec::Read '.
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.
