Core::ICore Class
class Core::ICoreKlasa ICore omogućuje pristup različitim dijelovima koji čine osnovnu funkcionalnost Qt Creator a. Više...
| Header: | #include <coreplugin/icore.h> |
| Inherits: | QObject |
Javne vrste
| enum class | ContextPriority { High, Low } |
Signali
| void | contextAboutToChange(const QList<Core::IContext *> &context) |
| void | contextChanged(const Core::Context &context) |
| void | coreAboutToClose() |
| void | coreAboutToOpen() |
| void | coreOpened() |
| void | saveSettingsRequested(Core::ICore::SaveSettingsReason reason) |
Statični javni članovi
| void | addAdditionalContext(const Core::Context &context, Core::ICore::ContextPriority priority = ContextPriority::Low) |
| void | addContextObject(Core::IContext *context) |
| void | addPreCloseListener(const std::function<bool ()> &listener) |
| bool | askForRestart(const QString &text, const QString &altButtonText = {}) |
| Utils::FilePath | cacheResourcePath(const QString &rel = {}) |
| QList<Core::IContext *> | contextObjects(QWidget *widget) |
| QList<Core::IContext *> | currentContextObjects() |
| QWidget * | currentContextWidget() |
| QWidget * | dialogParent() |
| bool | enablePlugins(const QSet<ExtensionSystem::PluginSpec *> &plugins) |
| Utils::InfoBar * | infoBar() |
| Utils::FilePath | installerResourcePath(const QString &rel = {}) |
| Core::ICore * | instance() |
| bool | isNewItemDialogRunning() |
| Utils::FilePath | libexecPath(const QString &rel = {}) |
| QMainWindow * | mainWindow() |
| QString | msgShowSettings() |
| QString | msgShowSettingsToolTip() |
| QWidget * | newItemDialog() |
| QPrinter * | printer() |
| void | raiseWindow(QWidget *widget) |
| void | registerWindow(QWidget *window, const Core::Context &context, const Core::Context &actionContext = {}) |
| void | removeAdditionalContext(const Core::Context &context) |
| void | removeContextObject(Core::IContext *context) |
| Utils::FilePath | resourcePath(const QString &rel = {}) |
| void | restart() |
| Utils::QtcSettings * | settings(QSettings::Scope scope = QSettings::UserScope) |
| void | showNewItemDialog(const QString &title, const QList<Core::IWizardFactory *> &factories, const Utils::FilePath &defaultLocation = {}, const QVariantMap &extraVariables = {}) |
| void | showSettings(const Utils::Id page) |
| void | showSettings(const Utils::Id page, Utils::Id item) |
| void | showWarningWithOptions(const QString &title, const QString &text, const QString &details = QString(), Utils::Id settingsId = {}) |
| void | updateAdditionalContexts(const Core::Context &remove, const Core::Context &add, Core::ICore::ContextPriority priority = ContextPriority::Low) |
| QString | userInterfaceLanguage() |
| Utils::FilePath | userResourcePath(const QString &rel = {}) |
| QString | versionString() |
Detaljan opis
Nikada ne biste trebali stvarati podklasu ovog sučelja. Jedinstveni primjerak stvara dodatak Core. Na taj primjerak možete pristupiti iz svog dodatka putem instance().
Dokumentacija o vrsti člana
enum class ICore::ContextPriority
Ovaj enum definira prioritet dodatnih konteksta.
| Konstanta | Vrijednost | Opis |
|---|---|---|
Core::ICore::ContextPriority::High | 0 | Dodatni konteksti koji imaju viši prioritet od konteksta iz instanci Core::IContext. |
Core::ICore::ContextPriority::Low | 1 | Dodatni konteksti koji imaju niži prioritet od konteksta iz instanci Core::IContext. |
Vidi također Core::ICore::updateAdditionalContexts().
Dokumentacija funkcija člana
[static] void ICore::addAdditionalContext(const Core::Context &context, Core::ICore::ContextPriority priority = ContextPriority::Low)
Dodaje context s priority na popis aktivnih dodatnih konteksta.
Vidi također updateAdditionalContexts().
[static] void ICore::addContextObject(Core::IContext *context)
Dodaje context na popis registriranih instanci IContext. Kad god je widget IContext -a u roditeljskoj hijerarhiji fokusa aplikacije, njegov context se dodaje na popis aktivnih konteksta.
Vidi također removeContextObject(), updateAdditionalContexts(), currentContextObjects(), i Upravitelj akcija i naredbe.
[static] void ICore::addPreCloseListener(const std::function<bool ()> &listener)
Omogućuje plug-inima kukicu za veto pri zatvaranju aplikacije.
Kada prozor aplikacije zatraži zatvaranje, pozivaju se svi slušači. Ako jedan od poziva listener vrati false, proces se prekida i događaj se zanemaruje. Ako svi pozivi vrate true, emitira se coreAboutToClose() i događaj se prihvaća ili izvršava.
[static] bool ICore::askForRestart(const QString &text, const QString &altButtonText = {})
Prikazuje modalni dijalog koji korisnika pita želi li ponovno pokrenuti Qt Creator.
Koristi text kao glavni tekst u dijalogu i pokreće ponovno pokretanje Qt Creator ako korisnik odabere gumb Restart Now.
Dijalog također ima gumb Later. Da biste promijenili tekst gumba Later, postavite altButtonText.
Vraća true ako korisnik odabere Restart Now.
[static] Utils::FilePath ICore::cacheResourcePath(const QString &rel = {})
Vraća zapisivi put za relativni put rel koji se može koristiti za trajne datoteke predmemorije.
[signal] void ICore::contextAboutToChange(const QList<Core::IContext *> &context)
Ukazuje da će novi context uskoro postati trenutni kontekst (što znači da je njegov widget dobio fokus).
[signal] void ICore::contextChanged(const Core::Context &context)
Ukazuje da je novi context upravo postao trenutni kontekst. To uključuje kontekst iz fokusiranog objekta kao i dodatni kontekst.
[static] QList<Core::IContext *> ICore::contextObjects(QWidget *widget)
Vraća sve registrirane primjerke klase IContext za navedeni widget, ako postoje.
[signal] void ICore::coreAboutToClose()
Omogućuje dodatcima izvođenje nekih radnji prije kraja životnog vijeka.
Primjena je zajamčeno zatvorena nakon što se ovaj signal emitira. Nalazi se kao dodatak uobičajenim funkcijama životnog ciklusa dodataka, naime IPlugin::aboutToShutdown(), samo radi praktičnosti.
[signal] void ICore::coreAboutToOpen()
Pokazuje da su svi dodatci učitani i da će se glavni prozor uskoro prikazati.
[signal] void ICore::coreOpened()
Pokazuje da su svi dodatci učitani i da je glavni prozor prikazan.
[static] QList<Core::IContext *> ICore::currentContextObjects()
Vraća listu IContext-ova za trenutni kontekstni widget najviše razine ili praznu listu ako takav ne postoji.
Vidi također updateAdditionalContexts(), addContextObject(), i The Action Manager and Commands.
[static] QWidget *ICore::currentContextWidget()
Vraća widget najviše razine IContext -a trenutnog konteksta ili nullptr ako ga nema.
Vidi također currentContextObjects().
[static] QWidget *ICore::dialogParent()
Vraća pokazivač widgeta prikladan za korištenje kao roditelj za QDialoge.
Posebno je za modalne dijaloge važno koristiti trenutni modalni dijalog kao roditelja (ako postoji) za novi dijalog, jer bi se inače novi dijalog mogao otvoriti iza starog, a pritom blokirati interakciju s njim. Korištenje dialogParent() to osigurava.
Također koristite dialogParent() za nemodalne dijaloge kojima nije potrebno nikakvo specifično upravljanje životnim vijekom. Ako trebate kontrolirati životni vijek nemodalnog dijaloga (na primjer zato što drugi dio aplikacije ovisi o njemu), umjesto toga upotrijebite specifičnijeg roditelja.
[static] bool ICore::enablePlugins(const QSet<ExtensionSystem::PluginSpec *> &plugins)
Pita korisnika želi li omogućiti plug-inove za " plugins " i njihove ovisnosti. Ako korisnik pristane, plug-inovi se omogućuju. Ako su svi plug-inovi soft-loadable bez ponovnog pokretanja, oni se odmah učitaju. U suprotnom se prikazuje dijalog "Potrebno ponovno pokretanje".
Vraća je li korisnik pristao na omogućavanje dodataka.
[static] Utils::InfoBar *ICore::infoBar()
Vraća središnju InfoBar traku koja se prikazuje u glavnom prozoru aplikacije Qt Creator. Koristi se za obavještavanje korisnika o nečemu bez prekidanja dijalogom. Koristite štedljivo.
[static] Utils::FilePath ICore::installerResourcePath(const QString &rel = {})
Vraća putanju, temeljenu na relativnoj putanji rel, do resursa koje je napisao instalator, na primjer unaprijed definirane komplete i alate za izgradnju.
[static] Core::ICore *ICore::instance()
Vraća pokazivač na instancu. Koristi se samo za povezivanje sa signalima.
[static] bool ICore::isNewItemDialogRunning()
Vraća da li je dijalog za novi element trenutno otvoren.
[static] Utils::FilePath ICore::libexecPath(const QString &rel = {})
Vraća putanju, na temelju relativne putanje rel, do alata naredbenog retka koji su uključeni u instalaciju Qt Creator.
[static] QMainWindow *ICore::mainWindow()
Vraća glavni prozor aplikacije.
Za roditeljske prozore dijaloga upotrijebite dialogParent().
Vidi također dialogParent().
[static] QString ICore::msgShowSettings()
Vraća tekst koji se koristi na gumbima za otvaranje načina postavki.
Vidi također showSettings() i msgShowOptionsDialogToolTip().
[static] QString ICore::msgShowSettingsToolTip()
Vraća alatnu napomenu za gumbe koji otvaraju način postavki.
Vidi također showSettings() i msgShowOptionsDialog().
[static] QWidget *ICore::newItemDialog()
Vraća trenutno otvoreni widget dijaloga za novi element, ili nullptr ako ga nema.
Vidi također isNewItemDialogRunning() i showNewItemDialog().
[static] QPrinter *ICore::printer()
Vraća objekt pisača aplikacije.
Uvijek koristite ovaj objekt pisača za ispis kako bi različiti dijelovi aplikacije ponovno koristili njegove postavke.
[static] void ICore::raiseWindow(QWidget *widget)
Pokreće i aktivira prozor za widget. Ovo sadrži zaobilazna rješenja za X11.
[static] void ICore::registerWindow(QWidget *window, const Core::Context &context, const Core::Context &actionContext = {})
Registrira window s navedenim context. Registrirani prozori prikazuju se u izborniku Window i registriraju se za različite radnje vezane uz prozor, poput minimiziranja, zumiranja, prikaza u punom zaslonu i zatvaranja. Kontekst za te radnje prema zadanim postavkama je context, ali se može nadjačati pomoću actionContext.
Kad god je fokus aplikacije u window, njegova context postaje aktivna.
[static] void ICore::removeAdditionalContext(const Core::Context &context)
Uklanja context s popisa aktivnih dodatnih konteksta.
Vidi također updateAdditionalContexts().
[static] void ICore::removeContextObject(Core::IContext *context)
Odjava context objekta s popisa registriranih instanci IContext. Instanci IContext automatski se uklanjaju kada se izbrišu.
Vidi također addContextObject(), updateAdditionalContexts(), i currentContextObjects().
[static] Utils::FilePath ICore::resourcePath(const QString &rel = {})
Vraća apsolutnu putanju za relativnu putanju rel, koja se koristi za resurse poput predložaka projekata i makroa otklanjanja pogrešaka.
Ova apstrakcija je potrebna kako bi se izbjegao platformski specifični kod posvuda, budući da su na macOS-u, na primjer, resursi dio paketa aplikacije.
Vidi također userResourcePath().
[static] void ICore::restart()
Ponovno pokreće Qt Creator i vraća posljednju sesiju.
[signal] void ICore::saveSettingsRequested(Core::ICore::SaveSettingsReason reason)
reasonSignalizira da je korisnik zatražio spremanje globalnih postavki na disk za buduću upotrebu.
Save AllTrenutno se to događa kada se aplikacija zatvori i pri zatvaranju aplikacije.
[static] Utils::QtcSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope)
Vraća glavni objekt postavki aplikacije.
Možete ga koristiti za dohvaćanje ili postavljanje postavki za cijelu aplikaciju (za razliku od postavki specifičnih za sesiju ili projekt).
Ako je scope postavljen na QSettings::UserScope (po zadanom), postavke će se pročitati iz korisnikovih postavki, a kao rezervna opcija koristit će se globalne postavke iz Qt Creator.
Ako je scope postavljen na QSettings::SystemScope, očit će se samo postavke instalacije isporučene s trenutnom verzijom Qt Creator. Ova funkcionalnost postoji samo za interne svrhe.
[static] void ICore::showNewItemDialog(const QString &title, const QList<Core::IWizardFactory *> &factories, const Utils::FilePath &defaultLocation = {}, const QVariantMap &extraVariables = {})
Otvara dijalog u kojem korisnik može odabrati iz skupa factories a koji stvaraju nove datoteke ili projekte.
Argument title prikazuje se kao naslov dijaloga. Putanja na kojoj će se datoteke stvoriti (ako je korisnik ne promijeni) postavljena je u defaultLocation. Zadano je DocumentManager::projectsDirectory() ili DocumentManager::fileDialogLastVisitedDirectory(), ovisno o vrsti čarobnjaka.
Dodatne varijable za čarobnjake postavljaju se u extraVariables.
Vidi također Core::DocumentManager, isNewItemDialogRunning() i newItemDialog().
[static] void ICore::showSettings(const Utils::Id page)
Otvara način postavki na navedenom page u.
Vidi također msgShowOptionsDialog () i msgShowOptionsDialogToolTip().
[static] void ICore::showSettings(const Utils::Id page, Utils::Id item)
Otvara način postavki na navedenom page u. Zadana vrijednost parent a dijaloga je dialogParent(). Ako je dijalog već prikazan kada se ova metoda pozove, on se jednostavno prebaci na navedeni page. Unaprijed odabire dio dijaloga definiran item jem, za koji dijalog zna kako ga interpretirati.
Vidi također msgShowOptionsDialog () i msgShowOptionsDialogToolTip().
[static] void ICore::showWarningWithOptions(const QString &title, const QString &text, const QString &details = QString(), Utils::Id settingsId = {})
Stvara okvir za poruke s parent koji sadrži gumb Configure za otvaranje stranice s postavkama koju odredi settingsId.
Dijalog ima title i prikazuje poruku text te detaljne informacije specificirane u details.
Koristite ovu funkciju za prikaz konfiguracijskih pogrešaka i usmjeravanje korisnika na postavku koju trebaju ispraviti.
Vidi također showSettings().
[static] void ICore::updateAdditionalContexts(const Core::Context &remove, const Core::Context &add, Core::ICore::ContextPriority priority = ContextPriority::Low)
Uklanja kontekste navedene u remove s popisa aktivnih dodatnih konteksta i dodaje kontekste navedene u add s priority.
Dodatni konteksti nisu povezani s instancom IContext.
Dodatni konteksti visokog prioriteta imaju viši prioritet od konteksta koje dodaju instanče IContext, a dodatni konteksti niskog prioriteta imaju niži prioritet od konteksta koje dodaju instanče IContext.
Vidi također addContextObject() i The Action Manager and Commands.
[static] QString ICore::userInterfaceLanguage()
Vraća niz lokala za jezik korisničkog sučelja koji je trenutačno konfiguriran u Qt Creator. Koristite ovo za instaliranje datoteke prijevoda vašeg dodatka pomoću QTranslator.
[static] Utils::FilePath ICore::userResourcePath(const QString &rel = {})
Vraća apsolutnu putanju za relativnu putanju rel u korisnikovom direktoriju koja se koristi za resurse poput predložaka projekata.
Koristite ovu funkciju za pronalaženje mjesta za resurse na koje korisnik može pisati, na primjer za prilagođene palete ili predloške.
Vidi također resourcePath().
[static] QString ICore::versionString()
Vraća niz s nazivom i verzijom IDE-a, u obliku "Qt Creator X.Y.Z". Koristite ga za nize "Generated by" i slične zadatke.
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.