Actiona Wiki

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
====== Window ======
Objet de gestion de fenêtre qui peut être utilisé pour représenter une fenêtre sur le bureau.

===== Fonctions =====

==== Window ====
Fonction constructeur.

=== Syntaxe ===
<code javascript>
var monObjet = new Window();
</code>
<code javascript>
var monObjet = new Window(otherWindow);
</code>

=== Arguments ===
  - otherWindow - (Window) autre fenêtre pour copier

=== Exceptions ===
  * (ParameterTypeError) Type de paramètre incorrect
  * (ParameterCountError) Nombre de paramètres incorrectes

=== Exemple ===
Créer une fenêtre non valide.
<code javascript>
var monObjet = new Window();
</code>
Créer une fenêtre représentant une copie de **otherWindow**.
<code javascript>
var monObjet = new Window(otherWindow);
</code>

==== all ====
Retourne un tableau de la fenêtre représentant l'ensemble des fenêtres sur le bureau.

=== Syntaxe ===
<code javascript>
Window.all();
</code>

=== Renvoie ===
  * (array) un tableau de fenêtre

=== Exemple ===
Cet exemple permet d'imprimer tous les titres des fenêtres dans la console.
<code javascript>
var fenetres = Window.all();
for(var i = 0; i < fenetres.length; ++i)
    Console.print(fenetres[i].title() + "\n");
</code>

==== find ====
Recherches des fenêtres correspondant à certains critères. Tout critère omis n'est pas utilisé. Seules les fenêtres correspondant à tous les critères sont retournés.

=== Syntaxe ===
<code javascript>
Window.find(paramètres);
</code>

=== Arguments ===
  - paramètres - (object) paramètres de recherche
    * title - (string) titre de la fenêtre
    * titleMode - (enum) voir [[#match_mode|match modes]] pour la liste des valeurs possibles
    * titleCaseSensitive - (bool) réglez ce paramètre sur vrai si vous voulez le titre correspondant à la casse
    * className - (string) nom de classe de la fenêtre
    * classNameMode - (enum) voir [[#match_mode|match modes]] pour la liste des valeurs possibles
    * classNameCaseSensitive - (bool) réglez ce paramètre sur vrai si vous voulez le nom de classe correspondant à la casse
    * processId - (integer) définir cela à un ID de processus pour obtenir les fenêtres uniquement détenue par ce processus
    * process - (ProcessHandle) définir cela à une instance d'un ID de ProcessHandle pour obtenir les fenêtres uniquement détenue par ce processus

=== Renvoie ===
  * (array) un tableau de la fenêtre trouvés

=== Exceptions ===
  * (ProcessHandleError) invalides ProcessHandle

=== Exemple ===
Trouvez la fenêtre appelée «Notepad».
<code javascript>
var fenetres = Window.find({
	title: "Notepad"
});
</code>
Trouve les fenêtres dont le titre commence par “Notepad”, en utilisant des métacaractères (wildcards).
<code javascript>
var fenetres = Window.find({
	title: "Notepad*",
	titleMode: Window.Wildcard
});
</code>
Vous pouvez utiliser le code suivant pour afficher le nom de toutes les fenêtres trouvées:
<code javascript>
for(var i = 0; i < windows.length; ++i)
	Console.print(windows[i].title() + "\n");
</code>

===== Méthodes ===== 

==== clone ====
Retourne une copie de cette fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.clone();
</code>

=== Renvoie ===
  * (Window) une copie de cette fenêtre

=== Exemple ===
<code javascript>
var copyDeMonObjet = monObjet.clone();
</code>


==== equals ====
Retourne vrai si cette fenêtre et l'autre sont la même fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.equals(autres);
</code>

=== Arguments ===
  - Autres - (Window) une autre fenêtre

=== Renvoie ===
  * (bool) vrai si ** Autres ** est référençant la même fenêtre

=== Exemple ===
<code javascript>
if(monPremierObjet.equals(monDeuxiemeObjet))
	//Faire quelque chose
</code>

==== toString ====
Renvoie une chaîne représentant cette fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.toString();
</code>

=== Renvoie ===
  * (string) une chaîne représentant cette fenêtre

=== Exemple ===
<code javascript>
Console.print(monObjet.toString());
</code>

=== Notes ===
Cette méthode est appelée automatiquement lorsque vous essayez de convertir une fenêtre à une chaîne.

==== isValid ====
Retourne vrai si cette fenêtre est une fenêtre de référencement, sinon retourne faux.

=== Syntaxe ===
<code javascript>
monObjet.isValid();
</code>

=== Renvoie ===
  * (bool) vrai si cette fenêtre est une fenêtre de référencement

=== Exemple ===
<code javascript>
if(monObjet.isValid())
	//Faire quelque chose
</code>

==== title ====
Retourne le titre de la fenêtre actuelle.

=== Syntaxe ===
<code javascript>
monObjet.title();
</code>

=== Renvoie ===
  * (string) le titre de la fenêtre référencé

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides

=== Exemple ===
<code javascript>
Console.print(monObjet.title());
</code>

==== className ====
Retourne le nom de la classe de la fenêtre courante.

=== Syntaxe ===
<code javascript>
monObjet.className();
</code>

=== Renvoie ===
  * (string) le nom de classe de la fenêtre référencé

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides

=== Exemple ===
<code javascript>
Console.print(monObjet.className());
</code>


==== isActive ====
Retourne vrai si cette fenêtre est la fenêtre au premier plan, sinon retourne faux.

=== Syntaxe ===
<code javascript>
monObjet.isActive();
</code>

=== Renvoie ===
  * (bool) vrai si cette fenêtre est la fenêtre au premier plan

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides

==== rect ====
Retourne un [[en:code:core:rect|Rect]] représentant le rectangle de la fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.rect();
</code>
<code javascript>
monObjet.rect(utiliseLesBordures);
</code>

=== Arguments ===
 - utiliseLesBordures - (bool) prend en compte les bordures de la fenêtre (valeur par défaut : vrai) [//Ajouté dans Actionaz 3.2.0.//]

=== Renvoie ===
  * (Rect) un [[en:code:core:rect|Rect]] représentant le rectangle de la fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides

==== process ====
Retourne un [[en:code:core:processhandle|ProcessHandle]] représentant le processus propriétaire de la fenêtre.

=== Syntaxe ===
<code javascript>
myObject.process();
</code>

=== Renvoie ===
  * (ProcessHandle) un [[en:code:core:processhandle|ProcessHandle]] représentant le processus propriétaire de la fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides

==== close ====
Ferme une fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.close();
</code>

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (CloseWindowError) incapable de fermer la fenêtre

==== killCreator ====
Tuez le processus propriétaire de cette fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.killCreator();
</code>

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (KillCreatorError) incapables de tuer le propriétaire de la fenêtre


==== setForeground ====
Définir cette fenêtre au premier plan.

=== Syntaxe ===
<code javascript>
monObjet.setForeground();
</code>

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (SetForegroundError) incapable de définir cette fenêtre au premier plan


==== minimize ====
Réduit la fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.minimize();
</code>

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (MinimizeError) incapable de réduire la fenêtre

==== maximize ====
Maximise la fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.maximize();
</code>

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (MaximizeError) incapable de maximiser la fenêtre


==== move ====
Déplace la fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.move(point);
</code>

=== Arguments ===
  - point - ([[en:code:core:point|Point]]) point où déplacer la fenêtre

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (MoveError) incapable de déplacer la fenêtre

==== resize ====
Redimensionnez la fenêtre.

=== Syntaxe ===
<code javascript>
monObjet.resize(taille);
</code>
<code javascript>
monObjet.resize(taille, utiliseLesBordures);
</code>

=== Arguments ===
  - taille - ([[en:code:core:size|Size]]) la nouvelle taille de la fenêtre
  - utiliseLesBordures - (bool) prend en compte les bordures de la fenêtre (valeur par défaut : vrai) [//Ajouté dans Actionaz 3.2.0.//]

=== Renvoie ===
  * (Window) cette fenêtre

=== Exceptions ===
  * (InvalidWindowError) fenêtre invalides
  * (ResizeError) incapable de redimensionner la fenêtre

===== Enumerations =====

==== Match mode ====
Match modes pour la fonction [[#find|find]].

=== Valeurs ===
  - RegExp: recherche en utilisant les expressions régulières
  - Wildcard: recherche en utilisant des métacaractères (Wildcards)
  - WildcardUnix:  recherche en utilisant des métacaractères (Wildcards) de type Unix
  - FixedString:  utilise une chaîne fixe

=== Exemple ===
Trouvez les fenêtres dont le titre commence par "Notepad", utilisant des métacaractères (Wildcards).
<code javascript>
var fenetres = Window.find({
	title: "Notepad*",
	titleMode: Window.Wildcard
});
</code>