API de l'interface graphique de FreeCAD

From FreeCAD Documentation
This page is a translated version of the page FreeCADGui API and the translation is 100% complete.
Other languages:
(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.

Ce module est le pendant du module FreeCAD. Il contient tout ce qui touche à l'interface utilisateur et les vues 3D. Exemple:

import FreeCAD as App
import FreeCADGui as Gui

# get the 3D model document
doc = App.ActiveDocument    

# get the visual representation model document
gui_doc = Gui.ActiveDocument

gui_doc.activateWorkbench("myWorkbench")


activate Workbench ( chaîne )

Description: Active un atelier par nom

Returns: rien

activeDocument ( )

Description:

Returns: le document actif ou None si rien n'existe

activeWorkbench ( )

Description:

Returns: l'objet de l'atelier actif

addCommand ( chaîne, object )

Description: Ajoute une commande FreeCAD. Chaîne est le nom de la commande et l'objet est un nom de classe définissant la commande

Returns:

AddIcon ( chaîne, chaîne or liste )

Description: Ajoute une icône comme nom de fichier ou dans le format XPM du système

Returns:

addIconPath ( chaîne )

Description: Ajouter un nouveau chemin d'accès au système où trouver les fichiers d'icônes

Returns:

addPreferencePage ( chaîne, chaîne )

Description: Ajoute une forme d'interface utilisateur pour la boîte de dialogue des préférences. Le premier argument spécifie le nom du fichier et le second spécifie le nom du groupe

Returns:

addWorkbench ( chaîne, object )

Description: Ajoute un atelier sous un nom défini. La chaîne est le nom de l'atelier et l'objet est un nom de classe définissant l'atelier

Returns:

createDialog ( chaîne )

Description: Ouvre un fichier d'interface

Returns:

getDocument ( chaîne )

Description: Obtient un document par son nom

Returns: le document

getWorkbench ( chaîne )

Description: Obtient un atelier par son nom

Returns: l'atelier

Insert ( chaîne )

Description: Ouvrir une macro, Inventor ou un fichier VRML

Returns: document

listWorkbenches ( )

Description: Affiche une liste de toutes les ateliers

Returns: liste

open ( chaîne )

Description: Ouvre une macro, Inventor ou un fichier VRML

Returns: le document ouvert

removeWorkbench ( chaîne )

Description: Supprime un atelier par nom

Returns:

RunCommand ( chaîne )

Description: Exécute une commande FreeCAD par nom

Returns:

updateGui ( )

Description: Mise à jour de la fenêtre principale et toutes ses fenêtres

Returns: