suzanne.soy/FreeCAD-Doc
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
master
FreeCAD-Doc/localwiki/FreeCADGui_API-en.html
Kurt Kremitzki a0c8029bc3 Add all translations
2018-07-19 18:47:02 -05:00

200 lines
8.5 KiB
HTML
Raw Permalink Blame History

<html><head><title>FreeCADGui API/en</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>FreeCADGui API/en</h1></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>This module is the counterpart of the FreeCAD module. It contains everything related to the User interface and the 3D views. Example:
</p>
<pre>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") </pre>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>activateWorkbench</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Activates a workbench by name
</p><p><small><b>Returns</b>:</small> nothing
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>activeDocument</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> the active document or None if no one exists
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>activeWorkbench</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small>
</p><p><small><b>Returns</b>:</small> the active workbench object
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addCommand</b></big> ( <i>string, object</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Adds a FreeCAD command. String is the name of the command and object is a classname defining the command
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addIcon</b></big> ( <i>string, string or list</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Adds an icon as file name or in XPM format to the system
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addIconPath</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Add a new path to the system where to find icon files
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addPreferencePage</b></big> ( <i>string,string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Adds a UI form to the preferences dialog. The first argument specifies the file name and the second specifies the group name
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addWorkbench</b></big> ( <i>string, object</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Adds a workbench under a defined name. The string is the workbench name and the object is a classname defining the workbench
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>createDialog</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Opens a UI file
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getDocument</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Gets a document by its name
</p><p><small><b>Returns</b>:</small> the document
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getWorkbench</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Gets a workbench by its name
</p><p><small><b>Returns</b>:</small> the workbench
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>insert</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Open a macro, Inventor or VRML file
</p><p><small><b>Returns</b>:</small> the document
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>listWorkbenches</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Shows a list of all workbenches
</p><p><small><b>Returns</b>:</small> a list
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>open</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Opens a macro, Inventor or VRML file
</p><p><small><b>Returns</b>:</small> the openend document
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>removeWorkbench</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Removes a workbench by name
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>runCommand</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Runs a FreeCAD command by name
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>updateGui</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Description</b>:</small> Updates the main window and all its windows
</p><p><small><b>Returns</b>:</small>
</p>
</div>
</div>
<div style="clear:both"></div>
</div>
</div>
</div><div class="printfooter">
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=FreeCADGui_API/en&amp;oldid=267214">http://www.freecadweb.org/wiki/index.php?title=FreeCADGui_API/en&amp;oldid=267214</a>"</div>
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
</div>
</div>
<div id="mw-navigation">
<h2>Navigation menu</h2>
</body></html>
Reference in New Issue View Git Blame Copy Permalink