Core::IDocument Class

Dokumentacija funkcija člana

IDocument::IDocument(QObject *parent = nullptr)

Stvara IDocument pomoću parent.

[override virtual noexcept] IDocument::~IDocument()

Uništava IDocument. Ako je za ovaj dokument postojala automatski spremljena datoteka, ona se uklanja.

Vidi također shouldAutoSave().

[signal] void IDocument::aboutToReload()

Ovaj signal se emitira prije ponovnog učitavanja dokumenta iz pozadinske datoteke.

Vidi također reload().

[signal] void IDocument::aboutToSave(const Utils::FilePath &filePath, Core::IDocument::SaveOption option)

Ovaj signal se emitira prije spremanja dokumenta u filePath s opcijom spremanja option.

Vidi također save().

[signal] void IDocument::changed()

Ovaj signal se emitira kada se promijene metapodaci dokumenta, poput naziva datoteke ili stanja izmjene.

Vidi također isModified(), filePath(), i displayName().

void IDocument::checkPermissions()

Ažurira keširane informacije o statusu samo za čitanje pozadinske datoteke.

[virtual] QByteArray IDocument::contents() const

Vraća trenutni sadržaj dokumenta. Zadana implementacija vraća praznu QByteArray.

Vidi također setContents() i contentsChanged().

[signal] void IDocument::contentsChanged()

Ovaj signal se emitira kada se sadržaj dokumenta promijeni.

Vidi također contents().

QString IDocument::displayName() const

Vraća niz znakova za prikaz ovog dokumenta, na primjer u prikazu e Open Documents a i u padajućem izborniku dokumenata.

Prikazano ime je jedno od sljedećih, redom:

1. Jedinstveno prikazno ime postavlja model dokumenta
2. Preferirano prikazno ime postavljeno od strane vlasnika
3. Osnovno ime naziva datoteke dokumenta

Vidi također setPreferredDisplayName(), filePath(), i changed().

[virtual] QString IDocument::fallbackSaveAsFileName() const

Vraća naziv datoteke koji će se koristiti u dijaloškom okviru za odabir datoteke Save As ako dokument nije podržan datotekom.

Vidi također fallbackSaveAsPath().

[virtual] Utils::FilePath IDocument::fallbackSaveAsPath() const

Vraća putanju za dijalog za datoteku Save As u slučaju da dokument nije podržan datotekom.

Vidi također fallbackSaveAsFileName().

const Utils::FilePath &IDocument::filePath() const

Vraća apsolutnu putanju datoteke na koju se ovaj dokument poziva. Može biti prazna za dokumente koji nemaju podršku datoteke.

Vidi također setFilePath().

[signal] void IDocument::filePathChanged(const Utils::FilePath &oldName, const Utils::FilePath &newName)

Ovaj signal se emitira nakon što je putanja datoteke promijenjena iz oldName u newName.

Vidi također filePath().

[virtual] void IDocument::formatContents()

Formatira sadržaj dokumenta, ako implementacija podržava takvu funkcionalnost.

Utils::Id IDocument::id() const

Vraća ID za ovu vrstu dokumenta.

Vidi također setId().

Utils::InfoBar *IDocument::infoBar()

Vraća Utils::InfoBar dokumenta, koji se prikazuje na vrhu uređivača.

bool IDocument::isFileReadOnly() const

Vraća 'true' ako je datoteka koja podržava ovaj dokument samo za čitanje, ili ' false ' ako dokument nije podržan datotekom.

[virtual] bool IDocument::isModified() const

Vraća je li dokument izmijenjen nakon što je učitano iz datoteke.

Zadana implementacija vraća false. Ponovne implementacije trebaju emitirati changed() kada se ova svojina promijeni.

Vidi također changed().

[virtual] bool IDocument::isSaveAsAllowed() const

Vraća je li dokument moguće spremiti pod drugim nazivom datoteke.

Zadana implementacija vraća false.

Vidi također save().

bool IDocument::isSuspendAllowed() const

Vraća je li dokument moguće suspendirati.

EditorManager može automatski suspendirati uređivače i pripadajuće dokumente ako je dokument podržan datotekom, nije izmijenjen i nije privremen. Suspenzirane instance IEditor i IDocument brišu se i uklanjaju iz memorije, ali su i dalje vidljivo dostupne kao da je dokument još uvijek otvoren u Qt Creator.

Zadano je false.

Vidi također setSuspendAllowed(), isModified(), i isTemporary().

bool IDocument::isTemporary() const

Vraća se ako je dokument privremen i, na primjer, ne bi se trebao uzeti u obzir pri spremanju ili vraćanju stanja sesije ili dodavati na popis nedavnih datoteka.

Zadano je false.

Vidi također setTemporary().

QString IDocument::mimeType() const

Vraća MIME tip sadržaja dokumenta, ako je primjenjivo.

Podklase bi to trebale postaviti pomoću setMimeType() nakon postavljanja ili učitavanja sadržaja.

Zadani MIME tip je prazan.

Vidi također setMimeType() i mimeTypeChanged()

[signal] void IDocument::mimeTypeChanged()

Ovaj signal se emitira kada se promijeni MIME tip sadržaja dokumenta.

Vidi također mimeType().

[virtual] Utils::Result<> IDocument::open(const Utils::FilePath &filePath, const Utils::FilePath &realFilePath)

Metoda open() služi za učitavanje sadržaja datoteke kada se dokument otvori u uređivaču.

Ako se dokument otvori iz automatski spremljene datoteke, realFilePath je naziv automatski spremljene datoteke koja se treba učitati, a filePath je naziv rezultirajuće datoteke. U tom slučaju treba učitati sadržaj automatski spremljene datoteke, naziv datoteke IDocument treba postaviti na filePath i stanje dokumenta postaviti na modificirano.

Ako se uređivač otvori iz obične datoteke, filePath i filePath su ista.

Vraća informaciju je li datoteka uspješno otvorena i pročitana.

Zadana implementacija ne radi ništa i vraća CannotHandle.

Vidi također EditorManager::openEditor(), shouldAutoSave(), i setFilePath().

QString IDocument::preferredDisplayName() const

Vraća preferirano ime za prikaz ovog dokumenta.

Zadano preferirano prikazno ime je prazno, što znači da je prikazno ime poželjno ime datoteke koja podržava ovaj dokument.

Vidi također setPreferredDisplayName() i displayName().

[virtual] Utils::Result<> IDocument::reload(Core::IDocument::ReloadFlag flag, Core::IDocument::ChangeType type)

Ponovno učitava dokument iz pozadinske datoteke kada se ona promijenila na disku.

Ako je flag FlagIgnore , datoteka zapravo ne bi trebala biti učitana, ali dokument bi trebao odražavati promjenu u svom modified state u.

type određuje je li promijenjena samo dozvola datoteke ili je promijenjen njezin sadržaj.

Vraća se ako je datoteka uspješno ponovno učitana.

Zadana implementacija ne radi ništa i vraća true.

Podklase bi trebale pozvati aboutToReload() prije i reloadFinished() nakon ponovnog učitavanja datoteke.

Vidi također isModified(), aboutToReload(), reloadFinished(), i changed().

[virtual] Core::IDocument::ReloadBehavior IDocument::reloadBehavior(Core::IDocument::ChangeTrigger trigger, Core::IDocument::ChangeType type) const

Metoda reloadBehavior() koristi se u DocumentManager u kako bi se upitala što učiniti ako se datoteka koja podržava ovaj dokument promijenila na disku.

trigger navodi je li promjenu pokrenula neka operacija u Qt Creator. type navodi je li se dozvole ili sadržaj datoteke promijenio ili je datoteka potpuno izbrisana.

Vraća vrijednost koja označava treba li se korisnika pitati ili dokument tiho ponovno učitati.

Zadana implementacija traži tiho ponovno učitavanje ako su promijenjene samo dozvole ili ako se promijenio sadržaj, ali je trigger interna i dokument nije izmijenjen.

Vidi također isModified().

[signal] void IDocument::reloadFinished(bool success)

Ovaj signal se emitira nakon ponovnog učitavanja dokumenta iz pozadinske datoteke ili ako je ponovno učitavanje propalo.

Stanje uspjeha prosljeđuje se u success.

Vidi također reload().

Utils::Result<> IDocument::save(const Utils::FilePath &filePath = {}, Core::IDocument::SaveOption option = SaveOption::None)

Sprema sadržaj dokumenta na disk u filePath. Ako je filePath prazan, koristi se filePath().

Ako je option SaveOption::AutoSave , spremanje se obavlja kao automatsko spremanje, pa dokument ne bi trebao izvršavati čišćenja ili druge operacije koje obavlja pri ručnom spremanju na zahtjev korisnika.

Ako je option postavljen na SaveOption::DisableFormatOnSave, dokument se treba spremiti normalno, ali se ne bi smjela izvršiti nikakva aktivnost tipa "Formatiranje pri spremanju".

Vraća je li spremanje bilo uspješno.

Ako je spremanje bilo uspješno, emitira se 'saved'.

Vidi također shouldAutoSave(), aboutToSave(), saved(), i filePath().

[virtual protected] Utils::Result<> IDocument::saveImpl(const Utils::FilePath &filePath = {}, Core::IDocument::SaveOption option = SaveOption::None)

Implementacija spremanja sadržaja dokumenta u filePath na disk.

Ako je option postavljena na SaveOption::AutoSave, spremanje se vrši kao automatsko spremanje, pa dokument ne bi trebao izvršavati čišćenja ili druge operacije koje se obavljaju pri ručnom spremanju na zahtjev korisnika.

Ako je option postavljen na SaveOption::DisableFormatOnSave, dokument bi se trebao spremiti normalno, ali ne bi se smjela izvršiti nikakva aktivnost tipa "Formatiranje pri spremanju".

Vraća informaciju o uspješnosti spremanja, uključujući poruku o pogrešci ako spremanje nije bilo uspješno.

Zadana implementacija ne radi ništa i vraća false.

[signal] void IDocument::saved(const Utils::FilePath &filePath, Core::IDocument::SaveOption option)

Ovaj signal se emitira nakon što je dokument spremljen u filePath s opcijom spremanja option.

Vidi također save().

[virtual] Utils::Result<> IDocument::setContents(const QByteArray &contents)

Metoda setContents() se na primjer koristi u metodi EditorManager::openEditorWithContents() za postavljanje contents a ovog dokumenta.

Vraća je li postavljanje sadržaja bilo uspješno.

Zadana implementacija ne radi ništa i vraća false.

Vidi također contents() i EditorManager::openEditorWithContents().

[virtual] void IDocument::setFilePath(const Utils::FilePath &filePath)

Postavlja apsolutnu filePath datoteke koja podržava ovaj dokument. Zadana implementacija postavlja naziv datoteke i šalje signale filePathChanged() i changed()

Vidi također filePath(), filePathChanged() i changed().

void IDocument::setId(Utils::Id id)

Postavlja ID za ovu vrstu dokumenta na id. To je povezano s odgovarajućom implementacijom IEditor i id() u IEditorFactory. Ako implementacija IDocument radi samo s jednom vrstom IEditor, to se po mogućnosti postavlja u konstruktoru IDocumentsa.

Vidi također id().

void IDocument::setMimeType(const QString &mimeType)

Postavlja MIME tip sadržaja dokumenta na mimeType.

Vidi također mimeType().

void IDocument::setPreferredDisplayName(const QString &name)

Postavlja preferirani prikaz name za ovaj dokument.

Vidi također preferredDisplayName() i displayName().

void IDocument::setSuspendAllowed(bool value)

Postavlja hoće li dokument biti suspendiran na value.

Vidi također isSuspendAllowed().

void IDocument::setTemporary(bool temporary)

Postavlja je li dokument temporary.

Vidi također isTemporary().

[virtual] bool IDocument::shouldAutoSave() const

Vraća je li dokument automatski spremiti u korisniku definiranom intervalom.

Zadana implementacija vraća false.