Téléchargement des produits


Version anglaise


 

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

(E)

Entrée

(S)

Sortie

(E/S)

Entrée et Sortie

Codes d'erreur pouvant être retournés :

_GIC_ERR_SUCCES

La fonction s'est exécutée correctement.

_GIC_ERR_ERREUR

Une erreur inattendue s'est produite.

_GIC_ERR_INDEX_PAGE_INVALIDE

L'index de la page est invalide.

_GIC_ERR_PARAMETRE_INVALIDE

Un paramètre de la fonction est invalide.

_GIC_ERR_POSITION_INVALIDE

La position de l'icône est invalide (soit hors de la grille, soit car il existe déjà une icône à cette position).

_GIC_ERR_ID_ICONE_INVALIDE

L'identifiant de l'icône est invalide (il n'existe pas ou il s'agit d'un doublon).

Ajoute une icône sur la page.

Syntaxe


APPELER_METHODE NomObjet AJOUTER_ICONE Index X Y Id Image Titre CodeRetour

Paramètres


NUM_BIN_4 Index (E)

Index de la page.

NUM_BIN_4 x (E)

Position horizontale de l'icône, la valeur doit être comprise entre 1 et la largeur de la grille.

NUM_BIN_4 y (E)

Position verticale de l'icône, la valeur doit être comprise entre 1 et la hauteur de la grille.

ALPHA(250) Id (E/S)

Identifiant de l'icône. La valeur sera renvoyée dans la propriété ID_ICONE sur les événements ClicIcone et DoubleClicIcone.

Si la valeur n'est pas fournie, un identifiant unique sera généré et retourné en sortie.

IMAGE Image (E)

Image de l'icône.

ALPHA(250) Titre (E)

Titre de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Ajoute une page.

Syntaxe


APPELER_METHODE NomObjet AJOUTER_PAGE Index Titre CodeRetour

Paramètres


NUM_BIN_4 Index (E/S)

Index de la page ou -1 pour ajouter en fin de liste.

Si -1 l'index est renvoyé en retour.

ALPHA(250) Titre (E)

Titre de la page (optionnel).

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.

Aligne les icônes dans la page sélectionnée, horizontalement ou verticalement, optionnellement en les triant par nom.

Syntaxe


APPELER_METHODE NomObjet ALIGNER_ICONES Page Vertical Tri CodeRetour

Paramètres


NUM_BIN_4 P (E)

Numéro de la page.

BOOL Vertical (E)

Si *VRAI, les icônes sont alignés verticalement (remplissage des colonnes en premier), sinon elles le sont horizontalement (remplissage des lignes en premier).

BOOL Tri (E)

Si *VRAI, les icônes sont triées par nom.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.

Modifie les couleurs du texte, du fond et des bordures d'une icône.

Syntaxe


APPELER_METHODE NomObjet FIXER_COULEURS_ICONE Id CouleurTexte CouleurFond CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône

NUM_BIN_4 CouleurTexte (E)

Couleur du texte

NUM_BIN_4 CouleurOmbre (E)

Couleur de l'ombre du texte

NUM_BIN_4 CouleurFond (E)

Couleur du fond

NUM_BIN_4 CouleurBordure (E)

Couleur de la bordure de l'icône

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération

Conditions d'utilisation

Aucune

Modifie les couleurs du texte de notification d'une icône.

Syntaxe


APPELER_METHODE NomObjet FIXER_COULEURS_NOTIF_ICONE Id CouleurTexte CouleurFond CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

NUM_BIN_4 CouleurTexte (E)

Couleur du texte de notification.

NUM_BIN_4 CouleurFond (E)

Couleur du fond du texte de notification.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.

Modifie les données associées à une icône.

Syntaxe


APPELER_METHODE NomObjet FIXER_DONNEES_ICONE Id Donnees CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

ALPHA(4096) Donnees (E)

Données associées à l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Modifie l'image d'une icône.

Syntaxe


APPELER_METHODE NomObjet FIXER_IMAGE_ICONE Id Icone CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

IMAGE Icone (E)

Image de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Modifie la position d'une icône dans la page.

Syntaxe


APPELER_METHODE NomObjet FIXER_POSITION_ICONE Id X Y CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

NUM_BIN_4 X (E)

Position horizontale de l'icône, la valeur doit être comprise entre 1 et la largeur de la grille.

NUM_BIN_4 Y (E)

Position verticale de l'icône, la valeur doit être comprise entre 1 et la hauteur de la grille.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Modifie le texte d'une icône.

Syntaxe


APPELER_METHODE NomObjet FIXER_TEXTE_ICONE Id Texte CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

ALPHA(250) Texte (E)

Texte de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Modifie le texte de notification d'une icône.

Syntaxe


APPELER_METHODE NomObjet FIXER_TEXTE_NOTIF_ICONE Id TexteNotif CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

ALPHA(250) TexteNotif (E)

Texte de notification de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Cette méthode indique si des données d'un format spécifié sont disponibles parmi les données concernées par l'opération de glisser-déposer en cours. Le format est un format prédéfini sous Windows, ou peut être un format défini par le développeur.

Syntaxe


APPELER_METHODE NomObjet GD_DONNEES_DISPONIBLES Format Disponibilite CodeRetour

Paramètres


ALPHA(50) Format (E)

Nom du format de données recherché.

Valeurs possibles :

_CF_TEXT

 Format pour une donnée de type texte au format ANSI.

_CF_OEMTEXT

Format pour une donnée de type texte au format OEM.

_CF_UNICODETEXT

Format pour une donnée de type texte au format UNICODE.

_CF_DIB

Format pour une donnée de type DIB (Device Independant Bitmap).

_CF_HDROP

Format pour une donnée de type liste de fichier et/ou de dossier (format utilisé notamment lors d'une action glisser-déposer initiée depuis l'explorateur Windows).



Une chaîne quelconque qui ne commence pas par "CF_" pour un format défini par le développeur.

BOOL Disponibilite (S)

La valeur est à *VRAI si des données du format souhaité sont disponibles.

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK

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

_ERR_CTX_UTILISATION

La méthode est utilisée en dehors d'un événement autorisé pour cette méthode.

_ERR_FORMAT_INVALIDE

Le nom de format passé en paramètre ne correspond à aucune donnée ou est invalide.

Conditions d'utilisation

La méthode ne peut être utilisée que sur les événements GD_EntreeGlissement, GD_SurvolGlissement et GD_Depose.



Cette méthode ajoute des données (le contenu des variables Adélia) aux données qui seront transmises par une opération de glisser-déposer. Ces informations sont stockées dans l'objet jusqu'à la fin de l'opération de glisser-déposer, puis sont effacées automatiquement.


Remarques :

    • L'appel de cette méthode avec un tableau de n éléments est équivalent à n appels de cette méthode avec une variable contenant les éléments du tableau.
    • Aucune distinction n'est faite entre les types numériques étendu et condensé.


Syntaxe


APPELER_METHODE NomObjet GD_ECRIRE_DONNEES VarAdelia NbDonnees CodeRetour

Paramètres


Types possibles pour le paramètre VarAdelia (E) :


ALPHA, DATE, TIME, NUM_E, NUM_P, NUM_BIN_2, NUM_BIN_4, BOOL, TIMESTAMP, IMAGE

Variable ou tableau contenant les données.

NUM_BIN_4 NbDonnees (E/S)

Nombre d'informations à ajouter.

Ce paramètre doit être égal à 1 pour une variable, et doit être inférieur ou égal au nombre d'éléments du tableau pour un tableau.

Après appel de la méthode, il contient le nombre d'informations écrites.

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK

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

_ERR_TYPE_INVALIDE

Une variable utilisée dans la méthode ne possède pas un type Adélia adéquat.

_ERR_PARAM_INVALIDE

La valeur d'au moins un paramètre de la méthode est invalide.

Conditions d'utilisation

Aucune.


Cette méthode provoque le début d'une opération de glisser-déposer entre un objet source et un objet cible avec les données stockées dans l'objet source par la méthode GD_ECRIRE_DONNEES.

Les données concernées peuvent être soit copiées, soit déplacées dans l'objet cible.

L'ensemble de ces données est identifié par un nom de format. Le format est un format prédéfini sous Windows, ou peut être un format défini par le développeur.


Remarque : dans le cas de l'utilisation d'un format prédéfini, seule la première donnée écrite par la méthode GD_ECRIRE_DONNEES est prise en compte.


Syntaxe


APPELER_METHODE NomObjet GD_EXECUTER_GLISSEMENT Format ActionsPermises ActionFaite CodeRetour

Paramètres


ALPHA(50) Format (E)

Nom du format de données.

Valeurs possibles :

_CF_TEXT

Format pour une donnée de type texte au format ANSI.

_CF_OEMTEXT

Format pour une donnée de type texte au format OEM.

_CF_UNICODETEXT

Format pour une donnée de type texte au format UNICODE.

_CF_DIB

Format pour une donnée de type DIB (Device Independant Bitmap).

Une chaîne quelconque qui ne commence pas par "CF_" pour un format défini par le développeur, et qui regroupe l'ensemble des données écrites.

NUM_BIN_4 ActionsPermises (E)

Actions permises dans l'objet cible.

Valeurs possibles :

_GD_ACTION_COPIE

Les données sont copiées dans l'objet cible.

_GD_ACTION_DEPLACEMENT

Les données sont déplacées dans l'objet cible (et donc supprimées dans l'objet source).

