Příloha č. 3 – Popis rozšířujících funkcí JScriptu
Popis rozšířujících funkcí JScriptu Tato příloha obsahuje stručný popis funkcí, které rozšiřují základní funkce JScriptu. Ty usnadňují komunikaci s jádrem programu, takže není potřeba pokaždé sestavovat celý textový příkaz, ale tyto funkce to udělají automaticky ze zadaných parametrů.
AddContact Funkce přidá nový kontakt do databáze. AddContact( oORGContact // objekt ORGContact obsahující informace o kontaktu ) Návratová hodnota
Vrací true, pokud přidání proběhlo úspěšně. Poznámky
Zastupuje příkaz CONADD.
AddOrgDbItem Funkce přidá novou činnost do databáze. AddOrgDbItem( oORGDBItem )
// objekt ORGDBItem obsahující informace o činnosti
Návratová hodnota
Vrací true, pokud přidání proběhlo úspěšně. Poznámky
Zastupuje příkaz ORGADD.
AddNote Funkce přidá nový úkol do Seznamu úkolů. AddNote( filename, text )
// název souboru s textem úkolu // text úkolu
Poznámky
Zastupuje příkaz ADDNOTE. Soubory jsou ukládány do adresáře notes, název souboru by měl odpovídat schématu YYYYMMDD_HHMMSS.txt.
ChangeContact Funkce změní informace o kontaktu. ChangeContact( oORGContact // objekt ORGContact obsahující informace o kontaktu
-1-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu index
// index záznamu v databázi, který má být změněn
) Návratová hodnota
Vrací true, pokud změna proběhla úspěšně. Poznámky
Zastupuje příkaz CONCHN.
ChangeOrgDbItem Funkce změní informace o činnosti. ChangeOrgDbItem( oORGDBItem, // objekt ORGDBItem obsahující informace o činnosti index // index záznamu v databázi, který má být změněn ) Návratová hodnota
Vrací true, pokud změna proběhla úspěšně. Poznámky
Zastupuje příkaz ORGCHN.
CreateBackup Vytvoří zálohu dat. CreateBackup() Návratová hodnota
Vrací true, pokud export proběhl úspěšně. Poznámky
Zastupuje příkaz CBKP.
CreateWindow Slouží k vytvoření nového okna jak modálního, tak nemodálního. CreateWindow( srcPath, nPosX, nPosY, nWidth, nHeight, nStyle, wndTitle )
// // // // // // //
HTML soubor, který se má do okna načíst X souřadnice pozice okna Y souřadnice pozice okna šířka okna výška okna styl okna... titulek okna
Parametr nStyle
Parametrem lze nastavit další vlastnosti okna. Může být kombinací těchto hodnot: WNDS_MODALDIALOG - vytvoří modální dialog WNDS_BORDER - rámeček kolem okna
-2-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu WNDS_RESIZE - umožní změnu velikosti okna WNDS_TITLE - okno bude mít titulek WNDS_MINIMIZE - umožní minimalizování okna WNDS_MAXIMIZE - umožní maximalizování okna WNDS_NOSCROLL - zakáže posuvníky v objektu HTML prohlížeče WNDS_APPDLG - okno bude i na Hlavním panelu (liště) WNDS_SYSTEMMENU - okno bude mít systémové menu (menu, ikona, tlačítko zavřít) WNDS_CENTERDLG - vycentrovat okno do středu obrazovky WNDS_DSKEYDLGEXIT - zakáže zavření okna stiskem klávesy Enter nebo Esc Návratová hodnota
Pokud vytvoříme dialogové okno, funkce vrací způsob, kterým bylo okno uzavřeno – true, pokud bylo ukončeno stavem IDOK (tlačítkem OK) nebo false, pokud bylo ukončeno stavem IDCANCEL (Storno). V případě nemodálního okna je návratová hodnota vždy true. Poznámky
Zastupuje příkaz CRW.
DelContact Funkce smaže kontakt z databáze. DelContact( index )
// index záznamu v databázi, který má být odstraněn
Návratová hodnota
Vrací true, pokud smazání proběhlo úspěšně. Poznámky
Zastupuje příkaz CONDEL.
DelNote Funkce smaže úkol ze Seznamu úkolů. DelNote( filename )
// název souboru s textem úkolu
Poznámky
Zastupuje příkaz DELNOTE. Soubory jsou ukládány do adresáře notes, název souboru by měl odpovídat schématu YYYYMMDD_HHMMSS.txt.
DelOrgDbItem Funkce smaže činnost z databáze. DelOrgDbItem( index
// index záznamu v databázi, který má být odstraněn
-3-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu ) Návratová hodnota
Vrací true, pokud smazání proběhlo úspěšně. Poznámky
Zastupuje příkaz ORGDEL.
DrawOrgView Funkce vykreslí do HTML bloku _mainBodyFrame zvolený pohled (zobrazení dat). DrawOrgView( sMode, sBegin, sEnd )
// určuje požadované zobrazení // datum začátku // datum konce
Parametr sMode
Určuje, který pohled (zobrazení) má být vykreslen. Může nabývat těchto hodnot: 'D' 'W' 'L' 'I' 'C'
- pohled Organizér: den - pohled Organizér: týden - pohled Organizér: seznam - pohled Shrnutí dne - pohled Kontakty
Parametr sBegin
Určuje počáteční datum pro zobrazení (kromě pohledu Kontakty, kdy je ignorován). Je to textový řetězec ve formátu YYYYMMDD. Parametr sEnd
V současné době ignorován. Nastavuje se na prázdný řetězec. Poznámky
Zastupuje příkaz ORGVIEW.
EndDialog Funkce zavře okno (modální i nemodální); EndDialog( bModalResult )
// návratová hodnota dialogu
Parametr bModalResult
Určuje návratovou hodnotu okna/dialogu. Nastavuje se na true, pokud má být dialog ukončen jakoby bylo použito tlačítka OK, false, pro tlačítko Storno. Poznámky
V případě modálního okna (dialogu) je tato hodnota přímo návratová hodnota funkce CreateWindow. V případě nemodálního okna je po jeho ukončení poslán příkaz CHC, a výstupní parametr obsahuje tuto hodnotu.
-4-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu ExportToHTML Funkce vytvoří nový HTML soubor, do něhož vykreslí zvolený pohled (zobrazení dat). ExportToHTML( sMode, sBegin, sEnd )
// určuje požadované zobrazení // datum začátku // datum konce
Parametr sMode
Určuje, který pohled (zobrazení) má být vykresleno. Může nabývat těchto hodnot: 'D' 'W' 'L' 'I' 'C'
- pohled Organizér: den - pohled Organizér: týden - pohled Organizér: seznam - pohled Shrnutí dne - pohled Kontakty
Parametr sBegin
Určuje počáteční datum pro zobrazení (kromě pohledu Kontakty, kdy je ignorován). Je to textový řetězec ve formátu YYYYMMDD. Parametr sEnd
V současné době ignorován. Nastavuje se na prázdný řetězec. Poznámky
Zastupuje příkaz EXPHTML.
GetAbsolutePos Slouží ke zjištění absolutní pozice levého horního rohu zadaného HTML objektu vůči levému hornímu rohu obrazovky. GetAbsolutePos( pointObject, htmlElement )
// objekt Point // HTML objekt
Návratová hodnota
Funkce vrací hodnoty pomocí parametru pointObject – nastaví údaje v tomto objektu. Poznámky
Zastupuje příkaz GBP.
GetContact Funkce vrátí informace o kontaktu. GetContact( oORGContact // objekt ORGContact pro zapsání informací o kontaktu index // index požadovaného záznamu v databázi ) Návratová hodnota
-5-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu Funkce vrací hodnoty pomocí parametru oORGContact – nastaví údaje v tomto objektu. Poznámky
Zastupuje příkaz CONGET.
GetNDDItem Naplní položky objektu NDBItem informacemi o dni určeném parametry m a d. GetNDDItem( oNDBItem, m, d )
// NDBItem objekt // měsíc // den
Návratová hodnota
Funkce vrací hodnoty pomocí parametru oNDBItem – nastaví údaje v tomto objektu. Poznámky
Zastupuje příkaz GNMENTR.
GetNotesList Funkce vrátí HTML kód seznamu úkolů pro zadaný den. GetNotesList( r, m, d )
// rok // měsíc // den
Návratová hodnota
Vrací HTML kód Seznamu úkolů. Poznámky
Zastupuje příkaz GNOTELIST.
GetOrgDbItem Funkce vrátí informace o činnosti. GetOrgDbItem( oORGDBItem, // objekt ORGDBItem pro zapsání informací o činnosti index // index požadovaného záznamu v databázi ) Návratová hodnota
Funkce vrací hodnoty pomocí parametru oORGDBItem – nastaví údaje v tomto objektu. Poznámky
Zastupuje příkaz ORGGET.
GetRegisterData Funkce slouží k přečtení dat ze speciálních registrů programu. Ty slouží k dočasnému uložení
-6-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu dat při libovolné činnosti. Tyto registry jsou globální, tzn. jsou přístupné z kteréhokoliv okna programu. GetRegisterData( nRegister // ID registru ) Parametr nRegister
Označuje registr, do něhož chceme vložit data. Je to celočíselná hodnota. V současné době je k dispozici pouze jeden registr – parametr musí být 0. Návratová hodnota
Funkce vrací data uložena ve zvoleném registru. Poznámky
Zastupuje příkaz RGGET.
MessageBox Zobrazí standardní systémový MessageBox. MessageBox( btns, icon, title, text )
// // // //
tlačítka hlášky ikona hlášky titulek okna hlášky text hlášky
Parametr btns
Parametrem lze nastavit, která tlačítka budou použita. Může nabývat těchto hodnot: MSB_OK MSB_OKCANCEL MSB_YESNO MSB_YESNOCANCEL
- tlačítko OK - tlačítka OK/Storno - tlačítka Ano/Ne - tlačítka Ano/Ne/Storno
Parametr icon
Parametrem lze nastavit, která ikona bude použita. Může nabývat těchto hodnot: MSB_INONE MSB_IERROR MSB_IWARNING MSB_IINFORMATION MSB_IQUESTION
- žádná ikona - ikona chyby - ikona varování - ikona informace - ikona otazník
Návratová hodnota
Funkce vrací označení tlačítka, kterým byla hláška ukončena. Může nabývat těchto hodnot: IDOK IDCANCEL IDYES IDNO
- tlačítko OK - tlačítko Storno - tlačítko Ano - tlačítko Ne
-7-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu Poznámky
Zastupuje příkaz MSB.
QuickSearch Funkce vykreslí do HTML bloku _mainBodyFrame výsledky hledání zadaného textu. QuickSearch( sMode, sText )
// určuje požadovaný režim hledání // text, který se má hledat
Parametr sMode
Určuje, ve kterých datech se má vyhledávat. Může nabývat těchto hodnot: 'A' 'N' 'I' 'T' 'C'
- hledat se bude ve všech datech, pohled podobný Shrnutí dne - hledat se bude ve jménech, svátcích a poznámkách - hledat se bude v činnostech, pohled Organizér: seznam - hledat se bude v úkolech, pohled podobný Organizér: seznam - hledat se bude v kontaktech, pohled Kontakty
Parametr sText
Určuje text, který má být vyhledán. Hledání je fulltextové nezávislé na velikosti písmen. Poznámky
Zastupuje příkaz QFND.
RestoreBackup Načte zálohu dat. RestoreBackup() Návratová hodnota
Vrací true, pokud načtení proběhlo úspěšně. Poznámky
Zastupuje příkaz LBKP.
SetDayNote Nastaví (změní) text u poznámky dne. SetDayNote( m, d, sText )
// měsíc // den // text poznámky dne
Poznámky
Zastupuje příkaz SDAYNOTE.
-8-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu SetRegisterData Funkce slouží k ukládání dat do speciálních registrů programu. Ty slouží k dočasnému uložení dat při libovolné činnosti. Tyto registry jsou globální, tzn. jsou přístupné z kteréhokoliv okna programu. SetRegisterData( nRegister, // ID registru data // data... ) Parametr nRegister
Označuje registr, do něhož chceme vložit data. Je to celočíselná hodnota. V současné době je k dispozici pouze jeden registr – parametr musí být 0. Poznámky
Zastupuje příkaz RGSET.
SetWindowPos Slouží ke změně pozice okna, vzhledem k ploše. SetWindowPos( x, y )
// nová X souřadnice pozice okna // nová Y souřadnice pozice okna
Poznámky
Zastupuje příkaz MVW.
SetWindowSize Slouží ke změně rozměrů okna. SetWindowSize( width, height )
// nová šířka okna // nová výška okna
Poznámky
Zastupuje příkaz SZW.
SetWindowState Slouží ke změně stavu zobrazení okna (minimalizování, apod.). SetWindowState( State ) Parametr State
Může nabývat těchto hodnot: SWP_NORMAL SWP_MAXIMIZE SWP_MINIMIZE
- výchozí stav (zobrazit nemaximalizované) - maximalizovat okno - minimalizovat okno
-9-
Příloha č. 3 – Popis rozšířujících funkcí JScriptu SWP_SHOW SWP_HIDE
- zobrazit okno - skrýt okno
Poznámky
Zastupuje příkaz SWP.
SetWindowText Slouží ke změně titulku okna. SetWindowText( Text )
// nový titulek okna
Poznámky
Zastupuje příkaz SWT.
UserWarningMsg Vytvoří standardní chybový dialog programu s vlastním textem. UserWarningMsg( text )
// text chybového dialogu
Poznámky
Zastupuje příkaz DBM.
- 10 -
