FreeCADGui API: Difference between revisions

From FreeCAD Documentation
(Created page with 'This module is the counterpart of the FreeCAD module. It contains everything related to the User interface and the 3D views. Example: import FreeCADGui doc = FreeCADGui.active…')
 
mNo edit summary
Line 21: Line 21:
{{APIFunction|runCommand|string|Runs a FreeCAD command by name| }}
{{APIFunction|runCommand|string|Runs a FreeCAD command by name| }}
{{APIFunction|updateGui| |Updates the main window and all its windows| }}
{{APIFunction|updateGui| |Updates the main window and all its windows| }}

{{languages | {{es|FreeCADGui_API/es}} }}


[[Category:API]]
[[Category:API]]

Revision as of 01:39, 23 August 2011

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

import FreeCADGui
doc = FreeCADGui.activeDocument()
activateWorkbench(string)

Description: Activates a workbench by name

Returns: nothing

activeDocument( )

Description:

Returns: the active document or None if no one exists

activeWorkbench( )

Description:

Returns: the active workbench object

addCommand(string, object)

Description: Adds a FreeCAD command. String is the name of the command and object is a classname defining the command

Returns:

addIcon(string, string or list)

Description: Adds an icon as file name or in XPM format to the system

Returns:

addIconPath(string)

Description: Add a new path to the system where to find icon files

Returns:

addPreferencePage(string,string)

Description: Adds a UI form to the preferences dialog. The first argument specifies the file name and the second specifies the group name

Returns:

addWorkbench(string, object)

Description: Adds a workbench under a defined name. The string is the workbench name and the object is a classname defining the workbench

Returns:

createDialog(string)

Description: Opens a UI file

Returns:

getDocument(string)

Description: Gets a document by its name

Returns: the document

getWorkbench(string)

Description: Gets a workbench by its name

Returns: the workbench

insert(string)

Description: Open a macro, Inventor or VRML file

Returns: the document

listWorkbenches( )

Description: Shows a list of all workbenches

Returns: a list

open(string)

Description: Opens a macro, Inventor or VRML file

Returns: the openend document

removeWorkbench(string)

Description: Removes a workbench by name

Returns:

runCommand(string)

Description: Runs a FreeCAD command by name

Returns:

updateGui( )

Description: Updates the main window and all its windows

Returns:

Available translations of this page: