Sfairadora

  • Referenční příručka

Document_settings

Typ položky document.settings. Odpovídá sekci dokumentu Nastavení.
Typ složky
Název složky
Popis
Byte
document_type
Druh dokumentu. Jedna z konstant:
DOCUMENT_TYPE_STANDARD
běžný dokument.
DOCUMENT_TYPE_SINGLE
DOCUMENT_TYPE_TEMPLATE
DOCUMENT_TYPE_TOOL_SET
DOCUMENT_TYPE_FILE_MANIPULATOR
Atom optional
parent_data_id
Identifikátor nadřazeného dokumentu. Pokud není zadán, použije se "master".
String const
file_name
Plné jméno souboru, do kterého je dokumentu uložen. (Jen ke čtení).
(viz níže) optional
file_manipulator_info
Pokud je dokument souborový manipulátor, zde jsou doplňující informace.
Enki optional
on_load
Funkce synchronně vyvolaná po načtení dokumentu ze souboru.
Enki optional
program
Funkce asynchronně vykonávaná zatímco je dokumentu otevřen.
Enki optional
on_close
Funkce synchronně vyvolaná před zavřením dokumentu.
Enki optional
updater
Interní položka.
Bool
main_window_principal
Zavřením hlavního okna se zavře celý dokument.
code_page
Kódová stránka pro kódování znaků v dokumentu.
language
Jazyk dokumentu. Viz konstanty pro jazyky.
Seq(style) unicity: name
styles
Tabulka stylů dokumentu. Odpovídá oknu Styly formátování textu.
Prvky sekvence jsou pojmenovány názvy stylů, takže lze psát například:
document.settings.styles.display_label_text
(display_label_text je název stylu, kterým se standardně vykreslují popisky v oknech.)
viz stránku page
page
Definice rozměrů stránky pro tisk textů z dokumentu.
viz stránku signs
signs
Nastavení symbolů.

file_manipulator_info

Typ složky
Název složky
Popis
String
name
Název, pokud kterým bude souborový manipulátor zobrazen v nabídce Soubor|Nový a v seznamu Typ souboru v okně pro otvírání souboru.
Seq(formát souboru)
(viz níže)
formats
Seznam formátů souborů, které souborový manipulátor ovládá.
Enki
read_file
Funkce pro načtení dat ze souboru. Jako parametr dostane řetězec file_name s plnou cestou k otvíranému souboru. K otevření a načtení souboru je třeba využít funkcí jazyka Enki pro manipulaci se soubory.
Enki
write_file
Analogicky funkce pro uložení souboru.
Enki
init_empty
Funkce v jazyce Enki vyvolaná při vytvoření nového dokumentu pomocí souborového manipulátoru (z nabídky Soubor|Nový).
String
current_manipulator
Pokud je dokument otevřen pomocí souborového manipulátoru, zde je plná cesta k souboru, obsahující souborový manipulátor použitý k otevření.
String
current_format
Pokud je dokument soubor otevřený pomocí souborového manipulátoru, zde je uložena koncovka souboru, z něhož byl dokument načten.

Formát souboru

Typ složky
Název složky
Popis
String
name
Název formátu zobrazovaný uživateli.
Bool
default
Tento souborový manipulátor je hlavní manipulátor pro daný typ souboru. Podstatné v případě, že více manipulátorů ovládá stejný formát.
Seq(String)
extensions
Seznam koncovek, které náleží danému formátu. Koncovky jsou bez tečky (např. "jpg" pro JPEG).