184 lines
9.2 KiB
HTML
184 lines
9.2 KiB
HTML
<html><head><title>FreeCAD API/fr</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>FreeCAD API/fr</h1></div>
|
|
|
|
<div id="mw-content-text" lang="fr" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>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)
|
|
</p><p>Example:
|
|
</p>
|
|
<pre>import FreeCAD
|
|
print FreeCAD.listDocuments()
|
|
mydoc = FreeCAD.activeDocument() </pre>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> Config Dump </b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Imprime un dictionnaire contenant tout l'environnement de configuration FreeCAD
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> ConfigGet </b></big> ( <i> [chaîne] </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Renvoie la valeur de la clé donnée. Si aucune clé n'est donnée, la configuration complète est retourné
|
|
</p><p><small><b>Returns</b>:</small> Une chaîne
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>. ConfigSet </b></big> ( <i> chaîne, chaîne </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Définir la clé donnée (première chaîne) à la valeur donnée (deuxième chaîne de caractères)
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> Version </b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Imprime la version FreeCAD
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> activeDocument </b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Retour au document actif ou None s'il n'y a pas de document actif
|
|
</p><p><small><b>Returns</b>:</small> . Un document FreeCAD
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>. addExportType </b></big> ( <i> chaîne, chaîne </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Ajoute un nouveau type de fichier d'exportation FreeCAD. La première chaîne doit être formatée comme dans cet exemple: "Document Word (* .doc)". La deuxième chaîne est le nom d'un script Python / module contenant une fonction export ()
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> addImportType </b></big> ( <i> chaîne, chaîne</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Ajoute un nouveau type de fichier d'importation FreeCAD, fonctionne de la même manière que addExportType, la manipulation du module python doit contenir une open () et/ou une fonction importation ()
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> closeDocument </b></big> ( <i> Nom du document </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Ferme le document donné
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getDocument </b></big> ( <i> Nom du document </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> retourner un document ou lever une exception s'il n'existe aucun document avec le nom donné
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> getExportType </b></big> ( <i> chaîne </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Retourne le nom du module qui peut exporter le type de fichier spécifié
|
|
</p><p><small><b>Returns</b>:</small> . Une chaîne
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>. getImportType </b></big> ( <i> chaîne </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Retourne le nom du module qui peut importer le type de fichier spécifié
|
|
</p><p><small><b>Returns</b>:</small> . Une chaîne
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>. listDocuments </b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Retourne un dictionnaire des noms et des pointeurs d'objet de tous les documents
|
|
</p><p><small><b>Returns</b>:</small> .. Un dictionnaire des noms et des pointeurs d'objet
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> NewDocument </b></big> ( <i> [chaîne] </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Crée et retourne un nouveau document avec un nom donné. Le nom du document doit être unique, qui est automatiquement vérifié. Si aucun nom n'est fourni, le document sera nommé "Untitled"
|
|
</p><p><small><b>Returns</b>:</small> . Le document nouvellement créé
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>. Open </b></big> ( <i> chaîne </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Voir openDocument
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b> openDocument </b></big> ( <i> filepath </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Créer et renvoyer un document et charger un fichier de projet dans le document. L'argument de chaîne doit pointer vers un fichier existant. S'il n'existe pas le fichier ou si le fichier ne peut être chargé une exception I/O est levée. Dans ce cas, le document créé est maintenu, mais sera vide
|
|
</p><p><small><b>Returns</b>:</small> . Le document FreeCAD
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>. SetActiveDocument </b></big> ( <i> Nom du document </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Définir le document actif par son nom
|
|
</p><p><small><b>Returns</b>:</small> .
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div style="clear:both"></div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div><div class="printfooter">
|
|
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=FreeCAD_API/fr&oldid=152815">http://www.freecadweb.org/wiki/index.php?title=FreeCAD_API/fr&oldid=152815</a>"</div>
|
|
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
<div id="mw-navigation">
|
|
<h2>Navigation menu</h2>
|
|
|
|
</body></html> |