1
For the previous four parts of this series, we have slowly built a database document using LibreOffice's Base module. We have a database with forms to enter our data, and queries and reports for extracting the data. We now have a usable document for recording our book library. However, our current design has one flaw we need to overcome. If we need to enter a new author or media type while we are in the books form, we have to close the book form and open one of the others. If we could enter new authors and media types directly from the books form, it would behave more like an application and make data entry even easier. We can accomplish this through a few short macros. The LibreOffice Basic language is very similar to other Basic languages, such as Visual Basic for Applications. To manipulate the underlying LibreOffice document, we access the Uno framework controlling the document. The Uno framework is quite complex, but I will explain, as best I can, the properties and objects we will use. The goal is not to teach you how to write LibreOffice macros, but how you can use them.
Pour les quatre parties précédentes de cette série, nous avons pris notre temps pour construire un document de base de données avec le module Base de LibreOffice. Nous avons une base de données avec des formulaires pour saisir nos données et des requêtes, et des rapports pour les extraire. Nous avons maintenant un document que nous pouvons utiliser pour l'enregistrement de notre bibliothèque. Toutefois, le design actuel a un défaut qu'il faut surmonter. Si nous avons besoin de saisir le nom d'un nouvel auteur ou d'un type de média pendant que nous nous trouvons dans le formulaire livres, il faut fermer celui-ci et ouvrir l'un des autres. Si on avait la possibilité de saisir les nouveaux auteurs et médias directement à partir du formulaire livres, notre base se comporterait davantage comme une application et la saisie des données deviendrait encore plus facile. Nous pouvons le faire avec quelques courtes macros.
Le langage Basic de LibreOffice est très similaire à d'autres langages Basic, tels que Visual Basic for Applications. Afin de manipuler le document LibreOffice sous-jacent, nous accédons au cadre UNO qui contrôle le document. Le cadre UNO est très complexe, mais je ferai de mon mieux pour expliquer les propriétés et les objets que nous utiliserons. Mon objectif n'est pas de vous apprendre à écrire des macros dans LibreOffice, mais de vous montrer comment vous pourrez les utiliser.
2
Macro Security and Options While macros allow us to do cool things in our documents, they can also cause problems. Some people use macros to compromise other people's systems, therefore, we need to take a few minutes to talk about macro security. Whether you are running LibreOffice on Linux, Mac, or Windows, malicious code in a macro can compromise your data and possibly your entire system. Macro security in LibreOffice is simple. Tools > Options opens the Options dialog for LibreOffice. Under LibreOffice, select Security. Click on the Macro Security button to pop up the macro security options. You have four options. Never use the Low security option – it will run macros without asking you. I recommend the Medium security level. With this level, you are prompted whether to run the macros when you open a document containing macros. The High and Very High options require a certificate or folder you designate as trusted. While this is great, I believe nothing trumps the instincts of the user. You usually know whether you were expecting a document to contain macros. When in doubt, click No. Click OK to save your choice and OK to close the options dialog. Now, on to the fun stuff.
Macros : Sécurité et Options
Alors qu'il est vrai que les macros nous permettent de faire des trucs sympas dans nos documents, elles peuvent également être source de problèmes. Il y a des individus qui se servent de macros pour compromettre le système d'autres personnes ; c'est pourquoi il faut prendre quelques minutes pour parler de la sécurité des macros. Que vous exécutiez LibreOffice sous Linux, Mac ou Windows, du code malicieux au sein d'une macro peut compromettre vos données et éventuellement votre système tout entier.
La sécurité des macros dans LibreOffice est simple. Outils > Options ouvre le dialogue Options pour LibreOffice. Sous LibreOffice, sélectionnez Sécurité. Cliquez sur le bouton Sécurité des Macros… pour afficher les options de sécurité des macros. Il y en a quatre. N'utilisez jamais le niveau de sécurité faible, il exécutera des macros sans vous demander la permission. Je suggère le niveau de sécurité moyen. Avec ce niveau, vous devez indiquer votre choix - exécuter les macros ou pas - quand vous ouvrez un document qui en contient. Les niveaux de sécurité élevé et très élevé nécessitent un certificat ou un dossier désigné par vos soins comme étant de confiance. C'est très bien, mais je crois que rien ne vaut les instincts de l'utilisateur. D'habitude, vous savez si vous vous attendez à ce qu'un document contienne des macros. Dans le doute, cliquez sur Non. Cliquez sur OK pour sauvegarder votre choix et sur OK pour fermer le dialogue des options.
Et maintenant, amusons-nous.
3
The Macros We will write four macros for our database document. Three will deal with opening forms, and the last will update the list boxes for authors and media types. The general idea behind macros is to accomplish tasks that are not built into the program, or to simplify complex tasks. Our macros really accomplish both, as we will simplify the tasks of adding authors and media types and provide functionality not built into the program. Before we can begin to write our macros, we need a container to hold them. Macros are contained in a module. Modules can live in the program itself or within a document. Since our macros are specific to our database file, we will embed them in the document. Macros embedded in a document are available only when the document is loaded. Macros contained in the program are available as long as the program is running. Tools > Macros > Organize Macros > LibreOffice Basic. The LibreOffice Basic Macros dialog pops up. Select book.odb from the Macro from-list. Click the New button. A dialog pops up asking you for a name for the module. Name it FormCalls. Click OK. This brings up the LibreOffice macro editor. The macro comes with a default main subroutine. We will not use this subroutine. Highlight Sub main and End Sub and press the backspace key to delete them.
Les macros
Nous allons écrire quatre macros pour notre document de base de données. Trois traiteront l'ouverture de formulaires et le dernier mettra à jour les cases de la liste d'auteurs et de types de média. En général, la raison d'être des macros est de faire des choses qui ne sont pas intégrées dans le programme ou de simplifier les tâches complexes. En fait, nos macros font les deux, car nous allons simplifier les tâches du rajout d'auteurs et de types de média et nous allons fournir une fonctionnalité qui ne fait pas partie du programme.
Avant de commencer à écrire les macros, nous avons besoin d'un conteneur où les mettre. Les macros sont contenues dans un module. Les modules peuvent vivre dans le programme même ou au sein du document. Puisque nos macros sont spécifiques au fichier de base de données, nous allons les intégrer dans le document. Les macros intégrées à un document ne sont disponibles que quand le document est chargé. Les macros contenues dans un programme sont disponibles tant que le programme fonctionne.
Outils > Macros > Gérer les macros > LibreOffice Basic. La boîte de dialogue Macros LibreOffice Basic s'affiche. Sélectionnez book.odb dans la zone Macro de (ndlt : à gauche). Cliquez sur le bouton Nouveau (ndlt : à droite). Une boîte de dialogue s'affiche vous demandant de nommer le module. Appelez-le AppelsForm. Cliquez sur OK. L'éditeur de macro de LibreOffice s'affiche. Le macro contient déjà une routine Main par défaut. Nous n'allons pas utiliser cette routine. Mettez Sub Main et End Main en surbrillance et appuyez sur la touche Retour arrière pour les supprimer.
4
Our first macro is a generalized subroutine for opening a form. A generalized subroutine is written for reuse. We will call this routine twice from other routines we write. Type the subroutine shown above into the editor. The first line of the subroutine is called the signature. The signature determines how the subroutine is called. A signature starts with the keyword Sub, which defines this call as a subroutine. Next, the name of the subroutine. In our case, OpenAForm is the name of the subroutine. Finally in the parenthesis, we have the arguments used when calling this subroutine. In our case, we have a variable named FormName which is a type String. In the second line of the subroutine, Dim is another keyword. Dim initializes a variable as a type, and, optionally, a value. We define a variable named GetForm as a type Object. The third line assigns a value to the variable GetForm through a chain of commands in the Uno framework. ThisDatabaseDocument refers to the currently open database document. In our case, book.odb. FormDocuments is a collection of all the forms in the document. Finally, GetByName retrieves a specific form object from the collection. Notice, we pass the variable FormName from the signature to this method. Once the call is complete, the variable GetForm is the object of the form name passed to the subroutine. The fourth line calls the Open method of the form. On the fifth line, we tell Basic this is the end of the subroutine with the command End Sub.
Notre première macro est une routine généralisée pour ouvrir un formulaire. Une routine généralisée est écrite pour être réutilisée. Nous appellerons cette routine deux fois à partir d'autres routines que nous allons écrire. Tapez la routine montrée ci-dessus dans l'éditeur.
La première ligne de la routine s'appelle la signature. C'est la signature qui détermine la façon dont la routine est appelé. Une signature commence par le mot clé Sub, qui définit cet appel comme subroutine (routine). Ensuite, le nom de la routine. Dans notre cas OpenAForm (OuvrirUnFormulaire) est le nom de la routine. Enfin, entre parenthèses, nous avons les arguments utilisés quand on appelle cette routine-ci. Dans notre cas, nous avons une variable nommée FormName (NomDuFormulaire) qui est un type de String (Chaîne). À la deuxième ligne de la routine, Dim est un autre mot clé. Dim initialise une variable en tant que type et, éventuellement, en tant que valeur. Nous définissons une variable nommée GetForm (ObtenirFormulaire) en tant que type Object (Objet). la troisième ligne assigne une valeur à la variable GetForm avec une chaîne de commandes dans le cadre UNO.
ThisDatabaseDocument (CeDocumentBase) fait référence au document de base de données actuellement ouvert. Ici, il s'agit de book.odb (livre.odb). FormDocuments est un ensemble de tous les formulaires dans le document. Enfin, GetByName (ObtenirParNom) récupère un objet formulaire spécifique dans l'ensemble. Remarquez que nous passons le nom de formulaire déjà passé à la routine. La quatrième ligne appelle la méthode Open (Ouvrir) du formulaire. À la cinquième ligne nous disons à Basic que c'est la fin de la routine avec la commande End Sub.
5
We will call the OpenAform subroutine twice. Once to open the authors form, and once to open the media form. Add the two subroutines shown below to your editor. The signature on these two subroutines are a little different. Since we will call them from a control within a form, we need to pass the object making the call as an argument, even though we do not use it. The argument oEv is a reference to the object making the call. We will use this to our advantage later, in the last subroutine, but here we do it because it is required. These two subroutines are pretty simple. We just make a call to OpenAForm passing the name of the form we want to open, Authors or Media. The final subroutine deals with our problem of refreshing the data in the list boxes for authors and media when we add authors or media using the two subroutines above. Sub ListRefresh(oEv as Object) oEv.source.model.Refresh End Sub Once again, since we will call this subroutine (shown right) from a control, we need a reference to the control making the call. However, this time we will actually use the object. This subroutine makes a method call to the underlying model of the list box and refreshes the data in the list, thus updating our list of authors or media types. Save your module and close the Basic editor.
Nous appellerons la routine OpenAForm deux fois. Une fois pour ouvrir le formulaire auteurs et une fois pour ouvrir le formulaire média. Ajoutez les deux sous-routines ci-dessous dans votre éditeur.
La signature sur ces deux routines est un peu différente. Puisque nous les appellerons à partir d'un contrôle à l'intérieur d'un formulaire, il faut passer l'objet appelant en argument, malgré le fait que nous ne l'utilisions pas. L'argument oEv se réfère à l'objet qui fait l'appel. Nous utiliserons ceci à notre avantage plus tard, dans la dernière routine, mais nous le faisons ici parce qu'il le faut. Ces deux routines sont assez simples. Nous faisons tout simplement un appel vers OpenAForm avec le nom du formulaire que nous voulons ouvrir, Auteurs ou Médias.
La routine finale traite notre problème du rafraîchissement des données dans les menus déroulants pour les auteurs et les médias quand nous ajoutons des auteurs ou médias au moyen des deux routines ci-dessus.
Sub ListRefresh(oEv as Object)
oEv.source.model.Refresh
End Sub
6
Making Connections to Macros At this point, our macros do nothing. We need to connect them to objects in our form to activate them when needed. First, we will connect the open form subroutines to buttons in our form, and then we will connect the ListRefresh to the list boxes. In the database pane, click on Forms. Right-click the Books form and select edit. Add two push buttons to the form, one under the Authors table and another under the Media table. Right-click the button under the Authors table and select Control to bring up the buttons properties dialog. On the General tab, change the name to AddAuthors and the Label to Add Authors. On the Events tab, click the ellipses (…) button next to Execute Action – which brings up the Assign Action dialog. Click the Macro button to bring up the Macro Selector dialog. In the tree list under Library, select book.odb > Standard > FormCalls. Select OpenAuthorsForm from the Macro Name list and click OK. Click OK to close the Assign Action dialog. Close the buttons properties dialog.
Créer des connexions aux macros
À ce stade, nos macros ne font rien du tout. Il faut les relier aux objets dans notre formulaire afin de pouvoir les activer quand on en a besoin. Nous allons d'abord connecter les routines OpenAForm (OuvrirFormulaireAuteurs) à des boutons dans notre formulaire et ensuite nous connecterons la ListRefresh (RafraîchirListe) aux menus déroulants.
Dans le volet Base de données, cliquez sur Formulaires. Faites un clic droit sur le formulaire Livres et sélectionnez Éditer. Ajoutez deux boutons-poussoirs au formulaire, un sous le tableau Auteurs et l'autre sous la tableau Média. Faites un clic droit sur le bouton sous le tableau Auteurs et sélectionnez Contrôle pour afficher le dialogue des propriétés du bouton. Sous l'onglet Général, remplacez le nom par AjouterAuteurs et l'Étiquette par Ajouter Auteurs. Sous l'onglet Événements , cliquez sur le bouton (…), à l'extrémité droite de la ligne, Exécutez l'action, et le dialogue Assigner une action s'affichera. Cliquez sur le bouton Macro… pour afficher le dialogue Sélecteur de macro. Dans l'arborescence sous Library (Bibliothèque), sélectionnez livre.odb > Standard > AppelsForm. Sélectionnez OuvrirFormulaireAuteurs dans la liste Nom de la macro et cliquez sur OK. Cliquez sur OK pour fermer le dialogue Assigner une action. Fermez le dialogue des propriétés des boutons.
Do the same with the button under the Media table, only name it AddMedia, make the label Add Media Type, and assign the macro OpenMediaForm to the Execute Action event. Finally, we need to add the refresh subroutine to our list boxes. Right-click the Authors column in the authors table and select Column. On the Events tab, click the ellipse (…) button beside “When receiving focus”. In the Assign Action button, use the Macro button to assign the ListRefresh macro to the action. This will cause the list to update data from the Authors table when you click on a list box in the column. Do the same for the Media column in the media table. Save your changes to the Books form and close it.
Faites la même chose pour le bouton sous le tableau Média : nommez-le AjouterMédia, donnez-lui l'étiquette Ajouter Type Média et assignez la macro OuvrirFormulaireMedia à l'événement Exécutez l'action.
Enfin, nous devons ajouter la routine pour rafraîchir nos listes déroulantes. Faites un clic droit sur la colonne Auteurs dans le tableau auteurs et sélectionnez Colonne. Sous l'onglet Événements, cliquez sur le bouton (…), à l'extrémité droite de la ligne, À la réception du focus. Dans le bouton Assigner une action, utilisez le bouton Macro… pour assigner la macro RafraîchirListe à l'action. Ainsi, la liste mettra à jour les données du tableau Auteurs quand vous cliquerez sur la liste déroulante dans la colonne. Faites la même chose pour la colonne Média dans le tableau média. Enregistrez vos modifications dans le formulaire Livres et fermez-le.
7
Testing Your Changes Any time we make changes to our forms, we will want to test them and make sure we got everything right, especially in cases where we have used macros. One simple typo could cause things to not work. Double-click the Books form to open it. Add a new book with an author and media type you have not added already. Click the Add Authors button to make sure it opens the form. Add some authors. Close the Authors form. Click on the authors dropdown list box and verify that the authors you added are there. Do the same test with the Add Media Type button and listbox. Final Thoughts and References Again, I would like to emphasize that writing macros in LibreOffice Basic is complex. Documentation is pretty sparse, but it is out there. If you are interested in taking up the challenge, here are some references to get you started: LibreOffice Basic Guide: http://wiki.documentfoundation.org/images/d/dd/BasicGuide_OOo3.2.0.odt Andrew Pitonyak's OpenOffice Macro Information: http://www.pitonyak.org/oo.php You can find the macros used in this How-To on pastebin.com at http://pastebin.com/MU2Ztizi Next time, we will move on to another part of the LibreOffice suite and explore the Math module.
Tester les modifications
Chaque fois que nous changeons quelque chose dans les formulaires, il faut les tester pour nous assurer que tout fonctionne, surtout là où nous avons utilisé des macros. Une seule faute de frappe pourrait causer d'énormes problèmes. Double-cliquez sur le formulaire Livres pour l'ouvrir. Ajoutez-y un nouveau livre dont l'auteur et le type de média n'existent pas encore. Cliquez sur le bouton Ajouter Auteurs pour vérifier qu'il ouvre le formulaire. Ajoutez-y quelques auteurs ; fermez le formulaire Auteurs. Cliquez sur le menu déroulant auteurs et vérifiez que les auteurs que vous venez d'ajouter y figurent. Faites le même test avec le bouton Ajouter Type Média et le menu déroulant.
Quelques réflexions et références pour terminer.
À nouveau, j'aimerais souligner la complexité de l'écriture de macros avec LibreOffice Basic. Il n'y a pas beaucoup de documentation, mais elle existe. Si relever le défi vous intéresse, voici quelques références pour vous aider à commencer :
LibreOffice Basic Guide: http://wiki.documentfoundation.org/images/d/dd/BasicGuide_OOo3.2.0.odt Andrew Pitonyak's OpenOffice Macro Information: http://www.pitonyak.org/oo.php Un livre (payant) en français : http://www.eyrolles.com/Informatique/Livre/programmation-openoffice-org-et-libreoffice-9782212132472
Vous trouverez les macros utilisés dans ce tutoriel sur pastebin.com à http://pastebin.com/MU2Ztizi
La prochaine fois, nous continuerons notre exploration de la suite bureautique LibreOffice avec le module Formule.