Téléchargement des produits


Version anglaise


 

Les méthodes permettent de gérer dynamiquement la barre d'outils : il est possible d'ajouter ou de supprimer un outil, et d'en modifier toutes les caractéristiques.

 

Sens affectés aux paramètres des méthodes :

(E)

Entrée

(S)

Sortie

Liste des codes retour des différentes méthodes :

_BAR_ERR_OK

L'exécution de la méthode s'est déroulée correctement.

_BAR_ERR_PARAM

La valeur d'au moins un des paramètres est invalide.

_BAR_ERR_TYPE

Au moins une des variables de la méthode ne possède pas le bon type Adélia.

_BAR_ERR_EXEC

Une anomalie s'est produite en cours d'exécution (ce cas ne doit jamais se produire).

_BAR_ERR_LG_CHAINE

La méthode doit rendre une chaîne de caractères dont la taille est supérieure à celle de la variable Adélia.

 

 

Ajoute un outil à une position donnée.

Le paramètre NomOutil doit être un nom composé uniquement de lettres, de chiffres et du caractère souligné (_). Il ne doit pas être déjà utilisé par un autre outil.

Le paramètre Position doit avoir une valeur comprise entre 1 et le nombre d'outils de la barre d'outils, ou une valeur prédéfinie.

Syntaxe

APPELER_METHODE NomObjet AJOUTER_OUTIL Position NomOutil Styles CodeRetour

Paramètres

Position (E)

NUM_BIN_2

Position du nouvel outil.

Valeurs possibles :

_BAR_POS_FIN : L'outil est ajouté à la fin.

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Styles (E)

NUM_BIN_4

Combinaison (somme) des styles du nouvel outil.

Valeurs possibles :

Styles de comportement : choisir un seul parmi les styles suivants :

_BAR_STL_BTN_BOUTON

L'outil se comporte comme un bouton poussoir (il remonte lorsque l'utilisateur relâche le bouton de la souris).

_BAR_STL_BTN_BASCULE

L'outil se comporte comme une bascule (il reste enfoncé lorsque l'utilisateur relâche le bouton de la souris).

_BAR_STL_BTN_OPTION

L'outil se comporte comme une bascule dans un groupe d'outils (un seul outil peut être enfoncé dans le groupe).

_BAR_STL_BTN_SEP

L'outil est un séparateur.

 

Styles de position (seulement pour les bascules et les options) : choisir un seul parmi les styles suivants :

_BAR_STL_BTN_RELEVE

L'outil est en position relevée.

_BAR_STL_BTN_ENFONCE

L'outil est en position enfoncée.

_BAR_STL_BTN_INDET

L'outil est en position indéterminée.

 

Autres styles pouvant être combinés entre eux et aux précédents :

_BAR_STL_BTN_VISIBLE

L'outil est visible.

_BAR_STL_BTN_ACTIF

L'outil est actif (seulement pour les boutons, les bascules et les options).

_BAR_STL_BTN_SUPP_ESP

Le texte de l'outil contient une lettre soulignée à la place de l'esperluette (seulement pour les boutons, les bascules et les options).

_BAR_STL_BTN_LARG_SPEC

La largeur de l'outil dépend de son texte (seulement pour les boutons, les bascules et les options). Par défaut, les boutons ont une largeur identique suffisante pour afficher tous les textes.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

NUM_BIN_4

Styles

NUM_BIN_4

CodeRetour

