FreeCAD API/fr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
No edit summary
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{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)
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:
Example:
{{Code|code=
{{Code|code=
import FreeCAD
import FreeCAD
Line 8: Line 10:
mydoc = FreeCAD.activeDocument()
mydoc = FreeCAD.activeDocument()
}}
}}

{{APIFunction | Config Dump | | Imprime un dictionnaire contenant tout l'environnement de configuration FreeCAD |.}}
{{APIFunction|ConfigDump| |Imprime un dictionnaire contenant tout l'environnement de configuration FreeCAD.| }}
{{APIFunction | ConfigGet | [chaîne] | Renvoie la valeur de la clé donnée. Si aucune clé n'est donnée, la configuration complète est retourné | Une chaîne}}
{{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 | chaîne, chaîne | Définir la clé donnée (première chaîne) à la valeur donnée (deuxième chaîne de caractères) |.}} {{APIFunction | Version | | Imprime la version FreeCAD |.}}
{{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| |Imprime la version FreeCAD.| }}
{{APIFunction | activeDocument | | Retour au document actif ou None s'il n'y a pas de document actif |. Un document FreeCAD }}
{{APIFunction|activeDocument| |Renvoie le document actif ou Aucun s'il n'y a pas de document actif.|Un document FreeCAD.}}
{{APIFunction |. addExportType | chaîne, chaîne | 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 () |.}} {{APIFunction | addImportType | chaîne, chaîne| 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 () |.}}
{{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 | closeDocument | Nom du document | Ferme le document donné |}}
{{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 | getDocument | Nom du document | retourner un document ou lever une exception s'il n'existe aucun document avec le nom donné |.}}
{{APIFunction|closeDocument|Nom du document|Ferme le document donné| }}
{{APIFunction | getExportType | chaîne | Retourne le nom du module qui peut exporter le type de fichier spécifié |. Une chaîne}}
{{APIFunction |. getImportType | chaîne | Retourne le nom du module qui peut importer le type de fichier spécifié |. Une chaîne}}
{{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|Renvoie le nom du module qui peut exporter le type de fichier spécifié.|Une chaîne.}}
{{APIFunction |. listDocuments | | Retourne un dictionnaire des noms et des pointeurs d'objet de tous les documents |.. Un dictionnaire des noms et des pointeurs d'objet}}
{{APIFunction|getImportType|string|Renvoie le nom du module qui peut importer le type de fichier spécifié.|Une chaîne.}}
{{APIFunction | NewDocument | [chaîne] | 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" |. Le document nouvellement créé}}
{{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 |. Open | chaîne | Voir openDocument |}}
{{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 | openDocument | filepath | 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 |. Le document FreeCAD }}
{{APIFunction|open|string|Voir openDocument| }}
{{APIFunction|. SetActiveDocument | Nom du document | Définir le document actif par son nom |.}}
{{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|Nom du document|Définit le document actif par son nom.| }}
[[Category:API/fr]]


{{Userdocnavi{{#translation:}}}}
[[Category:API{{#translation:}}]]
[[Category:Poweruser Documentation{{#translation:}}]]
{{clear}}
{{clear}}

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: