Υπογραφές μεθόδου ScriptForge

Περιεχόμενα
Δείκτης 🔎︎

# Υπογραφές μεθόδου του ScriptForge

Οι βιβλιοθήκες ScriptForge συγκεντρώνουν πόρους σεναρίων μακροεντολών για το LibreOffice που θα κληθούν από μακροεντολές Basic ή σενάρια Python. Οι ενότητες και οι κλάσεις του καλούνται από σενάρια χρήστη ως "Υπηρεσίες" που εκθέτουν ιδιότητες, μεθόδους και συμβάντα.

- Κάθε φορά που προτείνονται μέθοδοι υπηρεσίας αποκλειστικά για το LibreOffice Basic, η παρουσίαση της σύνταξης τους ταιριάζει με εκείνη των βασικών υπορουτινών, συναρτήσεων ή ιδιοτήτων.

- Κάθε φορά που προτείνονται μέθοδοι υπηρεσίας για Python και Basic, ή αποκλειστικά για Python, η σύνταξη και τα ορίσματά τους χρησιμοποιούν μια συγκεκριμένη διάταξη κειμένου.

## Μέθοδος υπηρεσίας μόνο για Basic

Τυπογραφικοί χαρακτήρες όπως αγκύλες, έλλειψη ή άγκιστρα υποδηλώνουν προαιρετικά, επαναλαμβανόμενα ή υποχρεωτικά ορίσματα:

- [opt1|opt2|opt3] Στοιχεία μέσα σε αγκύλες είναι προαιρετικά, τα αναλλακτικά υποδεικνύονται με μια κατακόρυφη γραμμή,

- case[[sep]…] Μια έλλειψη δείχνει μια πιθανή επανάληψη, ένα προαιρετικό διαχωριστικό μπορεί να καθοριστεί,

- {choice1|choice2} Στοιχεία μέσα σε άγκιστρα είναι υποχρεωτικά, τα εναλλακτικά υποδεικνύονται με μια κατακόρυφη γραμμή.

### Παράδειγμα:

           FSO.HashFile(FileName As String, _
               Algorithm As String = {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}) As String
           SF_Array.ImportFromCSVFile(FileName As String, _
               [Delimiter = ","], [DateFormat As String]) As Variant
           SF_String.SplitNotQuoted(InputStr As String, _
              [Delimiter As String], [Occurrences As Long], [QuoteChar As String]) As Variant

## Μέθοδοι υπηρεσίας Python ή Basic

Οι ακόλουθοι τυπογραφικοί κανόνες συνδυάζουν τη σημειογραφία UML, τη διάταξη τεκμηρίωσης API και τη διεπαφή χρήστη του επιθεωρητή αντικειμένων UNO:

- Οι προαιρετικές παράμετροι υποδεικνύονται είτε με opt, '=' που συνοδεύουν μια προεπιλεγμένη τιμή, ή αγκύλες '[ ]'.

- τα ορίσματα είναι πεζά, προκειμένου να συμμορφωθούν με το Python PEP 8, ενώ στη Basic είναι χωρίς διάκριση πεζών/κεφαλαίων.

- Τα ορίσματα συλλογών ή οι ακολουθίες API υποδηλώνονται χρησιμοποιώντας πολλαπλότητα UML. Αυτό ισχύει και για τις επιστρεφόμενες τιμές.

- Οι τύποι δεδομένων της Basic και οι σχολιασμοί της Python μεταφέρονται συντακτικά ως:

LibreOffice Basic | Σύνταξη | Python
Τιμή Μπουλ | bool | bool
Date | datetime | datetime
Double | float | float
Integer | int | int
Long | int | int
Object | obj |
Single | float | float
String | str | str
Variant | any |
Αντικείμενο UNO | uno |
Τύπος χρήστη (UDT) | obj |
Υπηρεσία ScriptForge | svc |

### Παράδειγμα:

svc.Forms( opt form: any ): svc[0..*]

svc.MsgBox( prompt: str, buttons = svc.MB_OK , opt title: str ): opt str

svc.InputBox( prompt: str, default = "", [ title: str ], [ xpostwips: int, ypostwips: int ] ): str