/* Création d'un bouton de sauvegarde visible et inactif en première position

Styles=_BAR_STL_BTN_BOUTON + _BAR_STL_BTN_VISIBLE

APPELER_METHODE MA_BARRE AJOUTER_OUTIL 1 'BTN_SAUVE' Styles CodeRetour

 

/* Création d'un outil de type bascule visible, actif et enfoncé en 2ème position

pour la sauvegarde automatique par exemple.

Styles=_BAR_STL_BTN_BASCULE + _BAR_STL_BTN_ENFONCE + _BAR_STL_BTN_VISIBLE

+ BAR_STL_BTN_ACTIF

APPELER_METHODE MA_BARRE AJOUTER_OUTIL 2 'BTN_SAUVE_AUTO' Styles CodeRetour

 

 

Ajuste la position et la taille de la barre d'outils en fonction de son contenu (nombre et texte des boutons) et de ses propriétés (Placement automatique, multiligne, position du texte). Cette méthode est utile lorsque la barre d'outils possède un type de placement automatique qui fixe sa largeur en fonction de celle de la fenêtre mère. Il faut alors appeler cette méthode lorsque l'utilisateur redimensionne la fenêtre mère.

Syntaxe

APPELER_METHODE NomObjet AUTO_AJUSTER CodeRetour

Paramètres

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

Fixe la description d'un outil. Ce texte peut être utilisé pour remplir une barre d'état, par exemple.

Syntaxe

APPELER_METHODE NomObjet FIXER_DESCRIPTION_OUTIL NomOutil Description CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Description (E)

ALPHA(n)

Description de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

 

 

Fixe l'image d'un outil à partir d'un fichier.

Syntaxe

APPELER_METHODE NomObjet FIXER_IMAGE_FICHIER_OUTIL NomOutil Fichier CodeRetour

Paramètres

 

 

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Fichier (E)

ALPHA(n)

Nom complet du fichier qui contient l'image. Les extensions admises pour le fichier Bitmap sont : bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf. Avec le runtime Adélia Mobile, seuls les formats suivants sont supportés : bmp, gif, jpg, png et ico.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

 

 

Fixe l'image d'un outil à partir d'une variable Adélia de type IMAGE.

Le contenu de la variable est soit une image au format DIB (Device Independent Bitmap) soit un fichier contenant une image avec comme extension possible : bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf.

Syntaxe

APPELER_METHODE NomObjet FIXER_IMAGE_OUTIL NomOutil Image CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Image (E)

BITMAP

Image de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

Fixe l'image d'un outil à partir d'une image accessible depuis une adresse URL.

Les extensions admises pour le fichier image sont : bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf.

Syntaxe

APPELER_METHODE NomObjet FIXER_IMAGE_URL_OUTIL NomOutil ImageUrl CodeRetour

Paramètres

ALPHA(30) NomOutil

Nom de l'outil (paramètre en entrée).

ALPHA(500) ImageUrl

Adresse URL désignant le fichier Image (paramètre en entrée).

NUM_BIN_4 CodeRetour

Code retour de la méthode (paramètre en sortie).

Valeurs possibles du CodeRetour :

-1 : Erreur lors de l'ajout de l'image

> 0 : Erreur lors de l'exécution de la requête http

0 : Opération correctement effectuée

 

Remarque : cette méthode n'est mise en oeuvre ni par le générateur Java, ni par le générateur Mobile.

 

Fixe les styles d'un outil.

Syntaxe

APPELER_METHODE NomObjet FIXER_STYLES_OUTIL NomOutil Styles CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Styles (E)

NUM_BIN_4

Styles de l'outil.

Valeurs possibles : Voir la méthode AJOUTER_OUTIL, plus haut.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

NUM_BIN_4

Styles

NUM_BIN_4

CodeRetour

/* On fixe le style du bouton de sauvegarde pour qu'il soit activable

Styles=_BAR_STL_BTN_BOUTON + _BAR_STL_BTN_VISIBLE + _BAR_STL_BTN_ACTIF

APPELER_METHODE MA_BARRE FIXER_STYLES_OUTIL 'BTN_SAUVE' Styles CodeRetour

 

 

Fixe le texte de l'infobulle d'un outil.

Syntaxe

APPELER_METHODE NomObjet FIXER_TEXTE_INFO_OUTIL NomOutil TexteInfobulle CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

TexteInfobulle (E)

ALPHA(n)

Texte de l'infobulle.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

 

Remarque : cette méthode n'est pas disponible en génération Mobile pour les plateformes Pocket PC et Smartphone.


Fixe le texte d'un outil.

Syntaxe

APPELER_METHODE NomObjet FIXER_TEXTE_OUTIL NomOutil Texte CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Texte (E)

ALPHA(n)

Texte de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

 

 

Modifie les styles d'un outil par ajout et suppression.

Syntaxe

APPELER_METHODE NomObjet MODIFIER_STYLES_OUTIL NomOutil StylesAjoutes StylesSupprimes CodeRetour
Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

StylesAjoutes (E)

NUM_BIN_4

Styles ajoutés à l'outil.

Valeurs possibles : Voir la méthode AJOUTER_OUTIL, plus haut.

StylesSupprimes (E)

NUM_BIN_4

Styles supprimés de l'outil.

Valeurs possibles : Voir la méthode AJOUTER_OUTIL, plus haut.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

NUM_BIN_4

StylesAjoutes

NUM_BIN_4

StylesSupprimes

NUM_BIN_4

CodeRetour

/* Désactivation du bouton de sauvegarde

StylesSupprimes=_BAR_STL_BTN_ACTIF

APPELER_METHODE MA_BARRE MODIFIER_STYLES_OUTIL 'BTN_SAUVE' 0 StylesSupprimes CodeRetour

 

/* Transformation d'un outil se comportant comme un bouton en bascule enfoncée

/* Les autres styles sont conservés

StylesAjoutes=_BAR_STL_BTN_BASCULE + _BAR_STL_BTN_ENFONCE

StylesSupprimes=_BAR_STL_BTN_BOUTON

APPELER_METHODE MA_BARRE MODIFIER_STYLES_OUTIL 'BTN_BASCULE' StylesAjoutes StylesSupprimes CodeRetour

 

 

Permet de tester si un outil possède un ou plusieurs styles. La méthode rend la valeur *VRAI si l'outil possède tous les styles de la combinaison donnée.

Syntaxe

APPELER_METHODE NomObjet OUTIL_POSSEDE_STYLES NomOutil Styles Possession CodeRetour
Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Styles (E)

NUM_BIN_4

Styles de l'outil.

Valeurs possibles : Voir la méthode AJOUTER_OUTIL, plus haut.

Possession (S)

BOOL

Vaut *VRAI si l'outil possède tous les styles donnés, *FAUX sinon.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

NUM_BIN_4

Styles

BOOL

Possession

NUM_BIN_4

CodeRetour

/* Si l'outil est un bouton visible est actif

Styles=_BAR_STL_BTN_BOUTON + _BAR_STL_BTN_VISIBLE

APPELER_METHODE MA_BARRE OUTIL_POSSEDE_STYLES 'BTN' Styles Possession CodeRetour

/* Possession vaut alors *VRAI

Styles=_BAR_STL_BTN_VISIBLE + _BAR_STL_BTN_ACTIF

APPELER_METHODE MA_BARRE OUTIL_POSSEDE_STYLES 'BTN' Styles Possession CodeRetour

/* Possession vaut alors *VRAI

Styles=_BAR_STL_BTN_BASCULE + _BAR_STL_BTN_VISIBLE

APPELER_METHODE MA_BARRE OUTIL_POSSEDE_STYLES 'BTN' Styles Possession CodeRetour

/* Possession vaut alors *FAUX

 

 

Rend la description d'un outil.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_DESCRIPTION_OUTIL NomOutil Description CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Description (S)

ALPHA(n)

Description de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

_BAR_ERR_LG_CHAINE

 

 

Rend l'image d'un outil dans une variable Adélia de type IMAGE. L'image est au format DIB.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_IMAGE_OUTIL NomOutil Image CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Image (S)

IMAGE

Image de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

Rend le nom de l'outil situé à la position donnée.

Le paramètre Position doit avoir une valeur comprise entre 1 et le nombre d'outils de la barre d'outils.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_NOM_OUTIL Position NomOutil CodeRetour
Paramètres

Position (E)

NUM_BIN_2

Position de l'outil.

NomOutil (S)

ALPHA(30)

Nom de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

Récupère les styles d'un outil.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_STYLES_OUTIL NomOutil Styles CodeRetour
Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Styles (S)

NUM_BIN_4

Styles de l'outil.

Valeurs possibles : Voir la méthode AJOUTER_OUTIL, plus haut.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

Rend le texte de l'infobulle d'un outil.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_TEXTE_INFO_OUTIL NomOutil TexteInfobulle CodeRetour
Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

TexteInfobulle (S)

ALPHA(n)

Texte de l'infobulle.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

_BAR_ERR_LG_CHAINE

 

Remarque : cette méthode n'est pas disponible en génération Mobile pour les plateformes Pocket PC et Smartphone.


Rend le texte d'un outil.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_TEXTE_OUTIL NomOutil Texte CodeRetour
Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

Texte (S)

ALPHA(n)

Texte de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

_BAR_ERR_TYPE

_BAR_ERR_LG_CHAINE

 

 

Supprime l'outil de nom donné.

Syntaxe

APPELER_METHODE NomObjet SUPPRIMER_OUTIL NomOutil CodeRetour

Paramètres

NomOutil (E)

ALPHA(30)

Nom de l'outil.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Valeurs possibles :

_BAR_ERR_OK

_BAR_ERR_PARAM

 

 

 

 

 

↑ Haut de page