_GD_ACTION_COPIE_DEPLACE

La somme des deux actions précédentes.

NUM_BIN_4 ActionFaite (S)

Action effectuée dans l'objet cible.

Valeurs possibles :

_GD_ACTION_AUCUNE

L'utilisateur a relâché le bouton de la souris au-dessus d'un objet n'acceptant pas les données ou a annulé l'opération par la touche Echap.

_GD_ACTION_COPIE

Les données doivent être copiées dans l'objet cible.

_GD_ACTION_DEPLACEMENT

Les données doivent être déplacées dans l'objet cible (et donc supprimées dans l'objet source).

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK

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

_ERR_PARAM_INVALIDE

La valeur d'au moins un paramètre de la méthode est invalide.

_ERR_CTX_UTILISATION

La méthode est utilisée en dehors d'un événement autorisé pour cette méthode.

_ERR_AUCUNE_DONNEE

Aucune donnée n'a été stockée pour une action de glisser-déposer.

_ERR_FORMAT_INVALIDE

Le nom de format passé en paramètre est invalide.

Conditions d'utilisation

La méthode doit être utilisée sur l'événement GD_DebutGlissement.



Cette méthode permet de lire les données qui sont transmises dans l'opération de glisser-déposer en cours. Ces données sont une copie des données écrites dans l'objet source par la méthode GD_ECRIRE_DONNEES.

Cette méthode doit être utilisée en boucle pour parcourir toutes les données d'un type Adélia donné.

Toutes les données d'un type sont lues lorsque le nombre de données lues est strictement inférieur au nombre de données à lire.


Remarques :

    • L'appel de cette méthode avec un tableau Adélia de n éléments est équivalent à n appels de cette méthode avec une variable Adélia.
    • Si la méthode GD_ECRIRE_DONNEES a été utilisée pour écrire n enregistrements dont chacun contient deux variables de type ALPHA, la méthode GD_LIRE_DONNEES doit être utilisée deux fois avec les indices (2n - 1) et 2n pour récupérer les chaînes du énième enregistrement, ou une fois avec l'indice (2n-1) et un tableau recevant 2 données.
    • Aucune distinction n'est faite entre les variables de type numérique étendu et condensé, quels que soient la longueur et le nombre de décimales. Les valeurs des variables de type numérique ou étendu peuvent donc être tronquées lors de la lecture. Quant aux chaînes, la lecture échoue si la taille de la variable Adélia est insuffisante pour contenir la chaîne lue.


Syntaxe


APPELER_METHODE NomObjet GD_RECUPERER_DONNEES Format VarAdelia Indice NbDonnees CodeRetour

Paramètres


ALPHA(50) Format (E)

Nom du format de données recherché.

Types possibles pour le paramètre VarAdelia (E) :

ALPHA, DATE, TIME, NUM_E, NUM_P, NUM_BIN_2, NUM_BIN_4, BOOL, TIMESTAMP, IMAGE

Variable ou tableau recevant les données.

NUM_BIN_4 Indice (E)

Indice de la donnée à lire pour un type donné.

La première donnée possède l'indice 1.

NUM_BIN_4 NbDonnees (E/S)

Nombre d'informations à ajouter.

Ce paramètre doit être égal à 1 pour une variable, et doit être inférieur ou égal au nombre d'éléments du tableau pour un tableau.

Après appel de la méthode, il contient le nombre d'informations écrites.

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK

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

_ERR_CTX_UTILISATION

La méthode est utilisée en dehors d'un événement autorisé pour cette méthode.

_ERR_TYPE_INVALIDE

Une variable utilisée dans la méthode ne possède pas un type Adélia adéquat.

_ERR_PARAM_INVALIDE

La valeur d'au moins un paramètre de la méthode est invalide.

_ERR_LG_CHAINE

Les données à lire contiennent une chaîne de caractères dont la taille est supérieure à celle de la variable Adélia.

_ERR_VAR_NON_DISPO

Les données à lire ne possèdent pas d'information du type Adélia demandé.

_ERR_FORMAT_INVALIDE

Le nom de format passé en paramètre ne correspond à aucune donnée ou est invalide.

Conditions d'utilisation :

La méthode ne peut être utilisée que sur les événements GD_EntreeGlissement, GD_SurvolGlissement et GD_Depose.


Cette méthode efface les données stockées dans l'objet qui seraient utilisées dans une opération de glisser-déposer.

Ces données ont été créées auparavant par la méthode GD_ECRIRE_DONNEES.

Syntaxe


APPELER_METHODE NomObjet GD_VIDER_DONNEES CodeRetour

Paramètres


NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK

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

Conditions d'utilisation

Aucune.


Récupère l'identifiant de l'icône à la position sélectionnée, ou *BLANK si la position est vide.

Syntaxe


APPELER_METHODE NomObjet ICONE_A Page X Y Id CodeRetour

Paramètres


NUM_BIN_4 P (E)

Numéro de la page.

NUM_BIN_4 X (E)

Position horizontale de l'icône, la valeur doit être comprise entre 1 et la largeur de la grille.

NUM_BIN_4 Y (E)

Position verticale de l'icône, la valeur doit être comprise entre 1 et la hauteur de la grille.

ALPHA(250) Id (S)

Identifiant de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.

Récupère les couleurs du texte, du fond et des bordures d'une icône.

Syntaxe


APPELER_METHODE NomObjet RECUPERER_COULEURS_ICONE Id CouleurTexte CouleurFond CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

NUM_BIN_4 CouleurTexte (S)

Couleur du texte.

NUM_BIN_4 CouleurOmbre (S)

Couleur de l'ombre du texte.

NUM_BIN_4 CouleurFond (S)

Couleur du fond.

NUM_BIN_4 CouleurBordure (S)

Couleur de la bordure de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.

Récupère les couleurs du texte de notification d'une icône.

Syntaxe


APPELER_METHODE NomObjet RECUPERER_COULEURS_NOTIF_ICONE Id CouleurTexte CouleurFond CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

NUM_BIN_4 CouleurTexte (S)

Couleur du texte de notification.

NUM_BIN_4 CouleurFond (S)

Couleur du fond du texte de notification.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Récupère les données associées à une icône

Syntaxe


APPELER_METHODE NomObjet RECUPERER_DONNEES_ICONE Id Donnees CodeRetour

Paramètres

ALPHA(250) Id (E)

Identifiant de l'icône.

ALPHA(4096) Donnees (S)

Données associées à l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Récupère l'image d'une icône.

Syntaxe


APPELER_METHODE NomObjet RECUPERER_IMAGE_ICONE Id Icone CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

IMAGE Icone (S)

Icône de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Récupère la position d'une icône dans la page.

Syntaxe


APPELER_METHODE NomObjet RECUPERER_POSITION_ICONE Id X Y CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

NUM_BIN_4 X (S)

Position horizontale de l'icône.

NUM_BIN_4 Y (S)

Position verticale de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Récupère le texte d'une icône.

Syntaxe


APPELER_METHODE NomObjet RECUPERER_TEXTE_ICONE Id Texte CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

ALPHA(250) Texte (S)

Texte de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Récupère le texte de notification d'une icône.

Syntaxe


APPELER_METHODE NomObjet RECUPERER_TEXTE_NOTIF_ICONE Id TexteNotif CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

ALPHA(250) TexteNotif (S)

Texte de notification de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Supprime une icône.

Syntaxe


APPELER_METHODE NomObjet SUPPRIMER_ICONE Id CodeRetour

Paramètres


ALPHA(250) Id (E)

Identifiant de l'icône.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.



Supprime une page.

Syntaxe


APPELER_METHODE NomObjet SUPPRIMER_PAGE Index CodeRetour

Paramètres


NUM_BIN_4 Index (E)

Index de la page à supprimer.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Conditions d'utilisation

Aucune.





↑ Haut de page