GD_DONNEES_DISPONIBLES
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 NomObjetImage GD_DONNEES_DISPONIBLES Format Disponibilite CodeRetour |
||
| Paramètres | ||
| ALPHA(50) Format (E) | Nom du format de données recherché. |
|
| 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 du paramètre Format | ||
| _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. | ||
| Valeurs possibles du CodeRetour | ||
| _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. | |
Remarques :
- Cette méthode n'est pas mise en oeuvre par le générateur Java.
- Elle n'est pas disponible en génération Mobile.
GD_ECRIRE_DONNEES
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 NomObjetImage 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 du CodeRetour | ||
| _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. | |
Remarques :
- Cette méthode n'est pas mise en oeuvre par le générateur Java.
- Elle n'est pas disponible en génération Mobile.
GD_EXECUTER_GLISSEMENT
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 NomObjetImage GD_EXECUTER_GLISSEMENT Format ActionsPermises ActionFaite CodeRetour |
||
| Paramètres | ||
ALPHA(50) Format (E) |
Nom du format de données. |
|
NUM_BIN_4 ActionsPermises (E) |
Actions permises dans l'objet cible. |
|
NUM_BIN_4 ActionFaite (S) |
Action effectuée dans l'objet cible. |
|
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération. |
|
| Valeurs possibles du paramètre Format | ||
_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. |
||
| Valeurs possibles du ActionsPermises | ||
_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. |
|
| Valeurs possibles du ActionFaite | ||
_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). |
|
| Valeurs possibles du CodeRetour | ||
_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. | |
Remarques :
- Cette méthode n'est pas mise en oeuvre par le générateur Java.
- Elle n'est pas disponible en génération Mobile.
GD_LIRE_DONNEES
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 NomObjetImage GD_LIRE_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 du CodeRetour | ||
_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. | |
Remarques :
- Cette méthode n'est pas mise en oeuvre par le générateur Java.
- Elle n'est pas disponible en génération Mobile.
GD_VIDER_DONNEES
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 NomObjetImage GD_VIDER_DONNEES CodeRetour |
||
| Paramètres | ||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération. |
|
| Valeurs possibles du CodeRetour | ||
_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
|
| Conditions d'utilisation | Aucune. | |
Remarques :
- Cette méthode n'est pas mise en oeuvre par le générateur Java.
- Elle n'est pas disponible en génération Mobile.