Core::IEditorFactory Class
class Core::IEditorFactoryKlasa IEditorFactory stvara odgovarajuće uređivače za dokumente prema njihovom MIME tipu. Više...
| Header: | #include <coreplugin/editormanager/ieditorfactory.h> |
Javne funkcije
| Core::IEditor * | createEditor() const |
| QString | displayName() const |
| Utils::Id | id() const |
| QStringList | mimeTypes() const |
| Utils::Result<> | startEditor(const Utils::FilePath &filePath) |
Statični javni članovi
| const Core::EditorFactories | allEditorFactories() |
| const Core::EditorFactories | defaultEditorFactories(const Utils::MimeType &mimeType) |
| const Core::EditorFactories | preferredEditorFactories(const Utils::FilePath &filePath) |
Zaštićene funkcije
| IEditorFactory() | |
| void | addMimeType(const QString &mimeType) |
| void | setDisplayName(const QString &displayName) |
| void | setEditorCreator(const std::function<IEditor *()> &creator) |
| void | setEditorStarter(const std::function<Utils::Result<> (const Utils::FilePath &)> &starter) |
| void | setId(Utils::Id id) |
| void | setMimeTypes(const QStringList &mimeTypes) |
Detaljan opis
Kada korisnik želi uređivati ili stvarati dokument, EditorManager pregledava sve instance IEditorFactory u potrazi za prikladnim urednicima i odabire jednog za stvaranje urednika.
Implementacije bi trebale postaviti svojstva naslijeđene klase IEditorFactory u svom konstruktoru pomoću metoda IEditorFactory::setId(), IEditorFactory::setDisplayName(), IEditorFactory::setMimeTypes() i IEditorFactory::setEditorCreator().
Instance IEditorFactory automatski se registriraju u Qt Creator u svom konstruktoru.
Postoje dvije vrste uređivača: interni i eksterni. Interni uređivači otvaraju se unutar glavnog područja za uređivanje Qt Creator-a. Instance IEditorFactory definiraju interni uređivač pomoću funkcije setEditorCreator(). Eksterni uređivači su vanjske aplikacije i definiraju se pomoću funkcije setEditorStarter(). Korisnik im može pristupiti iz dijaloga Open With.
Vidi također Core::IEditor, Core::IDocument i Core::EditorManager.
Dokumentacija funkcija članova
[protected] IEditorFactory::IEditorFactory()
Stvara IEditorFactory.
Registrira IEditorFactory u Qt Creator u.
[protected] void IEditorFactory::addMimeType(const QString &mimeType)
Dodaje mimeType na popis MIME tipova koje podržava ova vrsta uređivača.
Vidi također mimeTypes() i setMimeTypes().
[static] const Core::EditorFactories IEditorFactory::allEditorFactories()
Vraća sve registrirane interne i eksterne urednike.
Core::IEditor *IEditorFactory::createEditor() const
Stvara interni uređivač.
Koristi funkciju set s setEditorCreator() za stvaranje uređivača.
Vidi također setEditorCreator().
[static] const Core::EditorFactories IEditorFactory::defaultEditorFactories(const Utils::MimeType &mimeType)
Vraća sve dostupne interne i eksterne uređivače za mimeType, u zadanoj redoslijedu: vrste uređivača su poredane prema hijerarhiji MIME tipova, pri čemu su interni uređivači prvo navedeni.
QString IEditorFactory::displayName() const
Vraća korisniku vidljiv opis vrste uređivača.
Vidi također setDisplayName().
Utils::Id IEditorFactory::id() const
Vraća ID tipa dokumenta urednika.
Vidi također setId().
QStringList IEditorFactory::mimeTypes() const
Vraća popis podržanih MIME tipova za ovu vrstu uređivača.
Vidi također addMimeType() i setMimeTypes()
[static] const Core::EditorFactories IEditorFactory::preferredEditorFactories(const Utils::FilePath &filePath)
Vraća dostupne tvornice uređivača za filePath, poredane prema redoslijedu preferencija. To je zadani redoslijed za MIME tip dokumenta, ali s tim da je na prvom mjestu zadani uređivač koji je korisnik prethodno preuzeo, a binarni uređivač je prvi stavak ako je tekstualni dokument prevelik za otvaranje kao tekstualna datoteka.
[protected] void IEditorFactory::setDisplayName(const QString &displayName)
Postavlja displayName tipa uređivača. To je na primjer prikazano u izborniku Open With i u postavkama MIME tipova.
Vidi također displayName().
[protected] void IEditorFactory::setEditorCreator(const std::function<IEditor *()> &creator)
Postavlja funkciju koja se koristi za stvaranje instance uređivača u createEditor() na creator.
Ovo je međusobno isključivo s upotrebom setEditorStarter().
Vidi također createEditor().
[protected] void IEditorFactory::setEditorStarter(const std::function<Utils::Result<> (const Utils::FilePath &)> &starter)
Postavlja funkciju koja se koristi za otvaranje datoteke za zadani FilePath na starter.
Funkcija bi trebala vratiti true pri uspjehu, ili vratiti false i postaviti QString na poruku o pogrešci pri neuspjehu.
Ovo je međusobno isključivo s upotrebom setEditorCreator().
[protected] void IEditorFactory::setId(Utils::Id id)
Postavlja id tipa dokumenta urednika. To mora biti isto kao i IDocument::id() dokumenata koje vraćaju stvoreni urednici.
Vidi također id().
[protected] void IEditorFactory::setMimeTypes(const QStringList &mimeTypes)
Postavlja MIME tipove koje podržava tip uređivača na mimeTypes.
Vidi također addMimeType() i mimeTypes().
Utils::Result<> IEditorFactory::startEditor(const Utils::FilePath &filePath)
Otvara datoteku na filePath u vanjskom uređivaču.
Vraća Utils::ResultOk pri uspjehu ili Utils::ResultError pri neuspjehu.
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.
