Fondamenti di programmazione OpenOffice.org Basic. a cura di nizan Soluzioni Open Source

Fondamenti di programmazione OpenOffice.org Basic a cura di nizan Soluzioni Open Source

GNU Free Documentation License Copyright 2003 nizan Soluzioni OpenSource via Marconi,14 Casalecchio di Reno. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with the Invariant Text Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". 2

OpenOffice.org OpenOffice.org è un progetto Open Source che ha quale scopo primario lo sviluppo di una Suite per l'ufficio multi-lingue e multipiattaforma, basata sullo standard aperto XML di salvataggio dei documenti 3

Differenze tra StarOffice e OpenOffice.org Non tutto il codice di StarOffice è disponibile presso OpenOffice.org. La ragione dipende dal fatto che Sun Microsystems utilizza codice di terze parti e ne acquista la licenza; non ha perciò il permesso di renderlo utilizzabile in OpenOffice.org. Le parti che sono o saranno presenti in StarOffice, ma non disponibili in OpenOffice.org includono: * Controllo Ortografico * Alcuni caratteri (inclusi, in modo particolare, i caratteri delle lingue orientali) * La Guida * Il componente di Database (Adabas D) * I Modelli * La vasta galleria di Clip Art * Alcune funzionalità di ordinamento (nelle versioni asiatiche) * Alcuni filtri per i file 4

OpenOffice.org: uso delle macro Creazione nuova macro Creazione nuovo modulo Gestione moduli Gestione librerie Importazione/esportazione Assegnazione macro 5

OpenOffice.org:uso delle macro 6

Finestra Macro: moduli standard 7

Opzioni: percorsi 8

Finestra Macro: moduli utente 9

Gestione macro: moduli 10

Gestione macro: librerie 11

Assegnazione macro: voce di menù 12

Assegnazione macro: combinazione di tasti 13

Assegnazione macro: eventi 14

OpenOffice.org Basic: differenze rispetto ai dialetti basic tradizionali OpenOffice.org Basic è modulare La programmazione con OpenOffice.org Basic è basata su singole Subs o Functions che terminano sempre con End Sub o End Function. In ogni Sub o Function può essere chiamata un'altra Sub o Function Quando una macro viene eseguita automaticamente essa chiama la Sub corrispondente 15

OpenOffice.org Basic: considerazioni tecniche Variabili Oggetti Procedure e funzioni Librerie di moduli e dialoghi 16

Variabili: dichiarazione DIM a$ dichiara a come stringa DIM a As String dichiara a come stringa DIM a$, b As Integer dichiara a come stringa, b come intero 17

Variabili: dichiarazione La dichiarazione delle variabili obbligatoria NON è Questo comportamento può essere cambiato utilizzando OPTION EXPLICIT come prima istruzione di un modulo 18

Variabili: tipi Forma breve DIM Variabile As... DIM Variabile% DIM Variabile& DIM Variabile! DIM Variabile# DIM Variabile@ DIM Variabile$ Integer Long Single Double Currency String Date Boolean 19

Procedure e Funzioni: chiamata semplice Sub Inizio DIM Variabile1 As String DIM Variabile2 As Integer Codice End Sub 20

Procedure e Funzioni: chiamata semplice Function Inizio As Integer DIM Variabile1 As String DIM Variabile2 As Integer Codice Inizio = Valore (valore di ritorno) End Function 21

Procedure e Funzioni: chiamata con parametri Sub Inizio(Par1 As Integer, Par2 As String) DIM Variabile1 As String DIM Variabile2 AS Integer Codice End Sub 22

Procedure e Funzioni: chiamata con parametri Function Inizio(Par1 As Single) As Integer DIM Variabile1 As String DIM Variabile2 AS Integer Codice Inizio = Valore (valore di ritorno) End Function 23

Procedure e funzioni: visibilità delle variabili PUBLIC Variabile As TYPENAME Visibile in tutti i moduli PRIVATE Variabile As TYPENAME Visibile solo nel modulo corrente DIM Variabile As TYPENAME Come sopra STATIC Variabile As TYPENAME Preserva il valore di una variabile in una Sub 24

Procedure e funzioni: altre caratteristiche Di default tutte le variabili vengono passate alle funzioni per riferimento Per modificare questo comportamento aggiungere la keyword ByVal prima di un parametro nella chiamata della funzione Le chiamate ricorsive di Subs e Functions NON sono permesse 25

Librerie, moduli e dialog Le librerie sono un tool per organizzare più moduli. Quando un documento o un template vengono salvati, tutte le librerie in esso contenute vengono salvate I moduli contengono Sub e Function e tutte le variabili valide in uno o tutti i moduli I dialog permettono l'interazione con l'utente tramite controlli ed eventi 26

Gestione macro: moduli 27

OpenOffice.org Basic IDE Ambiente di sviluppo integrato in OpenOffice.org Supporto linguaggio di programmazione OpenOffice.org Basic Editor avanzato Interfacciamento diretto con API di programmazione Debugging avanzato 28

StarBasic IDE: interfaccia 29

StarBasic IDE: debugging 30

L'API OpenOffice.org L'API OpenOffice.org si basa sulla tecnologia a componenti di OpenOffice.org e consiste in una ampia gamma di interfacce scritte in un linguaggio IDL simile a CORBA. Mentre la tecnologia a componenti determina come i componenti o le applicazioni comunicano gli uni con gli altri e come accedere all'api da specifici linguaggi, l'api definisce l'interfaccia per accedere alle funzionalità indipendentemente dal linguaggio usato. 31

L'API OpenOffice.org: definizione L'API OpenOffice.org non è un linguaggio di programmazione E' una definizione astratta di tutti gli oggetti e delle interfacce che si possono usare nella programmazione. OpenOffice.org Basic offre un interfacciamento diretto con l'api OpenOffice.org ma le stesse interfacce possono essere utilizzate da altri linguaggi di programmazione (C, C++, Java, StarScript) 32

API OpenOffice.org: informazioni addizionali http://api.openoffice.org/ Homepage del progetto API OpenOffice.org http://api.openoffice.org/basic/man/tutorial/tutorial.pdf Tutorial sull'api OpenOffice.org (aka Staroffice) e OpenOffice.org Basic (aka StarBasic) http://api.openoffice.org/docs/common/ref/com/sun/star/module-ix.html Manuale di riferimento (online) dell'api OpenOffice.org 33

OpenOffice.org API: concetti Servizi e interfacce Moduli Componenti 34

OpenOffice.org API: servizi e interfacce Un servizio è un concetto astratto che fornisce interfacce e proprietà Ogni implementazione di un particolare servizio deve fornire le stesse interfacce Una interfaccia è una collezione di metodi che forniscono certe funzionalità 35

Gestione macro: librerie 36

Servizi e interfacce 37

OpenOffice.org API: moduli I moduli sono raggruppamenti di servizi, interfacce, tipi, numeratori e strutture dati. Alcuni esempi di moduli sono text, sheet, table e drawing Sebbene i loro nomi corrispondano con quelli di certe applicazioni non c'è un legame diretto tra questi (es. il modulo document non è usato solamente per documenti di testo) 38

StarOffice API module structure 39

OpenOffice.org API: componenti I componenti implementano servizi dell'api di OpenOffice.org Non è possibile accedervi direttamente programmando con l'api di OpenOffice.org. Sono accessibili come beans che è possibile incorporare nei programmi Il loro utilizzo è fuori dallo scopo di questo trattato 40

END a cura di nizan Soluzioni Open Source

Fondamenti di programmazione OpenOffice.org API (parte 2) a cura di nizan Soluzioni Open Source

GNU Free Documentation License Copyright 2003 nizan Soluzioni OpenSource via Marconi,14 Casalecchio di Reno. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with the Invariant Text Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Funzioni I/O standard OpenOffice.org Basic comprende un set completo di funzioni di I/O sul filesystem che lo rendono compatibile con Visual Basic. Per garantire l'indipendenza dal sistema operativo usato è stata aggiunta la notazione file://...

Esempio I/O con funzioni standard Open "file:///home/guandalf/prova.txt" For Input As #1 While Not Eof(#1) Input #1, a$ Print a$ Wend Close #1

