Skip to content

Latest commit

 

History

History
74 lines (31 loc) · 2.37 KB

FreeCADGui_API.md

File metadata and controls

74 lines (31 loc) · 2.37 KB
Raw

FreeCADGui API

(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation], or generate the documentation yourself, see Source documentation.

This module is the counterpart of the FreeCAD module. It contains everything related to the User interface and the 3D views. Example:

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")

{{APIFunction|activateWorkbench|string|Activates a workbench by name|nothing}}

{{APIFunction|activeDocument| | |the active document or None if no one exists}}

{{APIFunction|activeWorkbench| | |the active workbench object}}

{{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|createDialog|string|Opens a UI file| }}

{{APIFunction|getDocument|string|Gets a document by its name|the document}}

{{APIFunction|getWorkbench|string|Gets a workbench by its name|the workbench}}

{{APIFunction|insert|string|Open a macro, Inventor or VRML file|the document}}

{{APIFunction|listWorkbenches| |Shows a list of all workbenches|a list}}

{{APIFunction|open|string|Opens a macro, Inventor or VRML file|the openend document}}

{{APIFunction|removeWorkbench|string|Removes a workbench by name| }}

{{APIFunction|runCommand|string|Runs a FreeCAD command by name| }}

{{APIFunction|updateGui| |Updates the main window and all its windows| }}

⏵ documentation index > API > [Poweruser Documentation](Category_Poweruser Documentation.md) > FreeCADGui API