FreeCADGui API/fr: Difference between revisions
(Updating to match new version of source page) |
No edit summary |
||
(9 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
⚫ | |||
This module is the counterpart of the FreeCAD module. It contains everything related to the User interface and the 3D views. Example: |
|||
{{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]].}} |
|||
Ce module est le pendant du module FreeCAD. Il contient tout ce qui touche à l'interface utilisateur et les vues 3D. Exemple: |
|||
{{Code|code= |
{{Code|code= |
||
import |
import FreeCAD as App |
||
import FreeCADGui as Gui |
|||
⚫ | |||
# get the 3D model document |
|||
doc = App.ActiveDocument |
|||
# get the visual representation model document |
|||
{{APIFunction|activateWorkbench|string|Activates a workbench by name|nothing}} |
|||
gui_doc = Gui.ActiveDocument |
|||
⚫ | |||
⚫ | |||
{{APIFunction|addCommand|string, object|Adds a FreeCAD command. String is the name of the command and object is a classname defining the command| }} |
|||
{{APIFunction|addIcon|string, string or list|Adds an icon as file name or in XPM format to the system| }} |
|||
{{APIFunction|addIconPath|string|Add a new path to the system where to find icon files| }} |
|||
{{APIFunction|addPreferencePage|string,string|Adds a UI form to the preferences dialog. The first argument specifies the file name and the second specifies the group name| }} |
|||
{{APIFunction|addWorkbench|string, object|Adds a workbench under a defined name. The string is the workbench name and the object is a classname defining the workbench| }} |
|||
⚫ | |||
⚫ | |||
{{APIFunction|getWorkbench|string|Gets a workbench by its name|the workbench}} |
|||
⚫ | |||
{{APIFunction|listWorkbenches| |Shows a list of all workbenches|a list}} |
|||
⚫ | |||
⚫ | |||
{{APIFunction|runCommand|string|Runs a FreeCAD command by name| }} |
|||
{{APIFunction|updateGui| |Updates the main window and all its windows| }} |
|||
gui_doc.activateWorkbench("myWorkbench") |
|||
⚫ | |||
⚫ | |||
{{APIFunction | activate Workbench | chaîne | Active un atelier par nom | rien}} |
|||
⚫ | |||
⚫ | |||
{{APIFunction | addCommand | chaîne, object | Ajoute une commande FreeCAD. Chaîne est le nom de la commande et l'objet est un nom de classe définissant la commande |}} |
|||
{{APIFunction | AddIcon | chaîne, chaîne or liste | Ajoute une icône comme nom de fichier ou dans le format XPM du système |}} |
|||
{{APIFunction | addIconPath | chaîne | Ajouter un nouveau chemin d'accès au système où trouver les fichiers d'icônes |}} |
|||
{{APIFunction | addPreferencePage | chaîne, chaîne | 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 |}} |
|||
{{APIFunction | addWorkbench | chaîne, object | 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 |}} |
|||
⚫ | |||
⚫ | |||
{{APIFunction | getWorkbench | chaîne | Obtient un atelier par son nom | l'atelier}} |
|||
⚫ | |||
{{APIFunction | listWorkbenches | | Affiche une liste de toutes les ateliers | liste}} |
|||
⚫ | |||
⚫ | |||
{{APIFunction | RunCommand | chaîne | Exécute une commande FreeCAD par nom |}} |
|||
{{APIFunction | updateGui | | Mise à jour de la fenêtre principale et toutes ses fenêtres |}} |
|||
{{Userdocnavi{{#translation:}}}} |
|||
⚫ | |||
[[Category:Poweruser Documentation{{#translation:}}]] |
|||
{{clear}} |
{{clear}} |
||
⚫ |
Latest revision as of 20:56, 16 January 2024
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")
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:
Description: Ajoute une icône comme nom de fichier ou dans le format XPM du système
Returns:
Description: Ajouter un nouveau chemin d'accès au système où trouver les fichiers d'icônes
Returns:
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:
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:
Description: Ouvre une macro, Inventor ou un fichier VRML
Returns: le document ouvert
- Démarrer avec FreeCAD
- Installation : Téléchargements, Windows, Linux, Mac, Logiciels supplémentaires, Docker, AppImage, Ubuntu Snap
- Bases : À propos de FreeCAD, Interface, Navigation par la souris, Méthodes de sélection, Objet name, Préférences, Ateliers, Structure du document, Propriétés, Contribuer à FreeCAD, Faire un don
- Aide : Tutoriels, Tutoriels vidéo
- Ateliers : Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test