I/O con l'api OpenOffice.org Servizio: com.sun.star.ucb.simplefileaccess Interfacce: com.sun.star.ucb.xsimplefileaccess2 com.sun.star.ucb.xsimplefileaccess

I/O con l'api OpenOffice.org metodi Copiare, muovere e rimuovere files e folders (copy(), move(), kill()) Ottenere informazioni riguardanti files e folders (isfolder(), exists(), getsize(),...) Aprire e creare files (openfileread(), openfilewrite(), openfilereadwrite())

I/O con l'api OpenOffice.org intefacce stream com.sun.star.io.xinputstream, com.sun.star.io.xseekable com.sun.star.io.xoutputstream, com.sun.star.io.xseekable com.sun.star.io.xstream, com.sun.star.io.xseekable

Intefacce stream specifiche per I/O su files di testo Servizi: com.sun.star.io.textinputstream com.sun.star.io.textoutputstream Interfacce: com.sun.star.io.xtextinputstream com.sun.star.io.xactivedatasink com.sun.star.io.xtextoutputstream com.sun.star.io.xactivedatasource

Intefacce stream specifiche per input da files di testo L'interfaccia com.sun.star.io.xactivedatasink esporta il metodo setinputstream() che accetta come parametro un oggetto ritornato dal metodo openfileread()

Intefacce stream specifiche per I/O su files di testo Utilizzando i metodi readline() readstring() esportati dall'interfaccia com.sun.star.io.xtextinputstream possiamo leggere linee o stringhe dal file di testo

Intefacce stream specifiche per I/O su files di testo Utilizzando il metodo setencoding() possiamo definire la codifica dei caratteri che sarà usata (default UTF-8) http://www.iana.org/assignments/character-sets

Intefacce stream specifiche per output su files di testo L'interfaccia com. sun. star. io.xactivedatasource esporta il metodo setoutputstream() che accetta come parametro un oggetto ritornato dal metodo openfilewrite()

Intefacce stream specifiche per I/O su files di testo Utilizzando il metodo writestring() esportato dall'interfaccia com.sun.star.io.xtextoutputstream possiamo scrivere stringhe nel file di testo

Chiusura streams I files aperti devono essere chiusi utilizzando i metodi com.sun.star.io.xinputstream:closeinput() com.sun.star.io.xoutputstream:closeoutput()

Esempio I/O con API OpenOffice.org osimplefileaccess = createunoservice_ ("com.sun.star.ucb.simplefileaccess") ostream = osimplefileaccess.openfileread_ ("file:///home/guandalf/prova.txt") otextstream = createunoservice_ ("com.sun.star.io.textinputstream") otextstream.setinputstream(ostream) While Not otextstream.iseof() sline = otextstream.readline() Print sline Wend ostream.closeinput()

Formati data e ora OpenOffice.org supporta diversi tipi di formati e funzioni per il trattamento di data e ora compatibili con Visual Basic

Formati data e ora I metodi com.sun.star.awt.xdatefield:setdate() e com.sun.star.awt.xdatefield:getdate() utilizzano uno speciale formato ISO non compatibile con le funzioni Date e Time interne al Basic

Formati data e ora Le funzioni CDateToIso e CDateFromIso convertono i formati da quello del Basic a quello delle API e viceversa

Interazione tra Basic e API StarDesktop ThisComponent

StarDesktop Dà accesso diretto al servizio: com.sun.star.frame.desktop MsgBox StarDesktop.Dbg_SupportedInterfaces equivale a Dim odesktop odesktop = createunoservice_( com.sun.star.frame.desktop ) MsgBox odesktop.dbg_supportedinterfaces

ThisComponent Dà accesso al documento corrente o che contiene il codice eseguito Il valore ritornato dipende dal documento al quale fa riferimento Es. MsgBox ThisComponent.Dbg_SupportedInterfaces Questo esempio produrrà diversi risultati dipendentemente dal documento sul quale stiamo operando

Interfacce di default Tutti i documenti esportano una serie di interfacce di default. Dipendentemente dal tipo di documento, saranno disponibili una ulteriore serie di interfacce specializzate.

