Popis rozšířujících funkcí JScriptu

Transkript

1 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 Vrací true, pokud přidání proběhlo úspěšně. Zastupuje příkaz CONADD. AddOrgDbItem Funkce přidá novou činnost do databáze. AddOrgDbItem( oorgdbitem // objekt ORGDBItem obsahující informace o činnosti Vrací true, pokud přidání proběhlo úspěšně. Zastupuje příkaz ORGADD. AddNote Funkce přidá nový úkol do Seznamu úkolů. AddNote( filename, text // název souboru s textem úkolu // text úkolu 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 -

2 index Příloha č. 3 Popis rozšířujících funkcí JScriptu Vrací true, pokud změna proběhla úspěšně. Zastupuje příkaz CONCHN. ChangeOrgDbItem Funkce změní informace o činnosti. // index záznamu v databázi, který má být změněn ChangeOrgDbItem( oorgdbitem, // objekt ORGDBItem obsahující informace o činnosti index // index záznamu v databázi, který má být změněn Vrací true, pokud změna proběhla úspěšně. Zastupuje příkaz ORGCHN. CreateBackup Vytvoří zálohu dat. CreateBackup( Vrací true, pokud export proběhl úspěšně. 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 Parametr nstyle // 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 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 -

3 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 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. Zastupuje příkaz CRW. DelContact Funkce smaže kontakt z databáze. DelContact( index Vrací true, pokud smazání proběhlo úspěšně. Zastupuje příkaz CONDEL. DelNote Funkce smaže úkol ze Seznamu úkolů. DelNote( filename // index záznamu v databázi, který má být odstraněn // název souboru s textem úkolu 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 -

4 Vrací true, pokud smazání proběhlo úspěšně. 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. 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. 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

5 ExportToHTML Příloha č. 3 Popis rozšířujících funkcí JScriptu 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. 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 Funkce vrací hodnoty pomocí parametru pointobject nastaví údaje v tomto objektu. 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 - 5 -

6 Funkce vrací hodnoty pomocí parametru oorgcontact nastaví údaje v tomto objektu. Zastupuje příkaz CONGET. GetNDDItem Naplní položky objektu NDBItem informacemi o dni určeném parametry m a d. GetNDDItem( ondbitem, // NDBItem objekt m, // měsíc d // den Funkce vrací hodnoty pomocí parametru ondbitem nastaví údaje v tomto objektu. Zastupuje příkaz GNMENTR. GetNotesList Funkce vrátí HTML kód seznamu úkolů pro zadaný den. GetNotesList( r, // rok m, // měsíc d // den Vrací HTML kód Seznamu úkolů. 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 Funkce vrací hodnoty pomocí parametru oorgdbitem nastaví údaje v tomto objektu. 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 -

7 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. Funkce vrací data uložena ve zvoleném registru. 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 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 -

8 Zastupuje příkaz MSB. QuickSearch Příloha č. 3 Popis rozšířujících funkcí JScriptu 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. Zastupuje příkaz QFND. RestoreBackup Načte zálohu dat. RestoreBackup( Vrací true, pokud načtení proběhlo úspěšně. Zastupuje příkaz LBKP. SetDayNote Nastaví (změní text u poznámky dne. SetDayNote( m, // měsíc d, // den stext // text poznámky dne Zastupuje příkaz SDAYNOTE

9 SetRegisterData Příloha č. 3 Popis rozšířujících funkcí JScriptu 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. Zastupuje příkaz RGSET. SetWindowPos Slouží ke změně pozice okna, vzhledem k ploše. SetWindowPos( x, // nová X souřadnice pozice okna y // nová Y souřadnice pozice okna Zastupuje příkaz MVW. SetWindowSize Slouží ke změně rozměrů okna. SetWindowSize( width, height Zastupuje příkaz SZW. SetWindowState // nová šířka okna // nová výška okna 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 -

10 SWP_SHOW SWP_HIDE - zobrazit okno - skrýt okno Zastupuje příkaz SWP. SetWindowText Slouží ke změně titulku okna. SetWindowText( Text Zastupuje příkaz SWT. UserWarningMsg // nový titulek okna Vytvoří standardní chybový dialog programu s vlastním textem. UserWarningMsg( text Zastupuje příkaz DBM. // text chybového dialogu