Utilisation de procédures, fonctions et propriétés

Ce qui suit décrit l'utilisation de base des procédures, fonctions et propriétés dans LibreOffice Basic.

Lorsque vous créez un nouveau module, LibreOffice Basic insère automatiquement une Sub appelée "Main". Ce nom par défaut n'a rien à voir avec la commande ou le point de départ d'un projet LibreOffice Basic. Vous pouvez également renommer en toute sécurité cette routine Sub.

Certaines restrictions s'appliquent aux noms de vos variables publiques, sous-programmes, fonctions et propriétés. Vous ne devez pas utiliser le même nom que l'un des modules de la même bibliothèque.

Les procédures ( Sub routines), les fonctions ( Function ) et les propriétés ( Property ) vous aident à maintenir une vue d'ensemble structurée en séparant un programme en éléments logiques.

Un avantage des procédures, fonctions et propriétés est que, une fois que vous avez développé un code de programme contenant des composants réalisant certaines tâches, vous pouvez utiliser ce code dans un autre projet.

Passer des variables aux procédures, fonctions ou propriétés

Les variables peuvent être transmises aux procédures, fonctions ou propriétés. La Sub Function ou Property doit être déclarée de manière à recevoir des paramètres:

  Sub SubName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...)
      ' votre code ici
  End Sub

Le Sub est appelé à l'aide de la syntaxe suivante :

  [Call] SubName( [Parameter1:=]Value1, [Parameter2:=]Value2, ...)

Les paramètres passés à un Sub doivent correspondre à ceux spécifiés dans la syntaxe de la déclaration Sub :

Le même processus s'applique à une fonction. De plus, les fonctions renvoient toujours un résultat de fonction. Le résultat d'une fonction est défini en affectant la valeur de retour au nom de la fonction :

  Function FunctionName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...) As TYPENAME
      'votre code ici
      FunctionName=Result
  End Function

La fonction est appelée à l'aide de la syntaxe suivante :

  Variable = FunctionName( [Parameter1:=]Value1, [Parameter2:=]Value2, ...)

Les propriétés combinent la syntaxe des procédures et des fonctions. Une Property nécessite généralement au plus un paramètre.

  Private _IsApproved As TYPENAME
  Property Get IsApproved As TYPENAME
      'votre code ici
      IsApproved = some_computation
  End Property
  Property Let IsApproved(value As TYPENAME)
      'votre code ici
      _IsApproved = computed_value
  End Property

La propriété est appelée à l'aide de la syntaxe suivante :

  var = IsApproved
  IsApproved = some_value

Vous pouvez également utiliser le nom complet pour appeler une procédure, une fonction ou une propriété :
[Call] Library.Module.Macro(), où Call est facultatif .
Par exemple, pour appeler la macro Autotext de la bibliothèque Gimmicks, utilisez la commande suivante :
Gimmicks.AutoText.Main()

Transmission de paramètres par valeur ou par référence

Les paramètres peuvent être transmis à une procédure, une fonction ou une propriété par référence ou par valeur. Sauf indication contraire, un paramètre est toujours transmis par référence. Cela signifie qu'un Sub, une Function ou une Property obtient le paramètre et peut lire et modifier sa valeur.

Si vous souhaitez passer un paramètre par valeur, insérez le mot-clé ByVal devant le paramètre lorsque vous appelez un Sub, une Fonction ou une Propriété, par exemple :

  Function ReadOnlyParms(ByVal p2, ByVal p2)
      'votre code ici
  End Function
  result = ReadOnlyParms(parm1, parm2)

Dans ce cas, le contenu d'origine du paramètre ne sera pas modifié par la fonction car il obtient uniquement la valeur et non le paramètre lui-même.

Définir des paramètres optionnels

Les fonctions, procédures ou propriétés peuvent être définies avec des paramètres facultatifs, par exemple :

  Sub Rounding(number, Optional decimals, Optional format)
      'votre code ici
  End Sub

Arguments positionnels ou mots-clés

Lorsque vous appelez une fonction ou un sous-programme, vous pouvez passer ses arguments par position ou par nom. Passer par position signifie simplement lister les arguments dans l'ordre dans lequel les paramètres sont définis dans la fonction ou le sous-programme. Le passage par nom nécessite de préfixer l'argument avec le nom du paramètre correspondant suivi de deux points et d'un signe égal (:=). Les arguments de mot-clé peuvent apparaître dans n'importe quel ordre. Reportez-vous à la fonction Basic Replace() pour de tels exemples.

Lorsque vous avez besoin de passer moins de paramètres, utilisez des arguments de mots-clés. Passer des valeurs pour moins de paramètres par position nécessite de fournir des valeurs pour tous les paramètres avant eux, facultatifs ou non. Cela garantit que les valeurs sont dans les bonnes positions. Si vous passez les paramètres par nom - en utilisant des arguments mot-clé - vous pouvez omettre tous les autres arguments intermédiaires.

Portée des variables

Une variable définie dans un Sub , une Function ou une Property , ne reste valide que jusqu'à la fin de la procédure. C'est ce qu'on appelle une variable "locale". Dans de nombreux cas, vous avez besoin d'une variable pour être utilisée dans toutes les procédures, dans chaque module de toutes les bibliothèques, ou après un Sub , une Function ou une Property est terminée.

Déclaration de variables en dehors d'un Sub une Function ou une Property

Global VarName As TYPENAME

La variable est valide tant que dure la session LibreOffice.

Public VarName As TYPENAME

La variable est valide dans tous les modules.

Private VarName As TYPENAME

La variable est valide dans ce module.

Dim VarName As TYPENAME

La variable est valide dans ce module.

Exemple pour les variables privées

Forcez les variables privées à être privées entre les modules en définissant CompatibilityMode (True) .

  ' ***** Module1 *****
  Private myText As String
  Sub initMyText
      monTexte = "Bonjour"
      Print "In module1 : ", monTexte
  End Sub
   
  ' ***** Module2 *****
  'Option Explicit
  Sub demoBug
      CompatibilityMode( True )
      initMyText
      ' Now renvoie une chaîne vide
      ' (ou affiche une erreur pour Option Explicit)
      Print "Now in module2 : ", monTexte
  End Sub

Enregistrement du contenu d'une variable après avoir quitté un Sub une Function ou une Property

  Static VarName As TYPENAME

La variable conserve sa valeur jusqu'à la prochaine saisie d'une Function, Sub ou Property. La déclaration doit exister à l'intérieur d'un Sub , d'une Function ou d'une Property .

Spécification du type de valeur de retour d'une fonction ou d'une propriété

Comme pour les variables, incluez un caractère de déclaration de type après le nom de la fonction ou le type indiqué par As et le type de données correspondant à la fin de la liste des paramètres pour définir le type de la fonction ou le retour de la propriété valeur, par exemple:

  Function WordCount(WordText As String) As Integer