Interfacce esportate da tutti i documenti (segue) com.sun.star.beans.xpropertyset com.sun.star.container.xchild com.sun.star.document.xdocumentinfosupplier com.sun.star.document.xeventbroadcaster com.sun.star.document.xviewdatasupplier com.sun.star.document.xeventssupplier com.sun.star.document.xlinktargetsupplier

Interfacce esportate da tutti i documenti com.sun.star.frame.xmodel com.sun.star.frame.xstorable com.sun.star.lang.xserviceinfo com.sun.star.lang.xmultiservicefactory com.sun.star.lang.xeventlistener com.sun.star.style.xstylefamiliessupplier com.sun.star.util.xmodifiable com.sun.star.view.xprintable

com.sun.star.beans.xpropertyset Fornisce informazioni e accesso alle proprietà di una implementazione. Le proprietà possono essere di tipo: Bound Constrained Free E' possibile legare dei listener alle proprietà di tipo bound e constrained.

com.sun.star.container.xchild Permette l'accesso al genitore dell'oggetto specificato tramite i metodi getparent() setparent()

com.sun.star.document.xdocumentinfosupplier Fornisce informazioni specifiche sul documento come: autore data di creazione titolo informazioni sull'utente

com.sun.star.document.xeventbroadcaster Permette di registrare listener che saranno chiamati quando determinati eventi avverranno nel documento Alcuni nomi di eventi sono: OnLoadFinished OnPrint OnResize

com.sun.star.document.xviewdatasupplier Dà accesso a una serie di proprietà che descrivono le viste del documento Ogni vista è descritta da una serie di com.sun.star.beans.propertyvalue

com.sun.star.document.xeventssupplier Attraverso la chiamata al metodo getevents() ritorna una lista di handlers legati a eventi dell'oggetto

com.sun.star.document.xlinktargetsupplier Interfaccia fornita dagli oggetti all'interno del modello del documento che possono essere target di un link. Il metodo getlinks() ritorna l'elenco e implementa il servizio LinkTargets sul quale operare.

com.sun.star.frame.xmodel E' la rappresentazione di un componente creato tramite un URL e degli argomenti. Contiene ad esempio il nome della risorsa accessibile tramite il metodo geturl()

com.sun.star.frame.xstorable Permette in modo semplice di immagazzinare un componente in un URL. Ad esempio il metodo store() salva il componente nell'url dal quale era stato caricato.

com.sun.star.lang.xserviceinfo Fornisce informazioni riguardanti le implementazioni di servizi, cioè quali servizi sono implementati e il nome dell'implementazione.

com.sun.star.lang.xmultiservicefactory Permette la creazione di istanze di servizi che verranno inclusi nel documento. Con il metodo createinstance() si crea una istanza (ad esempio di un servizio, ma non solo) all'interno del documento.

com.sun.star.lang.xeventlistener E' l'interfaccia di base per tutte le interfacce listener Esporta un metodo disposing() che viene chiamato quando il broadcaster sta per essere rimosso

com.sun.star.style.xstylefamiliessupplier Questa interfaccia fornisce l'accesso alle famiglie di stili contenute nel documento. Il metodo getstylefamilies() ritorna questo elenco come un contenitore di stili.

com.sun.star.util.xmodifiable Rende accessibile lo stato di documento modificato attraverso i metodi ismodified() setmodified()

com.sun.star.view.xprintable Fornisce le funzionalità basilari di stampa Esporta i metodi getprinter() setprinter() print()

Documenti Text: servizi e interfacce Servizio com.sun.star.text.textdocument che esporta l'intefaccia com.sun.star.text.xtextdocument Diverse altre interfacce specialmente dal modulo com.sun.star.text

com.sun.star.text.xtextdocument Fornisce l'interfaccia principale per un documento di testo Esporta gettext() reformat()

Documenti Spreadsheet: servizi e interfacce Servizio com.sun.star.sheet.spreadsheetdocument Diverse altre interfacce specialmente dal modulo com.sun.star.sheet

com.sun.star.sheet.spreadsheetdocument Fornisce l'accesso a una collezione di fogli di calcolo Esporta getsheets()

Documenti Drawing: servizi e interfacce Servizio com.sun.star.sheet.drawingdocument Diverse altre interfacce specialmente dal modulo com.sun.star.drawing

END a cura di nizan Soluzioni Open Source