Différences

Ci-dessous, les différences entre deux révisions de la page.

--- fr:documentation:script_reference [2014/06/15 18:27] – créée pch
+++ fr:documentation:script_reference [2017/02/28 15:58] (Version actuelle) – pch
@@ Ligne 1: / Ligne 1: @@
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)//
+====== Référence des scripts ======
-====== Script reference ======
+Cette page contient du matériel de référence pour les fonctions de script.
-This page contain reference material for scripting functions.
+Voir la page [[toolbox|Boîtes à outils]] pour des informations générales.
-See the [[toolbox|Tool Box]] description page for general information.
+Voir les [[script example|exemples de scripts]] pour un démarrage rapide avec les fonctions de programmation.
-See the [[script example|script example]] page for a quick start with the programming functions.
+===== Langage de script =====
+Le langage de programmation utilisé est [[wp>Pascal_Script|Pascal Script]].\\
+Pour une référence complète du langage Pascal Objet, vous pouvez lire [[http://www.freepascal.org/docs-html/ref/ref.html|Free Pascal Reference guide]]. Mais attention, certaines fonctionnalités ne sont pas implémentées par le langage de script, par exemple: pas de pointeur, pas d'assembleur, pas de surcharge.
-===== Script language =====
+En plus des fonctions standard de Pascal Script, les fonctions suivantes spécifiques à Cartes du Ciel  sont ajoutées.
-The language to use is [[wp>Pascal_Script|Pascal Script]].\\
+===== Fonctions du menu principal =====
-For a complete reference of the Object Pascal language your can read the [[http://www.freepascal.org/docs-html/ref/ref.html|Free Pascal Reference guide]]. But beware that some feature are not implemented by the script language, for example: no pointer, no assembler, no overloading.
-In addition to the standard Pascal Script feature the following Skychart specific function are added.
+Tous les éléments du menu principal peuvent être utilisés à partir des scripts. \\
+La liste complète des noms de menu est disponible à partir de la [[http://sourceforge.net/p/skychart/code/HEAD/tree/trunk/skychart/menu.txt|liste des menus]].\\
-===== Main menu function =====
+Vous pouvez exécuter l'action du menu à l'aide de la méthode Click ou tester si une option est activée en testant la propriété Checked.
-Every items of the main menu can be used from the scripts.\\
+===== Chaînes des traductions =====
-The full list of menu items name is available from the [[http://sourceforge.net/p/skychart/code/HEAD/tree/trunk/skychart/menu.txt|menu list]].\\
-You can execute the menu action by using the Click method, or test if an option is activated by testing the Checked property.
+Chaque chaîne traduite pour le programme principal peut être utilisée dans un script. \\
+Utilisez directement la constante rsXXX pour obtenir la chaîne traduite. \\
+La liste complète des chaînes disponibles est disponible à partir du [[http://sourceforge.net/p/skychart/code/HEAD/tree/trunk/skychart/u_translation.pas|code source]].\\
+Si une chaîne n'est pas traduite pour votre langue n'hésitez pas [[:en:translations#software_translation|à le faire vous même]].
-===== Translation string =====
+===== Constantes =====
-Every string translated for the main program can be used in a script.\\
-Directly use the rsXXX constant to get the translated string.\\
-The full list of available string is available from the [[http://sourceforge.net/p/skychart/code/HEAD/tree/trunk/skychart/u_translation.pas|source code]].\\
-If a string is not translated for your language don't hesitate [[:en:translations#software_translation|to do it yourself]].
-===== Constants =====
 ^name^value^
 |deg2rad| degree to radian conversion constant|
 |rad2deg| radian to degree conversion constant|
-===== Global variables access =====
+===== Accès aux variables globales =====
 ^function GetS(varname:string; var str: string):Boolean;^^
@@ Ligne 51: / Ligne 49: @@
 ^varname^value^
 |Str1 .. Str10|Ten global variable for your use|
+^function GetSL(varname:string; var strl: Tstringlist):Boolean;^^
+|Get the global stringlist variable identified by varname||
+^varname^value^
+|Strl1 .. Strl10|Ten global variable for your use|
+^function SetSL(varname:string; stlr: Tstringlist):Boolean;^^
+|Set the global stringlist variable identified by varname for later use||
+^varname^value^
+|Strl1 .. Strl10|Ten global variable for your use|
 ^function GetI(varname:string; var i: Integer):Boolean;^^
@@ Ligne 100: / Ligne 108: @@
 |Variant1 .. Variant10|Ten global variable for your use|
-===== Chart and Celestial objects =====
+===== Carte et objets =====
 ^function  Cmd(cname:string; arg:Tstringlist):string;^
@@ Ligne 127: / Ligne 135: @@
-===== Formating and conversion =====
+===== Conversion de coordonnées =====
+^Procedure Eq2Hz(var ra,de : double ; var a,h : double);^
+|Convert Equatorial ra,de to Alt/Az a,h for the location and time of the current chart, all angle in radian|
+^Procedure Hz2Eq(var a,h : double; var ra,de : double);^
+|Convert Alt/Az a,h to equatorial ra,de for the location and time of the current chart, all angle in radian|
+^Procedure Eq2Gal(var ra,de : double ; var l,b : double);^
+|Convert Equatorial ra,de to Galactic l,b , all angle in radian|
+^Procedure Gal2Eq(var l,b : double; var ra,de : double);^
+|Convert Galactic l,b to equatorial ra,de , all angle in radian|
+^Procedure Eq2Ecl(var ra,de : double ; var l,b : double);^
+|Convert Equatorial ra,de to Ecliptic l,b with obliquity for the date of the current chart, all angle in radian |
+^Procedure Ecl2Eq(var l,b : double; var ra,de : double);^
+|Convert Ecliptic l,b to Equatorial ra,de with obliquity for the date of the current chart, all angle in radian|
+===== Conversion et Formatage =====
 ^Function ARtoStr(var ar: Double) : string;^
@@ Ligne 152: / Ligne 182: @@
 ^Function Format(Const Fmt : String; const Args : Array of const) : String;^
 |The [[http://www.freepascal.org/docs-html/rtl/sysutils/format.html|Format]] Pascal function|
+^Procedure StrtoFloatD(str:string; var defval: Double; var val: Double);^
+|Convert a string to a floating point value. Return defval if the string is a invalid number |
 ^function IsNumber(str: String): boolean;^
 |Return True if the string represent a valid number|
-===== Dialog =====
+^function StringReplace(str,s1,s2: String): string;^
+|Replace all occurrence of s1 by s2 in str|
+^procedure JsonToStringlist(jsontxt:string; var SK,SV: TStringList);^
+|Parse a JSON formated string and return two stringlist. SK contain the names and SV the corresponding values|
+===== Dialogues standard =====
 ^function OpenDialog(var fn: string): boolean;^
@@ Ligne 166: / Ligne 207: @@
 ^function MsgBox(const aMsg: string):boolean;^
 |A message confirmation dialog. Return True if YES is clicked.|
+^Procedure ShowMessage(const aMsg: string);^
+|Display a message.|
 ^function CalendarDialog(var dt: double): boolean;^
 |The Skychart Calendar dialog. Return dt julian date|
-===== Run external program =====
+===== Exécution de programme externes =====
 ^function Run(cmdline:string):boolean;^
@@ Ligne 181: / Ligne 225: @@
 |Open a document file using the default program|
-Also see the [[script_example|example]] about how to call a function in an external library.
+Voir aussi les [[script_example|exemples de scripts ]] pour l'appel de libraires externes.
+===== Client socket TCP/IP =====
+Pour toutes ces fonctions ** socknum ** identifie le socket à utiliser. Il s'agit d'un nombre entre 1 et 10, permettant ainsi 10 connexion simultanée à des serveurs différent.
+^function TcpConnect(socknum:integer; ipaddr,port,timeout:string):boolean;^
+|Connect to the server at ipaddr:port and set the **timeout** for the subsequent operations|
+^function TcpDisconnect(socknum:integer):boolean;^
+|Disconnect from the server|
+^Function TcpConnected(socknum:integer) : boolean;^
+|Return **True** if the socket is connected|
+^Function TcpRead(socknum:integer; var buf : string; termchar:string) : boolean;^
+|Read data from the socket until the character **termchar** is encountered, typically termchar is CRLF|
+^Function TcpReadCount(socknum:integer; var buf : string; var count : integer) : boolean;^
+|Read data from the socket until **count** character are read or **timeout** is reached|
+^Function TcpWrite(socknum:integer; var buf : string; var count : integer) : boolean;^
+|Write data to the socket from **buf** for a length of **count**|
+^Procedure TcpPurgeBuffer(socknum:integer);^
+|Purge all the received data currently queued in the receive buffer|