FreeCADGui API
Jump to navigation
Jump to search
User documentation
(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the 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")
Description: Adds a FreeCAD command. String is the name of the command and object is a classname defining the command
Returns:
Description: Adds an icon as file name or in XPM format to the system
Returns:
Description: Adds a UI form to the preferences dialog. The first argument specifies the file name and the second specifies the group name
Returns:
Description: Adds a workbench under a defined name. The string is the workbench name and the object is a classname defining the workbench
Returns:

- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Path, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub