FreeCAD API/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "FreeCAD API")
 
No edit summary
 
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
This is the principal (root) module of FreeCAD. It can also be called by "App" from the FreeCAD interpreter. It contains everything that is needed to manipulate documents and their contents (objects).
{{VeryImportantMessage|(octobre 2019) Ne pas éditer cette page. L'information est incomplète et obsolète. Pour la dernière API, voir la [https://www.freecadweb.org/api documentation de l'API générée automatiquement], ou générez la documentation vous-même, voir [[Source documentation/fr|Documentation du code source]].}}


C'est le module principal (root) de FreeCAD. Il peut également être appelé par "App" de l'interprète FreeCAD. Il contient tout ce qui est nécessaire pour manipuler des documents et leur contenu (objets)
Example:

<pre>
Exemple:
{{Code|code=
import FreeCAD
import FreeCAD
print FreeCAD.listDocuments()
print FreeCAD.listDocuments()
mydoc = FreeCAD.activeDocument()
mydoc = FreeCAD.activeDocument()
}}
</pre>

{{APIFunction|ConfigDump| |Prints a dictionary containing all the FreeCAD configuration environment.| }}
{{APIFunction|ConfigDump| |Imprime un dictionnaire contenant tout l'environnement de configuration FreeCAD.| }}
{{APIFunction|ConfigGet|[string]|Returns the value of the given key. If no key is given, the complete configuration is returned|A string.}}
{{APIFunction|ConfigGet|[string]|Renvoie la valeur de la clé donnée. Si aucune clé n'est fournie, la configuration complète est renvoyée|Une chaîne.}}
{{APIFunction|ConfigSet|string, string|Set the given key (first string) to the given value (second string).| }}
{{APIFunction|ConfigSet|string, string|Définit la clé donnée (première chaîne) sur la valeur donnée (deuxième chaîne).| }}
{{APIFunction|Version| |Prints the FreeCAD version.| }}
{{APIFunction|Version| |Imprime la version FreeCAD.| }}
{{APIFunction|activeDocument| |Return the active document or None if there is no active document.|A FreeCAD Document.}}
{{APIFunction|activeDocument| |Renvoie le document actif ou Aucun s'il n'y a pas de document actif.|Un document FreeCAD.}}
{{APIFunction|addExportType|string, string|Adds a new export file type to FreeCAD. The first string must be formatted like this example: "Word Document (*.doc)". The second string is the name of a python script/module containing an export() function.| }}
{{APIFunction|addExportType|string, string|Ajoute un nouveau type de fichier d'exportation à FreeCAD. La première chaîne doit être formatée comme cet exemple: "Document Word (*.doc)". La deuxième chaîne est le nom d'un script/module python contenant une fonction export().| }}
{{APIFunction|addImportType|string, string|Adds a new import file type to FreeCAD, works the same way as addExportType, the handling python module must contain an open() and/or an import() function.| }}
{{APIFunction|addImportType|string, string|Ajoute un nouveau type de fichier d'importation à FreeCAD, fonctionne de la même manière que addExportType, le module de gestion python doit contenir une fonction open() et/ou import().| }}
{{APIFunction|closeDocument|Document name|Closes the given document| }}
{{APIFunction|closeDocument|Nom du document|Ferme le document donné| }}
{{APIFunction|getDocument|Document name|Returns a document or raise an exception if there is no document with the given name.| }}
{{APIFunction|getDocument|Nom du document|Renvoie un document ou déclenche une exception s'il n'y a pas de document avec le nom donné.| }}
{{APIFunction|getExportType|string|Returns the name of the module that can export the specified filetype.| A string.}}
{{APIFunction|getExportType|string|Renvoie le nom du module qui peut exporter le type de fichier spécifié.|Une chaîne.}}
{{APIFunction|getImportType|string|Returns the name of the module that can import the specified filetype.|A string.}}
{{APIFunction|getImportType|string|Renvoie le nom du module qui peut importer le type de fichier spécifié.|Une chaîne.}}
{{APIFunction|listDocuments| |Returns a dictionary of names and object pointers of all documents.|A dictionary of names and object pointers.}}
{{APIFunction|listDocuments| |Renvoie un dictionnaire de noms et de pointeurs d'objet de tous les documents.|Un dictionnaire de noms et de pointeurs d'objet.}}
{{APIFunction|newDocument|[string], [hidden<nowiki>=</nowiki>False]|Crée et renvoie un nouveau document avec un nom donné. Le nom du document doit être unique, ce qui est vérifié automatiquement. Si aucun nom n'est fourni, le document sera nommé "Sans titre". Si <tt>hidden<nowiki>=</nowiki>True</tt> est passé, FreeCAD en mode GUI n'affichera pas le document et n'affichera pas d'onglet pour le document; cela permet d'effectuer des opérations automatiques sur un document temporaire (ou de créer un document et de l'enregistrer) sans perturber l'interface utilisateur.|Le document nouvellement créé.}}
{{APIFunction|newDocument|[string]|Creates and returns a new document with a given name. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled".|The newly created document.}}
{{APIFunction|open|string|See openDocument| }}
{{APIFunction|open|string|Voir openDocument| }}
{{APIFunction|openDocument|filepath|Creates and returns a document and load a project file into the document. The string argument must point to an existing file. If the file doesn't exist or the file cannot be loaded an I/O exception is thrown. In this case the created document is kept, but will be empty.|The opened FreeCAD Document.}}
{{APIFunction|openDocument|filepath, [hidden]|Crée et renvoie un document et charge un fichier projet dans le document. L'argument chaîne doit pointer vers un fichier existant. Si le fichier n'existe pas ou si le fichier ne peut pas être chargé, une exception d'E / S est levée. Dans ce cas, le document créé est conservé, mais sera vide. Si <tt>hidden<nowiki>=</nowiki>True</tt> est passé, FreeCAD en mode GUI n'affichera pas le document et n'affichera pas d'onglet pour le document; cela permet d'effectuer des opérations automatiques sur un document et de le fermer sans perturber l'interface utilisateur.|Le document FreeCAD ouvert.}}
{{APIFunction|setActiveDocument|Document name|Set the active document by its name.| }}
{{APIFunction|setActiveDocument|Nom du document|Définit le document actif par son nom.| }}

[[Category:API]]


{{Userdocnavi{{#translation:}}}}
[[Category:API{{#translation:}}]]
[[Category:Poweruser Documentation{{#translation:}}]]
{{clear}}
{{clear}}
<languages/>

Latest revision as of 20:56, 16 January 2024

(octobre 2019) Ne pas éditer cette page. L'information est incomplète et obsolète. Pour la dernière API, voir la documentation de l'API générée automatiquement, ou générez la documentation vous-même, voir Documentation du code source.

C'est le module principal (root) de FreeCAD. Il peut également être appelé par "App" de l'interprète FreeCAD. Il contient tout ce qui est nécessaire pour manipuler des documents et leur contenu (objets)

Exemple:

import FreeCAD
print FreeCAD.listDocuments()
mydoc = FreeCAD.activeDocument()
ConfigDump( )

Description: Imprime un dictionnaire contenant tout l'environnement de configuration FreeCAD.

Returns:

ConfigGet([string])

Description: Renvoie la valeur de la clé donnée. Si aucune clé n'est fournie, la configuration complète est renvoyée

Returns: Une chaîne.

ConfigSet(string, string)

Description: Définit la clé donnée (première chaîne) sur la valeur donnée (deuxième chaîne).

Returns:

Version( )

Description: Imprime la version FreeCAD.

Returns:

activeDocument( )

Description: Renvoie le document actif ou Aucun s'il n'y a pas de document actif.

Returns: Un document FreeCAD.

addExportType(string, string)

Description: Ajoute un nouveau type de fichier d'exportation à FreeCAD. La première chaîne doit être formatée comme cet exemple: "Document Word (*.doc)". La deuxième chaîne est le nom d'un script/module python contenant une fonction export().

Returns:

addImportType(string, string)

Description: Ajoute un nouveau type de fichier d'importation à FreeCAD, fonctionne de la même manière que addExportType, le module de gestion python doit contenir une fonction open() et/ou import().

Returns:

closeDocument(Nom du document)

Description: Ferme le document donné

Returns:

getDocument(Nom du document)

Description: Renvoie un document ou déclenche une exception s'il n'y a pas de document avec le nom donné.

Returns:

getExportType(string)

Description: Renvoie le nom du module qui peut exporter le type de fichier spécifié.

Returns: Une chaîne.

getImportType(string)

Description: Renvoie le nom du module qui peut importer le type de fichier spécifié.

Returns: Une chaîne.

listDocuments( )

Description: Renvoie un dictionnaire de noms et de pointeurs d'objet de tous les documents.

Returns: Un dictionnaire de noms et de pointeurs d'objet.

newDocument([string], [hidden=False])

Description: Crée et renvoie un nouveau document avec un nom donné. Le nom du document doit être unique, ce qui est vérifié automatiquement. Si aucun nom n'est fourni, le document sera nommé "Sans titre". Si hidden=True est passé, FreeCAD en mode GUI n'affichera pas le document et n'affichera pas d'onglet pour le document; cela permet d'effectuer des opérations automatiques sur un document temporaire (ou de créer un document et de l'enregistrer) sans perturber l'interface utilisateur.

Returns: Le document nouvellement créé.

open(string)

Description: Voir openDocument

Returns:

openDocument(filepath, [hidden])

Description: Crée et renvoie un document et charge un fichier projet dans le document. L'argument chaîne doit pointer vers un fichier existant. Si le fichier n'existe pas ou si le fichier ne peut pas être chargé, une exception d'E / S est levée. Dans ce cas, le document créé est conservé, mais sera vide. Si hidden=True est passé, FreeCAD en mode GUI n'affichera pas le document et n'affichera pas d'onglet pour le document; cela permet d'effectuer des opérations automatiques sur un document et de le fermer sans perturber l'interface utilisateur.

Returns: Le document FreeCAD ouvert.

setActiveDocument(Nom du document)

Description: Définit le document actif par son nom.

Returns: