Core::Command Class
class Core::CommandKlasa Command predstavlja radnju, poput stavke izbornika, gumba alata ili prečaca. Više...
| Header: | #include <coreplugin/actionmanager/command.h> |
| Inherits: | QObject |
Javne vrste
| enum | CommandAttribute { CA_UpdateText, CA_UpdateIcon, CA_Hide, CA_NonConfigurable } |
| flags | CommandAttributes |
Javne funkcije
| QAction * | action() const |
| void | augmentActionWithShortcutToolTip(QAction *a) const |
| Core::Context | context() const |
| QList<QKeySequence> | defaultKeySequences() const |
| QString | description() const |
| bool | hasAttribute(Core::Command::CommandAttribute attribute) const |
| bool | isActive() const |
| bool | isScriptable() const |
| QKeySequence | keySequence() const |
| QList<QKeySequence> | keySequences() const |
| void | removeAttribute(Core::Command::CommandAttribute attribute) |
| void | setAttribute(Core::Command::CommandAttribute attribute) |
| void | setDefaultKeySequence(const QKeySequence &key) |
| void | setDefaultKeySequences(const QList<QKeySequence> &keys) |
| void | setDescription(const QString &text) |
| void | setTouchBarIcon(const QIcon &icon) |
| void | setTouchBarText(const QString &text) |
| QString | stringWithAppendedShortcut(const QString &string) const |
| QIcon | touchBarIcon() const |
| QString | touchBarText() const |
Signali
| void | activeStateChanged() |
| void | keySequenceChanged() |
Statični javni članovi
| QAction * | createActionWithShortcutToolTip(Utils::Id commandId, QObject *parent) |
| QToolButton * | createToolButtonWithShortcutToolTip(Utils::Id commandId, QWidget *parent = nullptr) |
| QToolButton * | toolButtonWithAppendedShortcut(QAction *action, Core::Command *cmd) |
| QToolButton * | toolButtonWithAppendedShortcut(QAction *action, Utils::Id commandId) |
Detaljan opis
Ne stvarate objekte naredbe izravno, već koristite ActionManager::registerAction() za registraciju akcije i dohvaćanje naredbe. Objekt naredbe predstavlja korisniku vidljivu akciju i njezina svojstva. Ako je više akcija registrirano s istim ID-om (ali u različitim kontekstima), vraćena naredba je ona zajednička za te akcije.
Command objekt ima dvije osnovne svojstva: popis zadaničkih prečaca i zadanički tekst. Zadanički prečaci su niz tipki koje korisnik može koristiti za pokretanje aktivne radnje koju Command objekt predstavlja. Prvi prečac na tom popisu je glavni prečac koji se, na primjer, prikazuje i u skočnim objašnjenjima i izbornicima. Zadanički tekst koristi se za predstavljanje Command objekta u odjeljku za postavke zadaničkih prečaca na tipkovnici. Ako je zadanički tekst prazan, koristi se tekst vidljive radnje.
Vidljiva akcija korisniku ažurira se kako bi prikazala stanje aktivne akcije (ako postoji). Međutim, iz razloga performansi prema zadanim postavkama uzimaju se u obzir samo omogućeno i vidljivo stanje. Naredbi možete reći da ažurira i ikonu i tekst akcije postavljanjem odgovarajućeg attribute-a.
Ako nema aktivne radnje, zadano ponašanje vidljive radnje jest da bude onemogućeno. To ponašanje možete promijeniti tako da se vidljiva radnja umjesto toga sakrije putem attributes-a naredbe.
Pogledajte odjeljak The Action Manager and Commands za pregled interakcije između Core::Command i Core::ActionManager.
Vidi također Core::ActionManager i The Action Manager and Commands.
Dokumentacija o tipu člana
enum Command::CommandAttribute zastavice
atributa Command::CommandAttributes
Ovaj enum definira kako se ažurira akcija vidljiva korisniku kada se promijeni aktivna akcija. Zadano se ažuriraju stanja omogućenosti i vidljivosti te se onemogućuje akcija vidljiva korisniku kada nema aktivne akcije.
| Konstanta | Vrijednost | Opis |
|---|---|---|
Core::Command::CA_UpdateText | 2 | Također ažurirajte tekst akcije. |
Core::Command::CA_UpdateIcon | 4 | Također ažurirajte ikonu akcije. |
Core::Command::CA_Hide | 1 | Kada nema aktivne radnje, sakrij radnju vidljivu korisniku, umjesto da je samo onemogućiš. |
Core::Command::CA_NonConfigurable | 8 | Zastavica koja označava da korisnik ne bi trebao moći konfigurirati prečace na tipkovnici ove naredbe. |
Tip CommandAttributes je typedef za QFlags<CommandAttribute>. Pohranjuje OR kombinaciju vrijednosti CommandAttribute.
Dokumentacija članovskih funkcija
QAction *Command::action() const
Vraća korisniku vidljivu akciju za ovu naredbu. Koristite ovu akciju da biste je postavili na, npr., gumbe alata. Akcija automatski prosljeđuje signale triggered() i toggled() akciji koja je trenutno aktivna za ovu naredbu. Također prikazuje trenutni glavni prečac na tipkovnici u svom alatkastom napomenci (uz napomenku aktivne akcije) i onemogućuje se/skriva kada za trenutni kontekst nema aktivne akcije.
[signal] void Command::activeStateChanged()
Ovaj signal se emitira kada se promijeni aktivno stanje naredbe.
void Command::augmentActionWithShortcutToolTip(QAction *a) const
Postavlja alatni natpis akcije a na tekst akcije, dopunjen glavnim tipkovničkim prečacem naredbe. Alatni natpis se automatski ažurira kad god se promijeni glavni tipkovnički prečac ili tekst akcije.
Vidi također stringWithAppendedShortcut() i createActionWithShortcutToolTip().
Core::Context Command::context() const
Vraća kontekst ove naredbe.
[static] QAction *Command::createActionWithShortcutToolTip(Utils::Id commandId, QObject *parent)
Vraća novi QAction s ikonom naredbe, tekstom ikone i tekstom koje je dao commandId. Postavlja roditelja gumba na parent. Alatni savjet akcije je tekst akcije proširen glavnim tipkovničkim prečacem naredbe. Ostala svojstva akcije se ne ažuriraju automatski.
Vidi također augmentActionWithShortcutToolTip().
[static] QToolButton *Command::createToolButtonWithShortcutToolTip(Utils::Id commandId, QWidget *parent = nullptr)
Vraća novu QToolButton s ikonom naredbe, tekstom ikone i tekstom koje je dao commandId. Postavlja roditelja gumba na parent. Alatni savjet akcije je tekst akcije, dopunjen glavnim tipkovničkim prečacem naredbe. Ostala svojstva gumba se ne ažuriraju automatski.
Vidi također createActionWithShortcutToolTip().
QList<QKeySequence> Command::defaultKeySequences() const
Vraća zadane prečace na tipkovnici koji se mogu koristiti za aktiviranje ove naredbe.
Vidi također setDefaultKeySequences().
QString Command::description() const
Vraća tekst koji se koristi za prikaz ove naredbe korisniku.
Vidi također setDescription().
bool Command::hasAttribute(Core::Command::CommandAttribute attribute) const
Vraća informaciju o tome ima li naredba postavljenu opciju attribute.
Vidi također CommandAttribute, removeAttribute() i setAttribute().
bool Command::isActive() const
Vraća istinito ako naredba ima aktivno djelovanje za trenutni kontekst.
bool Command::isScriptable() const
Vraća se da li je naredba skriptabilna. Skriptabilna naredba može se pozvati iz skripte bez potrebe za korisničkom interakcijom.
QKeySequence Command::keySequence() const
Vraća trenutnu glavnu tipkovničku prečacu dodijeljenu ovoj naredbi.
Vidi također defaultKeySequences().
[signal] void Command::keySequenceChanged()
Pošalji kada se promijene prečaci na tipkovnici dodijeljeni ovoj naredbi, npr. kada ih korisnik postavi u dijalogu za postavke prečaca na tipkovnici.
QList<QKeySequence> Command::keySequences() const
Vraća trenutne prečace na tipkovnici dodijeljene ovoj naredbi.
Vidi također defaultKeySequences().
void Command::removeAttribute(Core::Command::CommandAttribute attribute)
Uklanja attribute iz atributa ove naredbe.
Vidi također CommandAttribute i setAttribute().
void Command::setAttribute(Core::Command::CommandAttribute attribute)
Dodaje attribute u atribute ove naredbe.
Vidi također CommandAttribute, removeAttribute(), i hasAttribute().
void Command::setDefaultKeySequence(const QKeySequence &key)
Postavlja zadanu tipkovničku prečacu za aktivaciju ove naredbe na key. Ovo se koristi ako korisnik nije prilagodio prečacu ili vraća prečacu na zadano.
void Command::setDefaultKeySequences(const QList<QKeySequence> &keys)
Postavlja zadane tipkovničke prečace za aktivaciju ove naredbe na keys. Ovo se koristi ako korisnik nije prilagodio prečace ili vraća prečace na zadane.
Vidi također defaultKeySequences().
void Command::setDescription(const QString &text)
Postavlja text koji se koristi za predstavljanje naredbe u dijalogu za postavke prečaca na tipkovnici. Ako ovo ne postavite, uzet će se trenutni tekst vidljive radnje korisniku (što je u mnogim slučajevima u redu).
Vidi također description().
void Command::setTouchBarIcon(const QIcon &icon)
Postavlja ikonu radnje na touch bar na icon.
Vidi također touchBarIcon().
void Command::setTouchBarText(const QString &text)
Postavlja tekst radnje na touch bar na text.
Vidi također touchBarText().
QString Command::stringWithAppendedShortcut(const QString &string) const
Vraća naredbu string, uz pripojenu notaciju glavnog prečaca tipkovnice koji je trenutno dodijeljen ovoj naredbi.
[static] QToolButton *Command::toolButtonWithAppendedShortcut(QAction *action, Core::Command *cmd)
Vraća gumb alata za action.
Dodaje glavnu tipkovničku prečacu cmd u alatni savjet radnje.
[static] QToolButton *Command::toolButtonWithAppendedShortcut(QAction *action, Utils::Id commandId)
Vraća gumb alata za naredbu action.
Dodaje glavnu tipkovničku prečacu naredbe s ID-om commandId u pomoćni natpis gumba.
QIcon Command::touchBarIcon() const
Vraća ikonu za akciju na touch bar.
Vidi također setTouchBarIcon().
QString Command::touchBarText() const
Vraća tekst za akciju na touch bar.
Vidi također setTouchBarText().
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.