Difference between revisions of "Code snippets"

From FreeCAD Documentation
Jump to: navigation, search
m (replace "PyQt4" to "PySide")
(replace "</syntaxhighlight>" to "{{Code|code= ")
Line 1: Line 1:
 
<languages/>
 
<languages/>
 
<translate>
 
<translate>
<!--T:55-->
+
<!--T:1-->
{{TutorialInfo
+
In this page we will show how to build a simple Qt Dialog with [http://qt-project.org/doc/qt-4.8/designer-manual.html Qt Designer], Qt's official tool for designing interfaces, then convert it to python code, then use it inside FreeCAD. I'll assume in the example that you know how to edit and run python scripts already, and that you can do simple things in a terminal window such as navigate, etc. You must also have, of course, pyqt installed.
|Topic= Python
+
 
|Level= Beginner
+
== Designing the dialog == <!--T:2-->
|Time=
+
In CAD applications, designing a good UI (User Interface) is very important. About everything the user will do will be through some piece of interface: reading dialog boxes, pressing buttons, choosing between icons, etc. So it is very important to think carefully to what you want to do, how you want the user to behave, and how will be the workflow of your action.
|Author=
+
 
|FCVersion=
+
<!--T:3-->
|Files=
+
There are a couple of concepts to know when designing interface:
}}
+
* [http://en.wikipedia.org/wiki/Modal_window Modal/non-modal dialogs]: A modal dialog appears in front of your screen, stopping the action of the main window, forcing the user to respond to the dialog, while a non-modal dialog doesn't stop you from working on the main window. In some case the first is better, in other cases not.
 +
* Identifying what is required and what is optional: Make sure the user knows what he must do. Label everything with proper description, use tooltips, etc.
 +
* Separating commands from parameters: This is usually done with buttons and text input fields. The user knows that clicking a button will produce an action while changing a value inside a text field will change a parameter somewhere. Nowadays, though, users usually know well what is a button, what is an input field, etc. The interface toolkit we are using, Qt, is a state-of-the-art toolkit, and we won't have to worry much about making things clear, since they will already be very clear by themselves.
 +
 
 +
<!--T:4-->
 +
So, now that we have well defined what we will do, it's time to open the qt designer. Let's design a very simple dialog, like this:
 +
 
 +
<!--T:5-->
 +
[[Image:Qttestdialog.jpg]]
 +
 
 +
<!--T:6-->
 +
We will then use this dialog in FreeCAD to produce a nice rectangular plane. You might find it not very useful to produce nice rectangular planes, but it will be easy to change it later to do more complex things. When you open it, Qt Designer looks like this:
 +
 
 +
<!--T:7-->
 +
[[Image:Qtdesigner-screenshot.jpg]]
 +
 
 +
<!--T:8-->
 +
It is very simple to use. On the left bar you have elements that can be dragged on your widget. On the right side you have properties panels displaying all kinds of editable properties of selected elements. So, begin with creating a new widget. Select "Dialog without buttons", since we don't want the default Ok/Cancel buttons. Then, drag on your widget '''3 labels''', one for the title, one for writing "Height" and one for writing "Width". Labels are simple texts that appear on your widget, just to inform the user. If you select a label, on the right side will appear several properties that you can change if you want, such as font style, height, etc.
 +
 
 +
<!--T:9-->
 +
Then, add '''2 LineEdits''', which are text fields that the user can fill in, one for the height and one for the width. Here too, we can edit properties. For example, why not set a default value? For example 1.00 for each. This way, when the user will see the dialog, both values will be filled already and if he is satisfied he can directly press the button, saving precious time. Then, add a '''PushButton''', which is the button the user will need to press after he filled the 2 fields.
  
<!--T:1-->
+
<!--T:10-->
This page contains examples, pieces, chunks of FreeCAD python code collected from users experiences and discussions on the forums. Read and use it as a start for your own scripts...
+
Note that I chose very simple controls here, but Qt has many more options, for example you could use Spinboxes instead of LineEdits, etc... Have a look at what is available, you will surely have other ideas.
  
 +
<!--T:11-->
 +
That's about all we need to do in Qt Designer. One last thing, though, let's rename all our elements with easier names, so it will be easier to identify them in our scripts:
  
=== A typical InitGui.py file === <!--T:2-->
+
<!--T:12-->
Every module must contain, besides your main module file, an InitGui.py file, responsible for inserting the module in the main Gui. This is an example of a simple one.  
+
[[Image:Qtpropeditor.jpg]]
 
</translate>
 
</translate>
{{Code|code=
 
class ScriptWorkbench (Workbench):
 
    MenuText = "Scripts"
 
    def Initialize(self):
 
        import Scripts # assuming Scripts.py is your module
 
        list = ["Script_Cmd"] # That list must contain command names, that can be defined in Scripts.py
 
        self.appendToolbar("My Scripts",list)
 
       
 
Gui.addWorkbench(ScriptWorkbench())
 
}}
 
 
<translate>
 
<translate>
  
=== A typical module file === <!--T:3-->
+
== Converting our dialog to python == <!--T:13-->
This is an example of a main module file, containing everything your module does. It is the Scripts.py file invoked by the previous example. You can have all your custom commands here.
+
</translate>
 +
<translate>
 +
<!--T:14-->
 +
Now, let's save our widget somewhere. It will be saved as an .ui file, that we will easily convert to python script with pyuic. On windows, the pyuic program is bundled with pyqt (to be verified), on linux you probably will need to install it separately from your package manager (on debian-based systems, it is part of the pyqt4-dev-tools package). To do the conversion, you'll need to open a terminal window (or a command prompt window on windows), navigate to where you saved your .ui file, and issue:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import FreeCAD, FreeCADGui
+
pyuic mywidget.ui > mywidget.py
 
class ScriptCmd:
 
  def Activated(self):
 
      # Here your write what your ScriptCmd does...
 
      FreeCAD.Console.PrintMessage('Hello, World!')
 
  def GetResources(self):
 
      return {'Pixmap' : 'path_to_an_icon/myicon.png', 'MenuText': 'Short text', 'ToolTip': 'More detailed text'}
 
     
 
FreeCADGui.addCommand('Script_Cmd', ScriptCmd())
 
 
}}
 
}}
 
<translate>
 
<translate>
 
+
<!--T:56-->
=== Import a new filetype === <!--T:4-->
+
In Windows pyuic.py is located in "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py"
Making an importer for a new filetype in FreeCAD is easy. FreeCAD doesn't consider that you import data in an opened document, but rather that you simply can directly open the new filetype. So what you need to do is to add the new file extension to FreeCAD's list of known extensions, and write the code that will read the file and create the FreeCAD objects you want:
+
For conversion create a batch file called "compQt4.bat:
 
 
<!--T:5-->
 
This line must be added to the InitGui.py file to add the new file extension to the list:
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# Assumes Import_Ext.py is the file that has the code for opening and reading .ext files
+
@"C:\Python27\python" "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py" -x %1.ui > %1.py
FreeCAD.addImportType("Your new File Type (*.ext)","Import_Ext")
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:6-->
+
<!--T:57-->
Then in the Import_Ext.py file:
+
In the DOS console type without extension
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
def open(filename):
+
compQt4 myUiFile
  doc=App.newDocument()
 
  # here you do all what is needed with filename, read, classify data, create corresponding FreeCAD objects
 
  doc.recompute()
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:7-->
+
<!--T:58-->
To export your document to some new filetype works the same way, except that you use:
+
Into Linux : to do
FreeCAD.addExportType("Your new File Type (*.ext)","Export_Ext")
 
 
 
=== Adding a line === <!--T:8-->
 
A line simply has 2 points.
 
 
</translate>
 
</translate>
{{Code|code=
 
  
import Part,PartGui
+
<!--T:55-->
doc=App.activeDocument()
 
# add a line element to the document and set its points
 
l=Part.LineSegment()
 
l.StartPoint=(0.0,0.0,0.0)
 
l.EndPoint=(1.0,1.0,1.0)
 
doc.addObject("Part::Feature","Line").Shape=l.toShape()
 
doc.recompute()
 
}}
 
 
<translate>
 
<translate>
 +
<!--T:59-->
 +
Since FreeCAD progressively moved away from PyQt after version 0.13, in favour of [http://qt-project.org/wiki/PySide PySide] (Choose your PySide install [http://pyside.readthedocs.org/en/latest/building/ building PySide]), to make the file based on PySide now you have to use:
  
=== Adding a polygon === <!--T:9-->
 
A polygon is simply a set of connected line segments (a polyline in AutoCAD). It doesn't need to be closed.
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import Part,PartGui
+
pyside-uic mywidget.ui -o mywidget.py
doc=App.activeDocument()
 
n=list()
 
# create a 3D vector, set its coordinates and add it to the list
 
v=App.Vector(0,0,0)
 
n.append(v)
 
v=App.Vector(10,0,0)
 
n.append(v)
 
#... repeat for all nodes
 
# Create a polygon object and set its nodes
 
p=doc.addObject("Part::Polygon","Polygon")
 
p.Nodes=n
 
doc.recompute()
 
 
}}
 
}}
 
<translate>
 
<translate>
 +
<!--T:60-->
 +
In Windows uic.py are located in "C:\Python27\Lib\site-packages\PySide\scripts\uic.py"
 +
For create batch file "compSide.bat":
 +
{{Code|code=
 +
@"C:\Python27\python" "C:\Python27\Lib\site-packages\PySide\scripts\uic.py" %1.ui > %1.py
 +
}}
 +
In the DOS console type without extension
 +
{{Code|code=
 +
compSide myUiFile
 +
}}
 +
Into Linux : to do
  
=== Adding and removing an object to a group === <!--T:10-->
+
 
 +
<!--T:15-->
 +
On some systems the program is called pyuic4 instead of pyuic. This will simply convert the .ui file into a python script. If we open the mywidget.py file, its contents is very easy to understand:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
doc=App.activeDocument()  
+
from PySide import QtCore, QtGui
grp=doc.addObject("App::DocumentObjectGroup", "Group")  
+
 
lin=doc.addObject("Part::Feature", "Line")
+
class Ui_Dialog(object):
grp.addObject(lin) # adds the lin object to the group grp
+
    def setupUi(self, Dialog):
grp.removeObject(lin) # removes the lin object from the group grp
+
        Dialog.setObjectName("Dialog")
 +
        Dialog.resize(187, 178)
 +
        self.title = QtGui.QLabel(Dialog)
 +
        self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
 +
        self.title.setObjectName("title")
 +
        self.label_width = QtGui.QLabel(Dialog)
 +
        ...
 +
 
 +
        self.retranslateUi(Dialog)
 +
        QtCore.QMetaObject.connectSlotsByName(Dialog)
 +
 
 +
  def retranslateUi(self, Dialog):
 +
        Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
 +
        self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
 +
        ...
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:11-->
+
<!--T:16-->
Note: You can even add other groups to a group...
+
As you see it has a very simple structure: a class named Ui_Dialog is created, that stores the interface elements of our widget. That class has two methods, one for setting up the widget, and one for translating its contents, which is part of the general Qt mechanism for translating interface elements. The setup method simply creates, one by one, the widgets as we defined them in Qt Designer, and sets their options as we decided earlier. Then, the whole interface gets translated, and finally, the slots get connected (we'll talk about that later).
  
=== Adding a Mesh === <!--T:12-->
+
<!--T:17-->
 +
We can now create a new widget and use this class to create its interface. We can already see our widget in action, by putting our mywidget.py file in a place where FreeCAD will find it (in the FreeCAD bin directory, or in any of the Mod subdirectories), and, in the FreeCAD python interpreter, issue:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import Mesh
+
from PySide import QtGui
doc=App.activeDocument()
+
import mywidget
# create a new empty mesh
+
d = QtGui.QWidget()
m = Mesh.Mesh()
+
d.ui = mywidget.Ui_Dialog()
# build up box out of 12 facets
+
d.ui.setupUi(d)
m.addFacet(0.0,0.0,0.0, 0.0,0.0,1.0, 0.0,1.0,1.0)
+
d.show()
m.addFacet(0.0,0.0,0.0, 0.0,1.0,1.0, 0.0,1.0,0.0)
 
m.addFacet(0.0,0.0,0.0, 1.0,0.0,0.0, 1.0,0.0,1.0)
 
m.addFacet(0.0,0.0,0.0, 1.0,0.0,1.0, 0.0,0.0,1.0)
 
m.addFacet(0.0,0.0,0.0, 0.0,1.0,0.0, 1.0,1.0,0.0)
 
m.addFacet(0.0,0.0,0.0, 1.0,1.0,0.0, 1.0,0.0,0.0)
 
m.addFacet(0.0,1.0,0.0, 0.0,1.0,1.0, 1.0,1.0,1.0)
 
m.addFacet(0.0,1.0,0.0, 1.0,1.0,1.0, 1.0,1.0,0.0)
 
m.addFacet(0.0,1.0,1.0, 0.0,0.0,1.0, 1.0,0.0,1.0)
 
m.addFacet(0.0,1.0,1.0, 1.0,0.0,1.0, 1.0,1.0,1.0)
 
m.addFacet(1.0,1.0,0.0, 1.0,1.0,1.0, 1.0,0.0,1.0)
 
m.addFacet(1.0,1.0,0.0, 1.0,0.0,1.0, 1.0,0.0,0.0)
 
# scale to a edge langth of 100
 
m.scale(100.0)
 
# add the mesh to the active document
 
me=doc.addObject("Mesh::Feature","Cube")
 
me.Mesh=m
 
 
}}
 
}}
 
<translate>
 
<translate>
 
+
<!--T:18-->
=== Adding an arc or a circle === <!--T:13-->
+
And our dialog will appear! Note that our Python interpreter is still working, we have a non-modal dialog. So, to close it, we can (apart from clicking its close icon, of course) issue:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import Part
+
d.hide()
doc = App.activeDocument()
 
c = Part.Circle()
 
c.Radius=10.0 
 
f = doc.addObject("Part::Feature", "Circle") # create a document with a circle feature
 
f.Shape = c.toShape() # Assign the circle shape to the shape property
 
doc.recompute()
 
 
}}
 
}}
 
<translate>
 
<translate>
  
=== Accessing and changing representation of an object === <!--T:14-->
+
== Making our dialog do something == <!--T:19-->
Each object in a FreeCAD document has an associated view representation object that stores all the parameters that define how the object appear, like color, linewidth, etc...
+
Now that we can show and hide our dialog, we just need to add one last part: To make it do something! If you play a bit with Qt designer, you'll quickly discover a whole section called "signals and slots". Basically, it works like this: elements on your widgets (in Qt terminology, those elements are themselves widgets) can send signals. Those signals differ according to the widget type. For example, a button can send a signal when it is pressed and when it is released. Those signals can be connected to slots, which can be special functionality of other widgets (for example a dialog has a "close" slot to which you can connect the signal from a close button), or can be custom functions. The [http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/classes.html PyQt Reference Documentation] lists all the qt widgets, what they can do, what signals they can send, etc...
 +
 
 +
<!--T:20-->
 +
What we will do here, is to create a new function that will create a plane based on height and width, and to connect that function to the pressed signal emitted by our "Create!" button. So, let's begin with importing our FreeCAD modules, by putting the following line at the top of the script, where we already import QtCore and QtGui:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
gad=Gui.activeDocument()  # access the active document containing all
+
import FreeCAD, Part
                          # view representations of the features in the
 
                          # corresponding App document
 
 
 
v=gad.getObject("Cube")    # access the view representation to the Mesh feature 'Cube'
 
v.ShapeColor              # prints the color to the console
 
v.ShapeColor=(1.0,1.0,1.0) # sets the shape color to white
 
 
}}
 
}}
 
<translate>
 
<translate>
 
+
<!--T:21-->
=== Observing mouse events in the 3D viewer via Python === <!--T:15-->
+
Then, let's add a new function to our Ui_Dialog class:
The Inventor framework allows to add one or more callback nodes to the scenegraph of the viewer. By default in FreeCAD one callback node is installed per viewer which allows to add global or static C++ functions. In the appropriate Python binding some methods are provided to make use of this technique from within Python code.
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
App.newDocument()
+
def createPlane(self):
v=Gui.activeDocument().activeView()
+
    try:
+
        # first we check if valid numbers have been entered
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
+
        w = float(self.width.text())
#'up' events we need a boolean flag to handle this.
+
        h = float(self.height.text())
class ViewObserver:
+
    except ValueError:
  def logPosition(self, info):
+
        print "Error! Width and Height values must be valid numbers!"
      down = (info["State"] == "DOWN")
+
    else:
      pos = info["Position"]
+
        # create a face from 4 points
      if (down):
+
        p1 = FreeCAD.Vector(0,0,0)
          FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
+
        p2 = FreeCAD.Vector(w,0,0)
     
+
        p3 = FreeCAD.Vector(w,h,0)
o = ViewObserver()
+
        p4 = FreeCAD.Vector(0,h,0)
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)
+
        pointslist = [p1,p2,p3,p4,p1]
 +
        mywire = Part.makePolygon(pointslist)
 +
        myface = Part.Face(mywire)
 +
        Part.show(myface)
 +
        self.hide()
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:16-->
+
<!--T:22-->
Now, pick somewhere on the area in the 3D viewer and observe the messages in the output window. To finish the observation just call
+
Then, we need to inform Qt to connect the button to the function, by placing the following line just before QtCore.QMetaObject.connectSlotsByName(Dialog):
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
v.removeEventCallback("SoMouseButtonEvent",c)
+
QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:17-->
+
<!--T:23-->
The following event types are supported
+
This, as you see, connects the pressed() signal of our create object (the "Create!" button), to a slot named createPlane, which we just defined. That's it! Now, as a final touch, we can add a little function to create the dialog, it will be easier to call. Outside the Ui_Dialog class, let's add this code:
* SoEvent -- all kind of events
 
* SoButtonEvent -- all mouse button and key events
 
* SoLocation2Event -- 2D movement events (normally mouse movements)
 
* SoMotion3Event -- 3D movement events (normally spaceball)
 
* SoKeyboardEvent -- key down and up events
 
* SoMouseButtonEvent -- mouse button down and up events
 
* SoSpaceballButtonEvent -- spaceball button down and up events
 
 
 
<!--T:18-->
 
The Python function that can be registered with addEventCallback() expects a dictionary. Depending on the watched event the dictionary can contain different keys.
 
 
For all events it has the keys:
 
* Type -- the name of the event type i.e. SoMouseEvent, SoLocation2Event, ...
 
* Time -- the current time as string
 
* Position -- a tuple of two integers, mouse position
 
* ShiftDown -- a boolean, true if Shift was pressed otherwise false
 
* CtrlDown -- a boolean, true if Ctrl was pressed otherwise false
 
* AltDown -- a boolean, true if Alt was pressed otherwise false
 
 
For all button events, i.e. keyboard, mouse or spaceball events
 
* State -- A string 'UP' if the button was up, 'DOWN' if it was down or 'UNKNOWN' for all other cases
 
 
For keyboard events:
 
* Key -- a character of the pressed key
 
 
For mouse button event
 
* Button -- The pressed button, could be BUTTON1, ..., BUTTON5 or ANY
 
 
For spaceball events:
 
* Button -- The pressed button, could be BUTTON1, ..., BUTTON7 or ANY
 
 
And finally motion events:
 
* Translation -- a tuple of three floats
 
* Rotation -- a quaternion for the rotation, i.e. a tuple of four floats
 
 
 
===Display keys pressed and Events command=== <!--T:50-->
 
This macro displays in the report view the keys pressed and all events command
 
</translate>
 
<syntaxhighlight>
 
App.newDocument()
 
v=Gui.activeDocument().activeView()
 
class ViewObserver:
 
  def logPosition(self, info):
 
      try:
 
          down = (info["Key"])
 
          FreeCAD.Console.PrintMessage(str(down)+"\n") # here the character pressed
 
          FreeCAD.Console.PrintMessage(str(info)+"\n") # list all events command
 
          FreeCAD.Console.PrintMessage("_______________________________________"+"\n")
 
      except Exception:
 
          None
 
 
o = ViewObserver()
 
c = v.addEventCallback("SoEvent",o.logPosition)
 
 
 
#v.removeEventCallback("SoEvent",c) # remove ViewObserver
 
</syntaxhighlight>
 
<translate>
 
=== Manipulate the scenegraph in Python === <!--T:19-->
 
It is also possible to get and change the scenegraph in Python, with the 'pivy' module -- a Python binding for Coin.
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
from pivy.coin import *                # load the pivy module
+
class plane():
view = Gui.ActiveDocument.ActiveView  # get the active viewer
+
  def __init__(self):
root = view.getSceneGraph()           # the root is an SoSeparator node
+
      self.d = QtGui.QWidget()
root.addChild(SoCube())
+
      self.ui = Ui_Dialog()
view.fitAll()
+
      self.ui.setupUi(self.d)
 +
      self.d.show()
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:20-->
+
<!--T:24-->
The Python API of pivy is created by using the tool SWIG. As we use in FreeCAD some self-written nodes you cannot create them directly in Python.
+
(Python reminder: the __init__ method of a class is automatically executed whenever a new object is created!)
However, it is possible to create a node by its internal name. An instance of the type 'SoFCSelection' can be created with
+
Then, from FreeCAD, we only need to do:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
type = SoType.fromName("SoFCSelection")
+
import mywidget
node = type.createInstance()
+
myDialog = mywidget.plane()
 
}}
 
}}
 
<translate>
 
<translate>
 +
<!--T:25-->
 +
That's all Folks... Now you can try all kinds of things, like for example inserting your widget in the FreeCAD interface (see the [[Code snippets]] page), or making much more advanced custom tools, by using other elements on your widget.
  
=== Adding and removing objects to/from the scenegraph === <!--T:21-->
+
== The complete script == <!--T:26-->
Adding new nodes to the scenegraph can be done this way. Take care of always adding a SoSeparator to contain the geometry, coordinates and material info of a same object. The following example adds a red line from (0,0,0) to (10,0,0):
+
This is the complete script, for reference:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
from pivy import coin
+
# -*- coding: utf-8 -*-
sg = Gui.ActiveDocument.ActiveView.getSceneGraph()
+
 
co = coin.SoCoordinate3()
+
# Form implementation generated from reading ui file 'mywidget.ui'
pts = [[0,0,0],[10,0,0]]
+
#
co.point.setValues(0,len(pts),pts)
+
# Created: Mon Jun  1 19:09:10 2009
ma = coin.SoBaseColor()
+
#      by: PyQt4 UI code generator 4.4.4
ma.rgb = (1,0,0)
+
# Modified for PySide 16:02:2015
li = coin.SoLineSet()
+
# WARNING! All changes made in this file will be lost!
li.numVertices.setValue(2)
+
 
no = coin.SoSeparator()
+
from PySide import QtCore, QtGui
no.addChild(co)
+
import FreeCAD, Part
no.addChild(ma)
+
 
no.addChild(li)
+
class Ui_Dialog(object):
sg.addChild(no)
+
  def setupUi(self, Dialog):
 +
      Dialog.setObjectName("Dialog")
 +
      Dialog.resize(187, 178)
 +
      self.title = QtGui.QLabel(Dialog)
 +
      self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
 +
      self.title.setObjectName("title")
 +
      self.label_width = QtGui.QLabel(Dialog)
 +
      self.label_width.setGeometry(QtCore.QRect(10, 50, 57, 16))
 +
      self.label_width.setObjectName("label_width")
 +
      self.label_height = QtGui.QLabel(Dialog)
 +
      self.label_height.setGeometry(QtCore.QRect(10, 90, 57, 16))
 +
      self.label_height.setObjectName("label_height")
 +
      self.width = QtGui.QLineEdit(Dialog)
 +
      self.width.setGeometry(QtCore.QRect(60, 40, 111, 26))
 +
      self.width.setObjectName("width")
 +
      self.height = QtGui.QLineEdit(Dialog)
 +
      self.height.setGeometry(QtCore.QRect(60, 80, 111, 26))
 +
      self.height.setObjectName("height")
 +
      self.create = QtGui.QPushButton(Dialog)
 +
      self.create.setGeometry(QtCore.QRect(50, 140, 83, 26))
 +
      self.create.setObjectName("create")
 +
 
 +
      self.retranslateUi(Dialog)
 +
      QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
 +
      QtCore.QMetaObject.connectSlotsByName(Dialog)
 +
 
 +
  def retranslateUi(self, Dialog):
 +
      Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
 +
      self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
 +
      self.label_width.setText(QtGui.QApplication.translate("Dialog", "Width", None, QtGui.QApplication.UnicodeUTF8))
 +
      self.label_height.setText(QtGui.QApplication.translate("Dialog", "Height", None, QtGui.QApplication.UnicodeUTF8))
 +
      self.create.setText(QtGui.QApplication.translate("Dialog", "Create!", None, QtGui.QApplication.UnicodeUTF8))
 +
 
 +
  def createPlane(self):
 +
      try:
 +
          # first we check if valid numbers have been entered
 +
          w = float(self.width.text())
 +
          h = float(self.height.text())
 +
      except ValueError:
 +
          print "Error! Width and Height values must be valid numbers!"
 +
      else:
 +
          # create a face from 4 points
 +
          p1 = FreeCAD.Vector(0,0,0)
 +
          p2 = FreeCAD.Vector(w,0,0)
 +
          p3 = FreeCAD.Vector(w,h,0)
 +
          p4 = FreeCAD.Vector(0,h,0)
 +
          pointslist = [p1,p2,p3,p4,p1]
 +
          mywire = Part.makePolygon(pointslist)
 +
          myface = Part.Face(mywire)
 +
          Part.show(myface)
 +
 
 +
class plane():
 +
  def __init__(self):
 +
      self.d = QtGui.QWidget()
 +
      self.ui = Ui_Dialog()
 +
      self.ui.setupUi(self.d)
 +
      self.d.show()
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:22-->
+
==Creation of a dialog with buttons== <!--T:27-->
To remove it, simply issue:
+
 
 +
===Method 1=== <!--T:28-->
 +
An example of a dialog box complete with its connections.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
sg.removeChild(no)
+
# -*- coding: utf-8 -*-
}}
+
# Create by flachyjoe
<translate>
+
 
===Saves the sceneGraph with a rotation in a series of 36 files in the X Y Z axis=== <!--T:60-->
+
from PySide import QtCore, QtGui
</translate>
+
 
 +
try:
 +
    _fromUtf8 = QtCore.QString.fromUtf8
 +
except AttributeError:
 +
    def _fromUtf8(s):
 +
        return s
 +
 
 +
try:
 +
    _encoding = QtGui.QApplication.UnicodeUTF8
 +
    def _translate(context, text, disambig):
 +
        return QtGui.QApplication.translate(context, text, disambig, _encoding)
 +
except AttributeError:
 +
    def _translate(context, text, disambig):
 +
        return QtGui.QApplication.translate(context, text, disambig)
 +
 
 +
 
 +
class Ui_MainWindow(object):
 +
 
 +
    def __init__(self, MainWindow):
 +
        self.window = MainWindow
 +
 
 +
        MainWindow.setObjectName(_fromUtf8("MainWindow"))
 +
        MainWindow.resize(400, 300)
 +
        self.centralWidget = QtGui.QWidget(MainWindow)
 +
        self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
 +
 
 +
        self.pushButton = QtGui.QPushButton(self.centralWidget)
 +
        self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
 +
        self.pushButton.setObjectName(_fromUtf8("pushButton"))
 +
        self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton
 +
 
 +
        self.lineEdit = QtGui.QLineEdit(self.centralWidget)
 +
        self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
 +
        self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
 +
        self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit
  
{{Code|code=
+
        self.checkBox = QtGui.QCheckBox(self.centralWidget)
import math
+
        self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
import time
+
        self.checkBox.setChecked(True)
from FreeCAD import Base
+
        self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
from pivy import coin
+
        self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox
  
size=(1000,1000)
+
        self.radioButton = QtGui.QRadioButton(self.centralWidget)
dirname = "C:/Temp/animation/"
+
        self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
steps=36
+
        self.radioButton.setObjectName(_fromUtf8("radioButton"))
angle=2*math.pi/steps
+
        self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton
  
matX=Base.Matrix()
+
        MainWindow.setCentralWidget(self.centralWidget)
matX.rotateX(angle)
 
stepsX=Base.Placement(matX).Rotation
 
  
matY=Base.Matrix()
+
        self.menuBar = QtGui.QMenuBar(MainWindow)
matY.rotateY(angle)
+
        self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
stepsY=Base.Placement(matY).Rotation
+
        self.menuBar.setObjectName(_fromUtf8("menuBar"))
 +
        MainWindow.setMenuBar(self.menuBar)
  
matZ=Base.Matrix()
+
        self.mainToolBar = QtGui.QToolBar(MainWindow)
matZ.rotateZ(angle)
+
        self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
stepsZ=Base.Placement(matZ).Rotation
+
        MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)
  
view=Gui.ActiveDocument.ActiveView
+
        self.statusBar = QtGui.QStatusBar(MainWindow)
cam=view.getCameraNode()
+
        self.statusBar.setObjectName(_fromUtf8("statusBar"))
rotCamera=Base.Rotation(*cam.orientation.getValue().getValue())
+
        MainWindow.setStatusBar(self.statusBar)
  
# this sets the lookat point to the center of circumsphere of the global bounding box
+
        self.retranslateUi(MainWindow)
view.fitAll()
 
  
# the camera's position, i.e. the user's eye point
+
    def retranslateUi(self, MainWindow):
position=Base.Vector(*cam.position.getValue().getValue())
+
        MainWindow.setWindowTitle(_translate("MainWindow", "MainWindow", None))
distance=cam.focalDistance.getValue()
+
        self.pushButton.setText(_translate("MainWindow", "OK", None))
 +
        self.lineEdit.setText(_translate("MainWindow", "tyty", None))
 +
        self.checkBox.setText(_translate("MainWindow", "CheckBox", None))
 +
        self.radioButton.setText(_translate("MainWindow", "RadioButton", None))
  
# view direction
+
    def on_checkBox_clicked(self):
vec=rotCamera.multVec(Base.Vector(0,0,-1))
+
        if self.checkBox.checkState()==0:
 +
            App.Console.PrintMessage(str(self.checkBox.checkState())+"  CheckBox KO\r\n")
 +
        else:   
 +
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox OK\r\n")
 +
#        App.Console.PrintMessage(str(self.lineEdit.setText("tititi"))+" LineEdit\r\n") #write text to the lineEdit window !
 +
#        str(self.lineEdit.setText("tititi")) #écrit le texte dans la fenêtre lineEdit
 +
        App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit\r\n")
  
# this is the point on the screen the camera looks at
+
    def on_radioButton_clicked(self):
# when rotating the camera we should make this point fix
+
        if self.radioButton.isChecked():
lookat=position+vec*distance
+
            App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio OK\r\n")
 +
        else:
 +
            App.Console.PrintMessage(str(self.radioButton.isChecked())+"  Radio KO\r\n")
  
# around x axis
+
    def on_lineEdit_clicked(self):
for i in range(steps):
+
#        if self.lineEdit.textChanged():
    rotCamera=stepsX.multiply(rotCamera)
+
            App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")
    cam.orientation.setValue(*rotCamera.Q)
 
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
 
    pos=lookat-vec*distance
 
    cam.position.setValue(pos.x,pos.y,pos.z)
 
    Gui.updateGui()
 
    time.sleep(0.3)
 
    view.saveImage(dirname+"x-%d.png" % i,*size)
 
  
# around y axis
+
    def on_pushButton_clicked(self):
for i in range(steps):
+
        App.Console.PrintMessage("Terminé\r\n")
    rotCamera=stepsY.multiply(rotCamera)
+
        self.window.hide()
    cam.orientation.setValue(*rotCamera.Q)
 
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
 
    pos=lookat-vec*distance
 
    cam.position.setValue(pos.x,pos.y,pos.z)
 
    Gui.updateGui()
 
    time.sleep(0.3)
 
    view.saveImage(dirname+"y-%d.png" % i,*size)
 
  
# around z axis
+
MainWindow = QtGui.QMainWindow()
for i in range(steps):
+
ui = Ui_MainWindow(MainWindow)
    rotCamera=stepsZ.multiply(rotCamera)
+
MainWindow.show()
    cam.orientation.setValue(*rotCamera.Q)
 
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
 
    pos=lookat-vec*distance
 
    cam.position.setValue(pos.x,pos.y,pos.z)
 
    Gui.updateGui()
 
    time.sleep(0.3)
 
    view.saveImage(dirname+"z-%d.png" % i,*size)
 
 
}}
 
}}
 
<translate>
 
<translate>
 +
<!--T:29-->
 +
Here the same window but with an icon on each button.
 +
 +
<!--T:50-->
 +
Download associated icons (click right "Copy the image below ...)"
  
===Adding custom widgets to the interface=== <!--T:23-->
+
<!--T:51-->
You can create custom widgets with Qt designer, transform them into a python script, and then load them into the FreeCAD interface with PySide.
+
[[File:Icone01.png]]  [[File:Icone02.png]]  [[File:Icone03.png]]
  
<!--T:24-->
 
The python code produced by the Ui python compiler (the tool that converts qt-designer .ui files into python code) generally looks like this (it is simple, you can also code it directly in python):
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
class myWidget_Ui(object):
+
# -*- coding: utf-8 -*-
def setupUi(self, myWidget):
+
 
  myWidget.setObjectName("my Nice New Widget")
+
from PySide import QtCore, QtGui
  myWidget.resize(QtCore.QSize(QtCore.QRect(0,0,300,100).size()).expandedTo(myWidget.minimumSizeHint())) # sets size of the widget
+
 
+
try:
  self.label = QtGui.QLabel(myWidget) # creates a label
+
    _fromUtf8 = QtCore.QString.fromUtf8
  self.label.setGeometry(QtCore.QRect(50,50,200,24)) # sets its size
+
except AttributeError:
  self.label.setObjectName("label") # sets its name, so it can be found by name
+
    def _fromUtf8(s):
 +
        return s
 +
 
 +
try:
 +
    _encoding = QtGui.QApplication.UnicodeUTF8
 +
    def _translate(context, text, disambig):
 +
        return QtGui.QApplication.translate(context, text, disambig, _encoding)
 +
except AttributeError:
 +
    def _translate(context, text, disambig):
 +
        return QtGui.QApplication.translate(context, text, disambig)
 +
 
 +
 
 +
class Ui_MainWindow(object):
 +
 
 +
    def __init__(self, MainWindow):
 +
        self.window = MainWindow
 +
        path = FreeCAD.ConfigGet("UserAppData")
 +
#        path = FreeCAD.ConfigGet("AppHomePath")
 +
 
 +
        MainWindow.setObjectName(_fromUtf8("MainWindow"))
 +
        MainWindow.resize(400, 300)
 +
        self.centralWidget = QtGui.QWidget(MainWindow)
 +
        self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
 +
 
 +
        self.pushButton = QtGui.QPushButton(self.centralWidget)
 +
        self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
 +
        self.pushButton.setObjectName(_fromUtf8("pushButton"))
 +
        self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton
 +
 
 +
        self.lineEdit = QtGui.QLineEdit(self.centralWidget)
 +
        self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
 +
        self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
 +
        self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit
 +
 
 +
        self.checkBox = QtGui.QCheckBox(self.centralWidget)
 +
        self.checkBox.setGeometry(QtCore.QRect(30, 90, 100, 20))
 +
        self.checkBox.setChecked(True)
 +
        self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
 +
        self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox
 +
 
 +
        self.radioButton = QtGui.QRadioButton(self.centralWidget)
 +
        self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
 +
        self.radioButton.setObjectName(_fromUtf8("radioButton"))
 +
        self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton
 +
 
 +
        MainWindow.setCentralWidget(self.centralWidget)
 +
 
 +
        self.menuBar = QtGui.QMenuBar(MainWindow)
 +
        self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
 +
        self.menuBar.setObjectName(_fromUtf8("menuBar"))
 +
        MainWindow.setMenuBar(self.menuBar)
 +
 
 +
        self.mainToolBar = QtGui.QToolBar(MainWindow)
 +
        self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
 +
        MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)
 +
 
 +
        self.statusBar = QtGui.QStatusBar(MainWindow)
 +
        self.statusBar.setObjectName(_fromUtf8("statusBar"))
 +
        MainWindow.setStatusBar(self.statusBar)
 +
 
 +
        self.retranslateUi(MainWindow)
 +
 
 +
        # Affiche un icone sur le bouton PushButton
 +
        # self.image_01 = "C:\Program Files\FreeCAD0.13\Icone01.png" # adapt the icon name
 +
        self.image_01 = path+"Icone01.png" # adapt the name of the icon
 +
        icon01 = QtGui.QIcon()
 +
        icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 +
        self.pushButton.setIcon(icon01)
 +
        self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
 +
 
 +
        # Affiche un icone sur le bouton RadioButton
 +
        # self.image_02 = "C:\Program Files\FreeCAD0.13\Icone02.png" # adapt the name of the icon
 +
        self.image_02 = path+"Icone02.png" # adapter le nom de l'icone
 +
        icon02 = QtGui.QIcon()
 +
        icon02.addPixmap(QtGui.QPixmap(self.image_02),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 +
        self.radioButton.setIcon(icon02)
 +
        # self.radioButton.setLayoutDirection(QtCore.Qt.RightToLeft) #  This command reverses the direction of the button
 +
 
 +
        # Affiche un icone sur le bouton CheckBox
 +
        # self.image_03 = "C:\Program Files\FreeCAD0.13\Icone03.png" # the name of the icon
 +
        self.image_03 = path+"Icone03.png" # adapter le nom de l'icone
 +
        icon03 = QtGui.QIcon()
 +
        icon03.addPixmap(QtGui.QPixmap(self.image_03),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 +
        self.checkBox.setIcon(icon03)
 +
        # self.checkBox.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
  
def retranslateUi(self, draftToolbar): # built-in QT function that manages translations of widgets
 
  myWidget.setWindowTitle(QtGui.QApplication.translate("myWidget", "My Widget", None, QtGui.QApplication.UnicodeUTF8))
 
  self.label.setText(QtGui.QApplication.translate("myWidget", "Welcome to my new widget!", None, QtGui.QApplication.UnicodeUTF8))
 
}}
 
<translate>
 
<!--T:25-->
 
Then, all you need to do is to create a reference to the FreeCAD Qt window, insert a custom widget into it, and "transform" this widget into yours with the Ui code we just made:
 
</translate>
 
{{Code|code=
 
app = QtGui.qApp
 
FCmw = app.activeWindow() # the active qt window, = the freecad window since we are inside it
 
# FCmw = FreeCADGui.getMainWindow() # use this line if the 'addDockWidget' error is declared
 
myNewFreeCADWidget = QtGui.QDockWidget() # create a new dckwidget
 
myNewFreeCADWidget.ui = myWidget_Ui() # load the Ui script
 
myNewFreeCADWidget.ui.setupUi(myNewFreeCADWidget) # setup the ui
 
FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window
 
}}
 
<translate>
 
  
===Adding a Tab to the Combo View=== <!--T:26-->
+
    def retranslateUi(self, MainWindow):
The following code allows you to add a tab to the FreeCAD ComboView, besides the "Project" and "Tasks" tabs. It also uses the uic module to load an ui file directly in that tab.
+
        MainWindow.setWindowTitle(_translate("MainWindow", "FreeCAD", None))
</translate>
+
        self.pushButton.setText(_translate("MainWindow", "OK", None))
{{Code|code=
+
        self.lineEdit.setText(_translate("MainWindow", "tyty", None))
# create new Tab in ComboView
+
        self.checkBox.setText(_translate("MainWindow", "CheckBox", None))
from PySide import QtGui,QtCore
+
        self.radioButton.setText(_translate("MainWindow", "RadioButton", None))
#from PySide import uic
 
  
def getMainWindow():
+
    def on_checkBox_clicked(self):
  "returns the main window"
+
        if self.checkBox.checkState()==0:
  # using QtGui.qApp.activeWindow() isn't very reliable because if another
+
            App.Console.PrintMessage(str(self.checkBox.checkState())+"  CheckBox KO\r\n")
  # widget than the mainwindow is active (e.g. a dialog) the wrong widget is
+
        else:   
  # returned
+
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox OK\r\n")
  toplevel = QtGui.qApp.topLevelWidgets()
+
          # App.Console.PrintMessage(str(self.lineEdit.setText("tititi"))+" LineEdit\r\n") # write text to the lineEdit window !
  for i in toplevel:
+
           # str(self.lineEdit.setText("tititi")) #écrit le texte dans la fenêtre lineEdit
      if i.metaObject().className() == "Gui::MainWindow":
+
        App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit\r\n")
           return i
 
  raise Exception("No main window found")
 
  
def getComboView(mw):
+
    def on_radioButton_clicked(self):
  dw=mw.findChildren(QtGui.QDockWidget)
+
        if self.radioButton.isChecked():
  for i in dw:
+
            App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio OK\r\n")
      if str(i.objectName()) == "Combo View":
+
        else:
          return i.findChild(QtGui.QTabWidget)
+
            App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio KO\r\n")
      elif str(i.objectName()) == "Python Console":
 
          return i.findChild(QtGui.QTabWidget)
 
  raise Exception ("No tab widget found")
 
  
mw = getMainWindow()
+
    def on_lineEdit_clicked(self):
tab = getComboView(getMainWindow())
+
          # if self.lineEdit.textChanged():
tab2=QtGui.QDialog()
+
          App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")
tab.addTab(tab2,"A Special Tab")
 
  
#uic.loadUi("/myTaskPanelforTabs.ui",tab2)
+
    def on_pushButton_clicked(self):
tab2.show()
+
        App.Console.PrintMessage("Terminé\r\n")
#tab.removeTab(2)
+
        self.window.hide()
  
 +
MainWindow = QtGui.QMainWindow()
 +
ui = Ui_MainWindow(MainWindow)
 +
MainWindow.show()
 
}}
 
}}
 
<translate>
 
<translate>
===Enable or disable a window=== <!--T:47-->
+
<!--T:30-->
 +
Here the code to display the icon on the '''pushButton''', change the name for another button, ('''radioButton, checkBox''') and the path to the icon.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
from PySide import QtGui
+
        # Affiche un icône sur le bouton PushButton
mw=FreeCADGui.getMainWindow()
+
        # self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # the name of the icon
dws=mw.findChildren(QtGui.QDockWidget)
+
        self.image_01 = path+"icone01.png" # the name of the icon
 
+
        icon01 = QtGui.QIcon()  
# objectName may be :
+
        icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
# "Report view"
+
        self.pushButton.setIcon(icon01)  
# "Tree view"
+
        self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
# "Property view"
 
# "Selection view"
 
# "Combo View"
 
# "Python console"
 
# "draftToolbar"
 
 
 
for i in dws:
 
  if i.objectName() == "Report view":
 
    dw=i
 
    break
 
 
 
va=dw.toggleViewAction()
 
va.setChecked(True)       # True or False
 
dw.setVisible(True)       # True or False
 
 
}}
 
}}
 
<translate>
 
<translate>
 
+
<!--T:31-->
===Opening a custom webpage=== <!--T:27-->
+
The command
 +
'''UserAppData''' gives the user path
 +
'''AppHomePath''' gives the installation path of FreeCAD
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import WebGui
+
#        path = FreeCAD.ConfigGet("UserAppData")
WebGui.openBrowser("http://www.example.com")
+
        path = FreeCAD.ConfigGet("AppHomePath")
 
}}
 
}}
 
<translate>
 
<translate>
 
+
<!--T:32-->
===Getting the HTML contents of an opened webpage=== <!--T:28-->
+
This command reverses the horizontal button, right to left.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
from PySide import QtGui,QtWebKit
+
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
a = QtGui.qApp
 
mw = a.activeWindow()
 
v = mw.findChild(QtWebKit.QWebFrame)
 
html = unicode(v.toHtml())
 
print html
 
 
}}
 
}}
 
<translate>
 
<translate>
  
===Retrieve and use the coordinates of 3 selected points or objects=== <!--T:29-->
+
===Method 2=== <!--T:33-->
 +
Another method to display a window, here by creating a file '''QtForm.py''' which contains the header program (module called with '''import QtForm'''), and a second module that contains the code window all these accessories, and your code (the calling module).
 +
 
 +
<!--T:34-->
 +
This method requires two separate files, but allows to shorten your program using the file ' ' QtForm.py ' ' import. Then distribute the two files together, they are inseparable.
 +
 
 +
<!--T:35-->
 +
The file '''QtForm.py'''
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
 +
 
# -*- coding: utf-8 -*-
 
# -*- coding: utf-8 -*-
# the line above to put the accentuated in the remarks
+
# Create by flachyjoe
# If this line is missing, an error will be returned
+
from PySide import QtCore, QtGui
# extract and use the coordinates of 3 objects selected
 
import Part, FreeCAD, math, PartGui, FreeCADGui
 
from FreeCAD import Base, Console
 
sel = FreeCADGui.Selection.getSelection() # " sel " contains the items selected
 
if len(sel)!=3 :
 
  # If there are no 3 objects selected, an error is displayed in the report view
 
  # The \r and \n at the end of line mean return and the newline CR + LF.
 
  Console.PrintError("Select 3 points exactly\r\n")
 
else :
 
  points=[]
 
  for obj in sel:
 
    points.append(obj.Shape.BoundBox.Center)
 
  
  for pt in points:
+
try:
     # display of the coordinates in the report view
+
     _fromUtf8 = QtCore.QString.fromUtf8
    Console.PrintMessage(str(pt.x)+"\r\n")
+
except AttributeError:
    Console.PrintMessage(str(pt.y)+"\r\n")
+
  def _fromUtf8(s):
    Console.PrintMessage(str(pt.z)+"\r\n")
+
      return s
  
  Console.PrintMessage(str(pt[1]) + "\r\n")
+
try:
 +
    _encoding = QtGui.QApplication.UnicodeUTF8
 +
    def _translate(context, text, disambig):
 +
      return QtGui.QApplication.translate(context, text, disambig, _encoding)
 +
except AttributeError:
 +
  def _translate(context, text, disambig):
 +
      return QtGui.QApplication.translate(context, text, disambig)
 +
 
 +
class Form(object):
 +
  def __init__(self, title, width, height):
 +
      self.window = QtGui.QMainWindow()
 +
      self.title=title
 +
      self.window.setObjectName(_fromUtf8(title))
 +
      self.window.setWindowTitle(_translate(self.title, self.title, None))
 +
      self.window.resize(width, height)
 +
 
 +
  def show(self):
 +
      self.createUI()
 +
      self.retranslateUI()
 +
      self.window.show()
 +
 
 +
  def setText(self, control, text):
 +
      control.setText(_translate(self.title, text, None))
 
}}
 
}}
 
<translate>
 
<translate>
 +
<!--T:36-->
 +
The calling file that contains the window and your code.
 +
 +
<!--T:37-->
 +
The file my_file.py
  
===List all objects=== <!--T:30-->
+
<!--T:38-->
 +
The connections are to do, a good exercise.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
 +
 
# -*- coding: utf-8 -*-
 
# -*- coding: utf-8 -*-
import FreeCAD,Draft
+
# Create by flachyjoe
# List all objects of the document
+
from PySide import QtCore, QtGui
doc = FreeCAD.ActiveDocument
+
import QtForm
objs = FreeCAD.ActiveDocument.Objects
 
#App.Console.PrintMessage(str(objs) + "\n")
 
#App.Console.PrintMessage(str(len(FreeCAD.ActiveDocument.Objects)) + " Objects"  + "\n")
 
  
for obj in objs:
+
class myForm(QtForm.Form):
    a = obj.Name                                            # list the Name  of the object  (not modifiable)
+
  def createUI(self):
    b = obj.Label                                            # list the Label of the object  (modifiable)
+
      self.centralWidget = QtGui.QWidget(self.window)
    try:
+
      self.window.setCentralWidget(self.centralWidget)
        c = obj.LabelText                                    # list the LabeText of the text (modifiable)
+
     
        App.Console.PrintMessage(str(a) +" "+ str(b) +" "+ str(c) + "\n") # Displays the Name the Label and the text
+
      self.pushButton = QtGui.QPushButton(self.centralWidget)
    except:
+
      self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
        App.Console.PrintMessage(str(a) +" "+ str(b) + "\n") # Displays the Name and the Label of the object
+
      self.pushButton.clicked.connect(self.on_pushButton_clicked)
 +
     
 +
      self.lineEdit = QtGui.QLineEdit(self.centralWidget)
 +
      self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
 +
     
 +
      self.checkBox = QtGui.QCheckBox(self.centralWidget)
 +
      self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
 +
      self.checkBox.setChecked(True)
 +
     
 +
      self.radioButton = QtGui.QRadioButton(self.centralWidget)
 +
      self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
 +
 
 +
  def retranslateUI(self):
 +
      self.setText(self.pushButton, "Fermer")
 +
      self.setText(self.lineEdit, "essai de texte")
 +
      self.setText(self.checkBox, "CheckBox")
 +
      self.setText(self.radioButton, "RadioButton")
 +
 
 +
  def on_pushButton_clicked(self):
 +
      self.window.hide()
  
#doc.removeObject("Box") # Clears the designated object
+
myWindow=myForm("Fenetre de test",400,300)
 +
myWindow.show()
 
}}
 
}}
 
<translate>
 
<translate>
===List the dimensions of an object, given its name=== <!--T:51-->
+
 
 +
<!--T:52-->
 +
'''Other example'''
 +
<center>
 +
<gallery widths="400" heights="200">
 +
Image:Qt_Example_00.png|Qt example 1
 +
Image:Qt_Example_01.png|Qt example details
 +
</gallery>
 +
</center>
 +
{{clear}}
 +
 
 +
<!--T:53-->
 +
Are treated :
 +
 
 +
<!--T:54-->
 +
# icon for window
 +
# horizontalSlider
 +
# progressBar horizontal
 +
# verticalSlider
 +
# progressBar vertical
 +
# lineEdit
 +
# lineEdit
 +
# doubleSpinBox
 +
# doubleSpinBox
 +
# doubleSpinBox
 +
# button
 +
# button
 +
# radioButton with icons
 +
# checkBox with icon checked and unchecked
 +
# textEdit
 +
# graphicsView with 2 graphes
 +
The code page and the icons [[Qt_Example|Qt_Example]]
 
</translate>
 
</translate>
<syntaxhighlight>
+
<translate>
for edge in FreeCAD.ActiveDocument.MyObjectName.Shape.Edges: # replace "MyObjectName" for list
+
 
    print edge.Length
+
==Icon personalised in ComboView== <!--T:64-->
</syntaxhighlight>
+
 
 +
<!--T:65-->
 +
Here an example to create an object with properties and icon personalised in ComboView
 +
 
 +
<!--T:66-->
 +
Download the example icon to the same directory as the macro [[File:FreeCADIco.png|icon Example for the macro|24px]]
  
<translate>
+
<!--T:67-->
 +
Use of an icon for three different use cases: icon_in_file_disk (format .png), icon_XPM_in_macro (format .XPM) and icon_resource_FreeCAD
  
===Function resident with the mouse click action=== <!--T:31-->
 
 
</translate>
 
</translate>
Here with '''SelObserver''' on a object select
+
[[File:Qt_Example_02.png|icon personalised]]
 +
{{clear}}
 +
 
 
{{Code|code=
 
{{Code|code=
# -*- coding: utf-8 -*-
+
import PySide
# causes an action to the mouse click on an object
+
import FreeCAD, FreeCADGui, Part
# This function remains resident (in memory) with the function "addObserver(s)"
+
from pivy import coin
# "removeObserver(s) # Uninstalls the resident function
+
from PySide import QtGui ,QtCore
class SelObserver:
+
from PySide.QtGui import *
    def setPreselection(self,doc,obj,sub):                # Preselection object
+
from PySide.QtCore import *
        App.Console.PrintMessage(str(sub)+ "\n")          # The part of the object name
+
import Draft
  
    def addSelection(self,doc,obj,sub,pnt):              # Selection object
+
global path
        App.Console.PrintMessage("addSelection"+ "\n")
+
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
        App.Console.PrintMessage(str(doc)+ "\n")          # Name of the document
+
path = param.GetString("MacroPath","") + "/"                       # macro path
        App.Console.PrintMessage(str(obj)+ "\n")          # Name of the object
+
path = path.replace("\\","/")                                       # convert the "\" to "/"
        App.Console.PrintMessage(str(sub)+ "\n")         # The part of the object name
 
        App.Console.PrintMessage(str(pnt)+ "\n")          # Coordinates of the object
 
        App.Console.PrintMessage("______"+ "\n")
 
  
    def removeSelection(self,doc,obj,sub):                # Delete the selected object
 
        App.Console.PrintMessage("removeSelection"+ "\n")
 
  
     def setSelection(self,doc):                           # Selection in ComboView
+
class IconViewProviderToFile:                                      # Class ViewProvider create Property view of object
         App.Console.PrintMessage("setSelection"+ "\n")
+
    def __init__( self, obj, icon):
 +
        self.icone = icon
 +
       
 +
    def getIcon(self):                                              # GetIcon
 +
        return self.icone
 +
       
 +
     def attach(self, obj):                                         # Property view of object
 +
        self.modes = []
 +
        self.modes.append("Flat Lines")
 +
        self.modes.append("Shaded")
 +
        self.modes.append("Wireframe")
 +
        self.modes.append("Points")
 +
        obj.addDisplayMode( coin.SoGroup(),"Flat Lines" )          # Display Mode
 +
        obj.addDisplayMode( coin.SoGroup(),"Shaded" )
 +
         obj.addDisplayMode( coin.SoGroup(),"Wireframe" )
 +
        obj.addDisplayMode( coin.SoGroup(),"Points" )
 +
        return self.modes
 +
 
 +
    def getDisplayModes(self,obj):
 +
        return self.modes
  
    def clearSelection(self,doc):                        # If click on the screen, clear the selection
+
#####################################################
        App.Console.PrintMessage("clearSelection"+ "\n")  # If click on another object, clear the previous object
+
########## Example with icon to file # begin ########
s =SelObserver()
+
#####################################################
FreeCADGui.Selection.addObserver(s)                      # install the function mode resident
 
#FreeCADGui.Selection.removeObserver(s)                  # Uninstall the resident function
 
}}
 
  
Other example with '''ViewObserver''' on a object select or view
+
object1 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_In_File_Disk")                                     # create your object
<syntaxhighlight>
+
object1.addProperty("App::PropertyString","Identity", "ExampleTitle0", "Identity of object").Identity = "FCSpring"        # Identity of object
App.newDocument()
+
object1.addProperty("App::PropertyFloat" ,"Pitch",   "ExampleTitle0", "Pitch betwen 2 heads").Pitch  = 2.0              # other Property Data
v=Gui.activeDocument().activeView()
+
object1.addProperty("App::PropertyBool"  ,"View",    "ExampleTitle1", "Hello world").View           = True              # ...
+
object1.addProperty("App::PropertyColor" ,"LineColor","ExampleTitle2", "Color to choice").LineColor  = (0.13,0.15,0.37) # ...
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
+
#...other Property Data
#'up' events we need a boolean flag to handle this.
+
#...other Property Data
class ViewObserver:
+
#
   def __init__(self, view):
+
object1.ViewObject.Proxy = IconViewProviderToFile( object1, path + "FreeCADIco.png")                                     # icon download to file
      self.view = view
+
App.ActiveDocument.recompute()
 
+
#
  def logPosition(self, info):
+
#__Detail__:
      down = (info["State"] == "DOWN")
+
# FreeCAD.ActiveDocument.addObject( = create now object personalized
      pos = info["Position"]
+
# "App::FeaturePython",            = object as FeaturePython
      if (down):
+
# "Icon_In_File_Disk")             = internal name of your object
           FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
+
#
          pnt = self.view.getPoint(pos)
+
#
          FreeCAD.Console.PrintMessage("World coordinates: " + str(pnt) + "\n")
+
# "App::PropertyString",    = type of Property , availlable : PropertyString, PropertyFloat, PropertyBool, PropertyColor
          info = self.view.getObjectInfo(pos)
+
# "Identity",              = name of the feature
          FreeCAD.Console.PrintMessage("Object info: " + str(info) + "\n")
+
# "ExampleTitle0",          = title of the "section"
 +
# "Identity of object")     = tooltip displayed on mouse
 +
# .Identity                = variable (same of name of the feature)
 +
# object1.ViewObject.Proxy  = create the view object and gives the icon
 +
#
 +
########## example with icon to file end
  
o = ViewObserver(v)
 
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)
 
  
</syntaxhighlight>
 
<translate>
 
===Finding-selecting all elements below cursor=== <!--T:58-->
 
</translate>
 
{{Code|code=
 
from pivy import coin
 
import FreeCADGui
 
  
def mouse_over_cb( event_callback):
+
#####################################################
    event = event_callback.getEvent()
+
########## Example with icon in macro # begin #######
    pos = event.getPosition().getValue()
+
#####################################################
    listObjects = FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo((int(pos[0]),int(pos[1])))
 
    obj = []
 
    if listObjects:
 
        FreeCAD.Console.PrintMessage("\n *** Objects under mouse pointer ***")
 
        for o in listObjects:
 
            label = str(o["Object"])
 
            if not label in obj:
 
                obj.append(label)
 
        FreeCAD.Console.PrintMessage("\n"+str(obj))
 
  
 +
def setIconInMacro(self):        # def contener the icon in format .xpm
 +
    # File format XPM created by Gimp "https://www.gimp.org/"
 +
    # Choice palette Tango
 +
    # Create your masterwork ...
 +
    # For export the image in XPM format
 +
    #    Menu File > Export as > .xpm
 +
    # (For convert image true color in Tango color palette :
 +
    #    Menu Image > Mode > Indexed ... > Use custom palette > Tango Icon Theme > Convert)
 +
    return """
 +
            /* XPM */
 +
            static char * XPM[] = {
 +
            "22 24 5 1",
 +
            " c None",
 +
            ". c #CE5C00",
 +
            "+ c #EDD400",
 +
            "@ c #F57900",
 +
            "# c #8F5902",
 +
            "                      ",
 +
            "                      ",
 +
            "  ....                ",
 +
            "  ..@@@@..            ",
 +
            "  . ...@......        ",
 +
            "  .+++++++++...      ",
 +
            "  .      ....++...    ",
 +
            "  .@..@@@@@@.+++++..  ",
 +
            "  .@@@@@..#  ++++ ..  ",
 +
            "  .      ++++  .@..  ",
 +
            "  .++++++++  .@@@.+.  ",
 +
            " .      ..@@@@@. ++.  ",
 +
            " ..@@@@@@@@@.  +++ .  ",
 +
            " ....@...# +++++ @..  ",
 +
            " .    ++++++++ .@. .  ",
 +
            " .++++++++  .@@@@ .  ",
 +
            " .  #....@@@@. ++.  ",
 +
            " .@@@@@@@@@.. +++ .  ",
 +
            " ........  +++++...  ",
 +
            " ...  ..+++++ ..@..  ",
 +
            "    ......  .@@@ +.  ",
 +
            "          ......++.  ",
 +
            "                ...  ",
 +
            "                      "};
 +
        """
  
view = FreeCADGui.ActiveDocument.ActiveView
+
object2 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_XPM_In_Macro")                                    #
 +
object2.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
 +
#...other Property Data
 +
#...other Property Data
 +
#
 +
object2.ViewObject.Proxy = IconViewProviderToFile( object2, setIconInMacro(""))              # icon in macro (.XPM)
 +
App.ActiveDocument.recompute()
 +
########## example with icon in macro end
  
mouse_over = view.addEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over_cb )
 
  
# to remove Callback :
 
#view.removeEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over)
 
  
####
+
####################################################################
#The easy way is probably to use FreeCAD's selection.
+
########## Example with icon to FreeCAD ressource # begin ##########
#FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo(mouse_coords)
+
####################################################################
  
####
+
object3 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_Ressource_FreeCAD")                              #
#you get that kind of result :
+
object3.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
#'Document': 'Unnamed', 'Object': 'Box', 'Component': 'Face2', 'y': 8.604081153869629, 'x': 21.0, 'z': 8.553047180175781
+
#...other Property Data
 +
#...other Property Data
 +
#
 +
object3.ViewObject.Proxy = IconViewProviderToFile( object3, ":/icons/Draft_Draft.svg")      # icon to FreeCAD ressource
 +
App.ActiveDocument.recompute()
 +
########## example with icon to FreeCAD ressource end
  
####
 
#You can use this data to add your element to FreeCAD's selection :
 
#FreeCADGui.Selection.addSelection(FreeCAD.ActiveDocument.Box,'Face2',21.0,8.604081153869629,8.553047180175781)
 
 
}}
 
}}
 +
 
<translate>
 
<translate>
 +
<!--T:68-->
 +
Complete example creating a cube and its icon
 +
</translate>
  
===List the components of an object=== <!--T:32-->
 
</translate>
 
 
{{Code|code=
 
{{Code|code=
# -*- coding: utf-8 -*-
+
#https://forum.freecadweb.org/viewtopic.php?t=10255#p83319
# This function list the components of an object
+
import FreeCAD, Part, math
# and extract this object its XYZ coordinates,
+
from FreeCAD import Base
# its edges and their lengths center of mass and coordinates
+
from PySide import QtGui
# its faces and their center of mass
 
# its faces and their surfaces and coordinates
 
# 8/05/2014
 
  
import Draft,Part
+
global path
def detail():
+
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
    sel = FreeCADGui.Selection.getSelection()   # Select an object
+
path = param.GetString("MacroPath","") + "/"                        # macro path
    if len(sel) != 0:                          # If there is a selection then
+
path = path.replace("\\","/")                                       # convert the "\" to "/"
        Vertx=[]
 
        Edges=[]
 
        Faces=[]
 
        compt_V=0
 
        compt_E=0
 
        compt_F=0
 
        pas    =0
 
        perimetre = 0.0 
 
        EdgesLong = []
 
  
         # Displays the "Name" and the "Label" of the selection
+
def setIconInMacro(self):
         App.Console.PrintMessage("Selection > " + str(sel[0].Name) + "  " + str(sel[0].Label) +"\n"+"\n")
+
    return """
 +
        /* XPM */
 +
        static char * xpm[] = {
 +
        "22 22 12 1",
 +
        " c None",
 +
        ". c #A40000",
 +
        "+ c #2E3436",
 +
        "@ c #CE5C00",
 +
        "# c #F57900",
 +
        "$ c #FCAF3E",
 +
        "% c #5C3566",
 +
        "& c #204A87",
 +
         "* c #555753",
 +
        "= c #3465A4",
 +
        "- c #4E9A06",
 +
         "; c #729FCF",
 +
        "                      ",
 +
        "                      ",
 +
        "                      ",
 +
        "        ..   ..      ",
 +
        "      +@#+++.$$      ",
 +
        "       +.#+%..$$      ",
 +
        "      &*$  &*#*      ",
 +
        "      &  =&=  =      ",
 +
        "  ++&  +.==  %=    ",
 +
        ++$@ ..$ %=  &    ",
 +
        " ..-&%.#$$ &## +=$  ",
 +
        "  .#  ..$ ..#%%.#$$  ",
 +
        "    ;    =+=## %-$#  ",
 +
        "    &=  ;&  %=    ",
 +
        "      ;+ &=;  %=      ",
 +
        "      ++$- +*$-      ",
 +
        "     .#&&+.@$$      ",
 +
        "      ..$# ..$#      ",
 +
        "      ..  ..        ",
 +
        "                      ",
 +
        "                      ",
 +
        "                      "};
 +
        """
  
        for j in enumerate(sel[0].Shape.Edges):                                     # Search the "Edges" and their lengths
+
class PartFeature:
            compt_E+=1
+
    def __init__(self, obj):
            Edges.append("Edge%d" % (j[0]+1))
+
        obj.Proxy = self
            EdgesLong.append(str(sel[0].Shape.Edges[compt_E-1].Length))
 
            perimetre += (sel[0].Shape.Edges[compt_E-1].Length)                    # calculates the perimeter
 
  
            # Displays the "Edge" and its length
+
class Box(PartFeature):
            App.Console.PrintMessage("Edge"+str(compt_E)+" Length > "+str(sel[0].Shape.Edges[compt_E-1].Length)+"\n")
+
    def __init__(self, obj):
 +
        PartFeature.__init__(self, obj)
 +
        obj.addProperty("App::PropertyLength", "Length", "Box", "Length of the box").Length = 1.0
 +
        obj.addProperty("App::PropertyLength", "Width",  "Box", "Width of the box" ).Width  = 1.0
 +
        obj.addProperty("App::PropertyLength", "Height", "Box", "Height of the box").Height = 1.0
  
             # Displays the "Edge" and its center mass
+
    def onChanged(self, fp, prop):
            App.Console.PrintMessage("Edge"+str(compt_E)+" Center > "+str(sel[0].Shape.Edges[compt_E-1].CenterOfMass)+"\n")
+
        try:
 +
             if prop == "Length" or prop == "Width" or prop == "Height":
 +
                fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
 +
        except:
 +
            pass
  
            num = sel[0].Shape.Edges[compt_E-1].Vertexes[0]
+
    def execute(self, fp):
            Vertx.append("X1: "+str(num.Point.x))
+
        fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
            Vertx.append("Y1: "+str(num.Point.y))
 
            Vertx.append("Z1: "+str(num.Point.z))
 
            # Displays the coordinates 1
 
            App.Console.PrintMessage("X1: "+str(num.Point[0])+" Y1: "+str(num.Point[1])+" Z1: "+str(num.Point[2])+"\n")
 
  
            try:
+
class ViewProviderBox:
                num = sel[0].Shape.Edges[compt_E-1].Vertexes[1]
+
    def __init__(self, obj, icon):
                Vertx.append("X2: "+str(num.Point.x))
+
        obj.Proxy  = self
                Vertx.append("Y2: "+str(num.Point.y))
+
        self.icone = icon
                Vertx.append("Z2: "+str(num.Point.z))
+
       
            except:
+
    def getIcon(self):
                Vertx.append("-")
+
         return self.icone
                Vertx.append("-")
 
                Vertx.append("-")
 
            # Displays the coordinates 2
 
            App.Console.PrintMessage("X2: "+str(num.Point[0])+" Y2: "+str(num.Point[1])+" Z2: "+str(num.Point[2])+"\n")
 
 
 
            App.Console.PrintMessage("\n")
 
         App.Console.PrintMessage("Perimeter of the form  : "+str(perimetre)+"\n")
 
  
        App.Console.PrintMessage("\n")
+
    def attach(self, obj):
         FacesSurf = []
+
         return
        for j in enumerate(sel[0].Shape.Faces):                                      # Search the "Faces" and their surface
 
            compt_F+=1
 
            Faces.append("Face%d" % (j[0]+1))
 
            FacesSurf.append(str(sel[0].Shape.Faces[compt_F-1].Area))
 
  
            # Displays 'Face' and its surface
+
    def setupContextMenu(self, obj, menu):
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Surface "+str(sel[0].Shape.Faces[compt_F-1].Area)+"\n")
+
        action = menu.addAction("Set default height")
 +
        action.triggered.connect(lambda f=self.setDefaultHeight, arg=obj:f(arg))
  
            # Displays 'Face' and its CenterOfMass
+
        action = menu.addAction("Hello World")
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Center  "+str(sel[0].Shape.Faces[compt_F-1].CenterOfMass)+"\n")
+
        action.triggered.connect(self.showHelloWorld)
  
            # Displays 'Face' and its Coordinates
+
    def setDefaultHeight(self, view):
            FacesCoor = []
+
        view.Object.Height = 15.0
            fco = 0
 
            for f0 in sel[0].Shape.Faces[compt_F-1].Vertexes:                        # Search the Vertexes of the face
 
                fco += 1
 
                FacesCoor.append("X"+str(fco)+": "+str(f0.Point.x))
 
                FacesCoor.append("Y"+str(fco)+": "+str(f0.Point.y))
 
                FacesCoor.append("Z"+str(fco)+": "+str(f0.Point.z))
 
  
            # Displays 'Face' and its Coordinates
+
    def showHelloWorld(self):
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Coordinate"+str(FacesCoor)+"\n")
+
        QtGui.QMessageBox.information(None, "Hi there", "Hello World")
  
            # Displays 'Face' and its Volume
+
def makeBox():
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Volume  "+str(sel[0].Shape.Faces[compt_F-1].Volume)+"\n")
+
    FreeCAD.newDocument()
            App.Console.PrintMessage("\n")
+
    a=FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Box")
 +
    Box(a)
 +
#    ViewProviderBox(a.ViewObject, path + "FreeCADIco.png")    # icon download to file
 +
#    ViewProviderBox(a.ViewObject,  ":/icons/Draft_Draft.svg") # icon to FreeCAD ressource
 +
    ViewProviderBox(a.ViewObject,  setIconInMacro(""))        # icon in macro (.XPM)
 +
    App.ActiveDocument.recompute()
  
        # Displays the total surface of the form
+
makeBox()
        App.Console.PrintMessage("Surface of the form    : "+str(sel[0].Shape.Area)+"\n")
 
  
        # Displays the total Volume of the form
 
        App.Console.PrintMessage("Volume  of the form    : "+str(sel[0].Shape.Volume)+"\n")
 
  
detail()
 
 
}}
 
}}
 
<translate>
 
<translate>
  
===List the PropertiesList=== <!--T:33-->
+
==Use QFileDialog for writing to a file== <!--T:61-->
 +
Complete code:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import FreeCADGui
+
# -*- coding: utf-8 -*-
from FreeCAD import Console
+
import PySide
o = App.ActiveDocument.ActiveObject
+
from PySide import QtGui ,QtCore
op = o.PropertiesList
+
from PySide.QtGui import *
for p in op:
+
from PySide.QtCore import *
     Console.PrintMessage("Property: "+ str(p)+ " Value: " + str(o.getPropertyByName(p))+"\r\n")
+
path = FreeCAD.ConfigGet("UserAppData")
 +
 
 +
try:
 +
    SaveName = QFileDialog.getSaveFileName(None,QString.fromLocal8Bit("Save a file txt"),path,            "*.txt") # PyQt4
 +
#                                                                    "here the text displayed on windows" "here the filter (extension)" 
 +
except Exception:
 +
    SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Save a file txt", path,            "*.txt") # PySide
 +
#                                                                    "here the text displayed on windows" "here the filter (extension)" 
 +
if SaveName == "":                                                           # if the name file are not selected then Abord process
 +
     App.Console.PrintMessage("Process aborted"+"\n")
 +
else:                                                                         # if the name file are selected or created then
 +
    App.Console.PrintMessage("Registration of "+SaveName+"\n")                # text displayed to Report view (Menu > View > Report view checked)
 +
    try:                                                                      # detect error ...
 +
        file = open(SaveName, 'w')                                            # open the file selected to write (w)
 +
        try:                                                                  # if error detected to write ...
 +
            # here your code
 +
            print "here your code"
 +
            file.write(str(1)+"\n")                                          # write the number convert in text with (str())
 +
            file.write("FreeCAD the best")                                   # write the the text with ("  ")
 +
        except Exception:                                                    # if error detected to write
 +
            App.Console.PrintError("Error write file "+"\n")                  # detect error ... display the text in red (PrintError)
 +
        finally:                                                              # if error detected to write ... or not the file is closed
 +
            file.close()                                                      # if error detected to write ... or not the file is closed
 +
    except Exception:
 +
        App.Console.PrintError("Error Open file "+SaveName+"\n")     # detect error ... display the text in red (PrintError)
 +
 
 
}}
 
}}
 
<translate>
 
<translate>
===Adding one Property "Comment"=== <!--T:54-->
+
 
 +
==Use QFileDialog to read a file== <!--T:62-->
 +
Complete code:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import Draft
+
# -*- coding: utf-8 -*-
obj = FreeCADGui.Selection.getSelection()[0]
+
import PySide
obj.addProperty("App::PropertyString","GComment","Draft","Font name").GComment = "Comment here"
+
from PySide import QtGui ,QtCore
App.activeDocument().recompute()
+
from PySide.QtGui import *
}}
+
from PySide.QtCore import *
 +
path = FreeCAD.ConfigGet("UserAppData")
 +
 
 +
OpenName = ""
 +
try:
 +
    OpenName = QFileDialog.getOpenFileName(None,QString.fromLocal8Bit("Read a file txt"),path,            "*.txt") # PyQt4
 +
#                                                                    "here the text displayed on windows" "here the filter (extension)"  
 +
except Exception:
 +
    OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Read a file txt", path,            "*.txt") #PySide
 +
#                                                                    "here the text displayed on windows" "here the filter (extension)"  
 +
if OpenName == "":                                                            # if the name file are not selected then Abord process
 +
    App.Console.PrintMessage("Process aborted"+"\n")
 +
else:
 +
    App.Console.PrintMessage("Read "+OpenName+"\n")                          # text displayed to Report view (Menu > View > Report view checked)
 +
    try:                                                                      # detect error to read file
 +
        file = open(OpenName, "r")                                            # open the file selected to read (r)  # (rb is binary)
 +
        try:                                                                  # detect error ...
 +
            # here your code
 +
            print "here your code"
 +
            op = OpenName.split("/")                                         # decode the path
 +
            op2 = op[-1].split(".")                                           # decode the file name
 +
            nomF = op2[0]                                                    # the file name are isolated
  
<translate>
+
            App.Console.PrintMessage(str(nomF)+"\n")                          # the file name are displayed
===Search and data extraction=== <!--T:36-->
 
  
<!--T:37-->
+
            for ligne in file:                                               # read the file
Examples of research and decoding information on an object.
+
                X  = ligne.rstrip('\n\r') #.split()                          # decode the line
 +
                print X                                                      # print the line in report view other method
 +
                                                                              # (Menu > Edit > preferences... > Output window > Redirect internal Python output (and errors) to report view checked)
 +
        except Exception:                                                    # if error detected to read
 +
            App.Console.PrintError("Error read file "+"\n")                  # detect error ... display the text in red (PrintError)
 +
        finally:                                                              # if error detected to read ... or not error the file is closed
 +
            file.close()                                                      # if error detected to read ... or not error the file is closed
 +
    except Exception:                                                        # if one error detected to read file
 +
        App.Console.PrintError("Error in Open the file "+OpenName+"\n")      # if one error detected ... display the text in red (PrintError)
  
<!--T:38-->
+
}}
Each section is independently and is separated by "############" can be copied directly into the Python console, or in a macro or use this macro. The description of the macro in the commentary.
+
<translate>
  
<!--T:39-->
+
==Use QColorDialog to get the color== <!--T:63-->
Displaying it in the "View Report" window (View > Views > View report)
+
Complete code:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
 +
# -*- coding: utf-8 -*-
 +
# https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QColor.html
 +
import PySide
 +
from PySide import QtGui ,QtCore
 +
from PySide.QtGui import *
 +
from PySide.QtCore import *
 +
path = FreeCAD.ConfigGet("UserAppData")
  
# -*- coding: utf-8 -*-
+
couleur = QtGui.QColorDialog.getColor()
from __future__ import unicode_literals
+
if couleur.isValid():
+
     red   = int(str(couleur.name()[1:3]),16)   # decode hexadecimal to int()
# Exemples de recherche et de decodage d'informations sur un objet
+
     green = int(str(couleur.name()[3:5]),16)   # decode hexadecimal to int()
# Chaque section peut etre copiee directement dans la console Python ou dans une macro ou utilisez la macro tel quel
+
     blue  = int(str(couleur.name()[5:7]),16)    # decode hexadecimal to int()
# Certaines commandes se repetent seul l'approche est differente
 
# L'affichage se fait dans la Vue rapport : Menu Affichage > Vues > Vue rapport
 
#
 
# Examples of research and decoding information on an object
 
# Each section can be copied directly into the Python console, or in a macro or uses this macro
 
# Certain commands as repeat alone approach is different
 
# Displayed on Report view : Menu View > Views > report view
 
#
 
# rev:30/08/2014:29/09/2014:17/09/2015
 
 
from FreeCAD import Base
 
import DraftVecUtils, Draft, Part
 
 
mydoc = FreeCAD.activeDocument().Name                                    # Name of active Document
 
App.Console.PrintMessage("Active docu    : "+(mydoc)+"\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
object_Label = sel[0].Label                                              # Label of the object (modifiable)
 
App.Console.PrintMessage("object_Label  : "+(object_Label)+"\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
App.Console.PrintMessage("sel            : "+str(sel[0])+"\n\n")          # sel[0] first object selected
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
object_Name  = sel[0].Name                                                # Name of the object (not modifiable)
 
App.Console.PrintMessage("object_Name    : "+str(object_Name)+"\n\n")
 
##################################################################################
 
 
try:
 
     SubElement = FreeCADGui.Selection.getSelectionEx()                    # sub element name with getSelectionEx()
 
    element_ = SubElement[0].SubElementNames[0]                          # name of 1 element selected
 
    App.Console.PrintMessage("elementSelec   : "+str(element_)+"\n\n")           
 
except:
 
    App.Console.PrintMessage("Oups"+"\n\n")           
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
App.Console.PrintMessage("sel            : "+str(sel[0])+"\n\n")          # sel[0] first object selected
 
##################################################################################
 
 
SubElement = FreeCADGui.Selection.getSelectionEx()                        # sub element name with getSelectionEx()
 
App.Console.PrintMessage("SubElement    : "+str(SubElement[0])+"\n\n")  # name of sub element
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
i = 0
 
for j in enumerate(sel[0].Shape.Edges):                                  # list all Edges
 
    i += 1
 
    App.Console.PrintMessage("Edges n : "+str(i)+"\n")
 
    a = sel[0].Shape.Edges[j[0]].Vertexes[0]
 
    App.Console.PrintMessage("X1            : "+str(a.Point.x)+"\n")     # coordinate XYZ first point
 
    App.Console.PrintMessage("Y1            : "+str(a.Point.y)+"\n")
 
     App.Console.PrintMessage("Z1            : "+str(a.Point.z)+"\n")
 
    try:
 
        a = sel[0].Shape.Edges[j[0]].Vertexes[1]
 
        App.Console.PrintMessage("X2            : "+str(a.Point.x)+"\n") # coordinate XYZ second point
 
        App.Console.PrintMessage("Y2            : "+str(a.Point.y)+"\n")
 
        App.Console.PrintMessage("Z2            : "+str(a.Point.z)+"\n")
 
    except:
 
        App.Console.PrintMessage("Oups"+"\n")   
 
App.Console.PrintMessage("\n")   
 
##################################################################################
 
 
try:
 
    SubElement = FreeCADGui.Selection.getSelectionEx()                                        # sub element name with getSelectionEx()
 
    subElementName = Gui.Selection.getSelectionEx()[0].SubElementNames[0]                    # sub element name with getSelectionEx()
 
    App.Console.PrintMessage("subElementName : "+str(subElementName)+"\n")
 
   
 
    subObjectLength = Gui.Selection.getSelectionEx()[0].SubObjects[0].Length                  # sub element Length
 
    App.Console.PrintMessage("subObjectLength: "+str(subObjectLength)+"\n\n")
 
   
 
    subObjectX1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.x        # sub element coordinate X1
 
    App.Console.PrintMessage("subObject_X1  : "+str(subObjectX1)+"\n")
 
    subObjectY1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.y        # sub element coordinate Y1
 
    App.Console.PrintMessage("subObject_Y1  : "+str(subObjectY1)+"\n")
 
     subObjectZ1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.z        # sub element coordinate Z1
 
    App.Console.PrintMessage("subObject_Z1  : "+str(subObjectZ1)+"\n\n")
 
   
 
    subObjectX2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.x        # sub element coordinate X2
 
    App.Console.PrintMessage("subObject_X2  : "+str(subObjectX2)+"\n")
 
    subObjectY2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.y        # sub element coordinate Y2
 
    App.Console.PrintMessage("subObject_Y2  : "+str(subObjectY2)+"\n")
 
    subObjectZ2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.z        # sub element coordinate Z2
 
    App.Console.PrintMessage("subObject_Z2  : "+str(subObjectZ2)+"\n\n")
 
   
 
    subObjectBoundBox = Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox              # sub element BoundBox coordinates
 
    App.Console.PrintMessage("subObjectBBox  : "+str(subObjectBoundBox)+"\n")
 
   
 
    subObjectBoundBoxCenter = Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox.Center # sub element BoundBoxCenter
 
    App.Console.PrintMessage("subObjectBBoxCe: "+str(subObjectBoundBoxCenter)+"\n")
 
   
 
    surfaceFace = Gui.Selection.getSelectionEx()[0].SubObjects[0].Area                        # Area of the face selected
 
    App.Console.PrintMessage("surfaceFace   : "+str(surfaceFace)+"\n\n")
 
except:
 
    App.Console.PrintMessage("Oups"+"\n\n")           
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
surface = sel[0].Shape.Area                                              # Area object complete
 
App.Console.PrintMessage("surfaceObjet  : "+str(surface)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
CenterOfMass = sel[0].Shape.CenterOfMass                                  # Center of Mass of the object
 
App.Console.PrintMessage("CenterOfMass  : "+str(CenterOfMass)+"\n")
 
App.Console.PrintMessage("CenterOfMassX  : "+str(CenterOfMass[0])+"\n")  # coordinates [0]=X [1]=Y [2]=Z
 
App.Console.PrintMessage("CenterOfMassY  : "+str(CenterOfMass[1])+"\n")
 
App.Console.PrintMessage("CenterOfMassZ  : "+str(CenterOfMass[2])+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
for j in enumerate(sel[0].Shape.Faces):                                  # List alles faces of the object
 
    App.Console.PrintMessage("Face          : "+str("Face%d" % (j[0]+1))+"\n")
 
App.Console.PrintMessage("\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
volume_ = sel[0].Shape.Volume                                            # Volume of the object
 
App.Console.PrintMessage("volume_        : "+str(volume_)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
boundBox_= sel[0].Shape.BoundBox                                          # BoundBox of the object
 
App.Console.PrintMessage("boundBox_      : "+str(boundBox_)+"\n")
 
 
boundBoxLX  = boundBox_.XLength                                          # Length x boundBox rectangle
 
boundBoxLY  = boundBox_.YLength                                          # Length y boundBox rectangle
 
boundBoxLZ  = boundBox_.ZLength                                          # Length z boundBox rectangle
 
boundBoxDiag= boundBox_.DiagonalLength                                    # Diagonal Length boundBox rectangle
 
  
App.Console.PrintMessage("boundBoxLX     : "+str(boundBoxLX)+"\n")
+
     print couleur                              #
App.Console.PrintMessage("boundBoxLY     : "+str(boundBoxLY)+"\n")
+
     print "hexadecimal ",couleur.name()        # color format hexadecimal mode 16
App.Console.PrintMessage("boundBoxLZ    : "+str(boundBoxLZ)+"\n")
+
    print "Red   color ",red                    # color format decimal
App.Console.PrintMessage("boundBoxDiag  : "+str(boundBoxDiag)+"\n\n")
+
    print "Green color ",green                  # color format decimal
##################################################################################
+
    print "Blue color ",blue                  # color format decimal
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
pl = sel[0].Shape.Placement                                              # Placement Vector XYZ and Yaw-Pitch-Roll
 
App.Console.PrintMessage("Placement      : "+str(pl)+"\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
pl = sel[0].Shape.Placement.Base                                          # Placement Vector XYZ
 
App.Console.PrintMessage("PlacementBase  : "+str(pl)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
Yaw = sel[0].Shape.Placement.Rotation.toEuler()[0]                        # decode angle Euler Yaw
 
App.Console.PrintMessage("Yaw            : "+str(Yaw)+"\n")
 
Pitch = sel[0].Shape.Placement.Rotation.toEuler()[1]                      # decode angle Euler Pitch
 
App.Console.PrintMessage("Pitch          : "+str(Pitch)+"\n")
 
Roll = sel[0].Shape.Placement.Rotation.toEuler()[2]                      # decode angle Euler Yaw
 
App.Console.PrintMessage("Roll          : "+str(Roll)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
oripl_X = sel[0].Placement.Base[0]                                        # decode Placement X
 
oripl_Y = sel[0].Placement.Base[1]                                        # decode Placement Y
 
oripl_Z = sel[0].Placement.Base[2]                                        # decode Placement Z
 
 
App.Console.PrintMessage("oripl_X        : "+str(oripl_X)+"\n")
 
App.Console.PrintMessage("oripl_Y        : "+str(oripl_Y)+"\n")
 
App.Console.PrintMessage("oripl_Z        : "+str(oripl_Z)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
rotation = sel[0].Placement.Rotation                                      # decode Placement Rotation
 
App.Console.PrintMessage("rotation              : "+str(rotation)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
pl = sel[0].Shape.Placement.Rotation                                      # decode Placement Rotation other method
 
App.Console.PrintMessage("Placement Rot         : "+str(pl)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
pl = sel[0].Shape.Placement.Rotation.Angle                                # decode Placement Rotation Angle
 
App.Console.PrintMessage("Placement Rot Angle   : "+str(pl)+"\n\n")
 
##################################################################################
 
 
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 
Rot_0 = sel[0].Placement.Rotation.Q[0]                                    # decode Placement Rotation 0
 
App.Console.PrintMessage("Rot_0        : "+str(Rot_0)+ " rad , "+str(180 * Rot_0 / 3.1416)+" deg "+"\n")
 
 
Rot_1 = sel[0].Placement.Rotation.Q[1]                                    # decode Placement Rotation 1
 
App.Console.PrintMessage("Rot_1        : "+str(Rot_1)+ " rad ,  "+str(180 * Rot_1 / 3.1416)+" deg "+"\n")
 
   
 
Rot_2 = sel[0].Placement.Rotation.Q[2]                                    # decode Placement Rotation 2
 
App.Console.PrintMessage("Rot_2        : "+str(Rot_2)+ " rad , "+str(180 * Rot_2 / 3.1416)+" deg "+"\n")
 
 
Rot_3 = sel[0].Placement.Rotation.Q[3]                                    # decode Placement Rotation 3
 
App.Console.PrintMessage("Rot_3        : "+str(Rot_3)+"\n\n")
 
##################################################################################
 
  
 
}}
 
}}
 
<translate>
 
<translate>
===Manual search of an element with label=== <!--T:52-->
+
 
 +
==Some useful commands== <!--T:39-->
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# Extract the coordinate X,Y,Z and Angle giving the label
+
# Here the code to display the icon on the '''pushButton''',  
App.Console.PrintMessage("Base.x      : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.x)+"\n")
+
# change the name to another button, ('''radioButton, checkBox''') as well as the path to the icon,
App.Console.PrintMessage("Base.y      : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.y)+"\n")
 
App.Console.PrintMessage("Base.z      : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.z)+"\n")
 
App.Console.PrintMessage("Base.Angle  : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Rotation.Angle)+"\n\n")
 
##################################################################################
 
  
}}
+
      # Displays an icon on the button PushButton
<translate>
+
      # self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # he name of the icon
 +
      self.image_01 = path+"icone01.png" # the name of the icon
 +
      icon01 = QtGui.QIcon()
 +
      icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 +
      self.pushButton.setIcon(icon01)
 +
      self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
  
<!--T:40-->
 
'''PS:''' Usually the angles are given in Radian to convert :
 
  
<!--T:41-->
+
# path = FreeCAD.ConfigGet("UserAppData") # gives the user path
#angle in Degrees to Radians :
+
  path = FreeCAD.ConfigGet("AppHomePath") # gives the installation path of FreeCAD
#*Angle in radian = '''pi * (angle in degree) / 180'''
 
#*Angle in radian = math.radians(angle in degree)
 
#angle in Radians to Degrees :
 
#*Angle in degree = '''180 * (angle in radian) / pi'''
 
#*Angle in degree = math.degrees(angle in radian)
 
  
===Cartesian coordinates === <!--T:42-->
+
# This command reverses the horizontal button, right to left
 +
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the horizontal button
  
<!--T:43-->
+
# Displays an info button
This code displays the Cartesian coordinates of the selected item.
+
self.pushButton.setToolTip(_translate("MainWindow", "Quitter la fonction", None)) # Displays an info button
  
<!--T:44-->
+
# This function gives a color button
Change the value of "numberOfPoints" if you want a different number of points (precision)
+
self.pushButton.setStyleSheet("background-color: red") # This function gives a color button
</translate>
 
{{Code|code=
 
numberOfPoints = 100                                                        # Decomposition number (or precision you can change)
 
selectedEdge = FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy() # select one element
 
points  = selectedEdge.discretize(numberOfPoints)                            # discretize the element
 
i=0
 
for p in points:                                                            # list and display the coordinates
 
    i+=1
 
    print i, " X", p.x, " Y", p.y, " Z", p.z
 
}}
 
<translate>
 
<!--T:45-->
 
Other method display on "Int" and "Float"
 
</translate>
 
{{Code|code=
 
import Part
 
from FreeCAD import Base
 
  
c=Part.makeCylinder(2,10)        # create the circle
+
# This function gives a color to the text of the button
Part.show(c)                     # display the shape
+
self.pushButton.setStyleSheet("color : #ff0000") # This function gives a color to the text of the button
  
# slice accepts two arguments:
+
# combinaison des deux, bouton et texte
#+ the normal of the cross section plane
+
self.pushButton.setStyleSheet("color : #ff0000; background-color : #0000ff;" ) #  combination of the two, button, and text
#+ the distance from the origin to the cross section plane. Here you have to find a value so that the plane intersects your object
 
s=c.slice(Base.Vector(0,1,0),0)  #
 
  
# here the result is a single wire
+
# replace the icon in the main window
# depending on the source object this can be several wires
+
MainWindow.setWindowIcon(QtGui.QIcon('C:\Program Files\FreeCAD0.13\View-C3P.png'))
s=s[0]
 
  
# if you only need the vertexes of the shape you can use
+
# connects a lineEdit on execute
v=[]
+
self.lineEdit.returnPressed.connect(self.execute) # connects a lineEdit on "def execute" after validation on enter
for i in s.Vertexes:
+
# self.lineEdit.textChanged.connect(self.execute) # connects a lineEdit on "def execute" with each keystroke on the keyboard
    v.append(i.Point)
 
  
# but you can also sub-sample the section to have a certain number of points (int) ...
+
# display text in a lineEdit
p1=s.discretize(20)
+
self.lineEdit.setText(str(val_X)) # Displays the value in the lineEdit (convert to string)
ii=0
 
for i in p1:
 
    ii+=1
 
    print i                                              # Vector()
 
    print ii, ": X:", i.x, " Y:", i.y, " Z:", i.z        # Vector decode
 
Draft.makeWire(p1,closed=False,face=False,support=None) # to see the difference accuracy (20)
 
  
## uncomment to use
+
# extract the string contained in a lineEdit
#import Draft
+
val_X = self.lineEdit.text() # extract the (string) string contained in lineEdit
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True) # first transform the DWire in Wire        "downgrade"
+
val_X = float(val_X0)       # converted the string to an floating
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True) # second split the Wire in single objects  "downgrade"
+
val_X = int(val_X0)         # convert the string to an integer
#
 
##Draft.upgrade(FreeCADGui.Selection.getSelection(),delete=True) # to attach lines contiguous SELECTED use "upgrade"
 
  
 +
# This code allows you to change the font and its attributes
 +
      font = QtGui.QFont()
 +
      font.setFamily("Times New Roman")
 +
      font.setPointSize(10)
 +
      font.setWeight(10)
 +
      font.setBold(True) # same result with tags "<b>your text</b>" (in quotes)
 +
      self.label_6.setFont(font)
 +
      self.label_6.setObjectName("label_6")
 +
      self.label_6.setStyleSheet("color : #ff0000") # This function gives a color to the text
 +
      self.label_6.setText(_translate("MainWindow", "Select a view", None))
 +
}}
 +
<translate>
  
# ... or define a sampling distance (float)
+
<!--T:40-->
p2=s.discretize(0.5)
+
By using the characters with accents, where you get the error :
ii=0
 
for i in p2:
 
    ii+=1
 
    print i                                              # Vector()
 
    print ii, ": X:", i.x, " Y:", i.y, " Z:", i.z        # Vector decode
 
Draft.makeWire(p2,closed=False,face=False,support=None)  # to see the difference accuracy (0.5)
 
  
## uncomment to use
+
<!--T:42-->
#import Draft
+
<FONT COLOR="#FF0000">'''UnicodeDecodeError: 'utf8' codec can't decode bytes in position 0-2: invalid data'''</FONT>
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # first transform the DWire in Wire        "downgrade"
 
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # second split the Wire in single objects  "downgrade"
 
#
 
##Draft.upgrade(FreeCADGui.Selection.getSelection(),delete=True) # to attach lines contiguous SELECTED use "upgrade"
 
  
}}
+
<!--T:41-->
<translate>
+
Several solutions are possible.
===Select all objects in the document=== <!--T:46-->
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import FreeCAD
+
# conversion from a lineEdit
for obj in FreeCAD.ActiveDocument.Objects:
+
App.activeDocument().CopyRight.Text = str(unicode(self.lineEdit_20.text() , 'ISO-8859-1').encode('UTF-8'))
    print obj.Name                                # display the object Name
+
DESIGNED_BY = unicode(self.lineEdit_01.text(), 'ISO-8859-1').encode('UTF-8')
    objName = obj.Name
 
    obj = App.ActiveDocument.getObject(objName)
 
    Gui.Selection.addSelection(obj)               # select the object
 
 
}}
 
}}
 
<translate>
 
<translate>
===Selecting a face of an object=== <!--T:49-->
+
<!--T:43-->
 +
or with the procedure
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# select one face of the object
+
def utf8(unio):
import FreeCAD, Draft
+
    return unicode(unio).encode('UTF8')
App=FreeCAD
 
nameObject = "Box"                            # objet
 
faceSelect = "Face3"                          # face to selection
 
loch=App.ActiveDocument.getObject(nameObject)  # objet
 
Gui.Selection.clearSelection()                # clear all selection
 
Gui.Selection.addSelection(loch,faceSelect)   # select the face specified
 
s = Gui.Selection.getSelectionEx()
 
#Draft.makeFacebinder(s)                       #
 
 
}}
 
}}
<translate>
 
===Create one object to the position of the Camera=== <!--T:48-->
 
</translate>
 
{{Code|code=
 
# create one object of the position to camera with "getCameraOrientation()"
 
# the object is still facing the screen
 
import Draft
 
  
plan = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
+
<FONT COLOR="#FF0000">'''UnicodeEncodeError: 'ascii' codec can't encode character u'\xe9' in position 9: ordinal not in range(128)'''</FONT>
plan = str(plan)
 
###### extract data
 
a    = ""
 
for i in plan:
 
    if i in ("0123456789e.- "):
 
        a+=i
 
a = a.strip(" ")
 
a = a.split(" ")
 
####### extract data
 
  
#print a
+
{{Code|code=
#print a[0]
+
# conversion
#print a[1]
+
a = u"Nom de l'élément : "
#print a[2]
+
f.write('''a.encode('iso-8859-1')'''+str(element_)+"\n")
#print a[3]
 
 
 
xP = float(a[0])
 
yP = float(a[1])
 
zP = float(a[2])
 
qP = float(a[3])
 
 
 
pl = FreeCAD.Placement()
 
pl.Rotation.Q = (xP,yP,zP,qP)         # rotation of object
 
pl.Base = FreeCAD.Vector(0.0,0.0,0.0) # here coordinates XYZ of Object
 
rec = Draft.makeRectangle(length=10.0,height=10.0,placement=pl,face=False,support=None) # create rectangle
 
#rec = Draft.makeCircle(radius=5,placement=pl,face=False,support=None)                  # create circle
 
print rec.Name
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:53-->
+
<!--T:44-->
here same code simplified
+
or with the procedure
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import Draft
+
def iso8859(encoder):
pl = FreeCAD.Placement()
+
    return unicode(encoder).encode('iso-8859-1')
pl.Rotation = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
 
pl.Base = FreeCAD.Vector(0.0,0.0,0.0)
 
rec = Draft.makeRectangle(length=10.0,height=10.0,placement=pl,face=False,support=None)
 
 
}}
 
}}
 
 
<translate>
 
<translate>
=== Find normal vector on the surface === <!--T:56-->
+
<!--T:45-->
 +
or
 
</translate>
 
</translate>
 
+
{{Code|code=
 +
iso8859(unichr(176))
 +
}}
 
<translate>
 
<translate>
<!--T:57-->
+
<!--T:46-->
This example show how to find normal vector on the surface by find the u,v parameters of one point on the surface and use u,v parameters to find normal vector
+
or
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
def normal(self):
+
unichr(ord(176))
  ss=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy()#SubObjects[0] is the edge list
 
  points  = ss.discretize(3.0)#points on the surface edge,
 
            #this example just use points on the edge for example.
 
            #However point is not necessary on the edge, it can be anywhere on the surface.
 
  face=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[1]
 
  for pp in points:
 
      pt=FreeCAD.Base.Vector(pp.x,pp.y,pp.z)#a point on the surface edge
 
      uv=face.Surface.parameter(pt)# find the surface u,v parameter of a point on the surface edge
 
      u=uv[0]
 
      v=uv[1]
 
      normal=face.normalAt(u,v)#use u,v to find normal vector
 
      print normal
 
      line=Part.makeLine((pp.x,pp.y,pp.z), (normal.x,normal.y,normal.z))
 
      Part.show(line)
 
 
}}
 
}}
 
<translate>
 
<translate>
===Read And write one Expression=== <!--T:59-->
+
<!--T:47-->
 +
or
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import Draft
+
uniteSs = "mm"+iso8859(unichr(178))
doc = FreeCAD.ActiveDocument
+
print unicode(uniteSs, 'iso8859')
 
 
pl=FreeCAD.Placement()
 
pl.Rotation.Q=(0.0,-0.0,-0.0,1.0)
 
pl.Base=FreeCAD.Vector(0.0,0.0,0.0)
 
obj = Draft.makeCircle(radius=1.0,placement=pl,face=False,support=None)    # create circle
 
 
 
print obj.PropertiesList                                                  # properties disponible in the obj
 
 
 
doc.getObject(obj.Name).setExpression('Radius', u'2mm')                   # modify the radius
 
doc.getObject(obj.Name).setExpression('Placement.Base.x', u'10mm')        # modify the placement
 
doc.getObject(obj.Name).setExpression('FirstAngle', u'90')                # modify the first angle
 
doc.recompute()
 
 
 
expressions = obj.ExpressionEngine                                        # read the expression list
 
print expressions
 
 
 
for i in expressions:                                                      # list and separate the data expression
 
    print i[0]," = ",i[1]
 
 
 
 
}}
 
}}
 +
<translate>
  
<translate>
 
  
<!--T:34-->
+
<!--T:48-->
{{docnav|Embedding FreeCAD|Line drawing function}}
+
{{docnav|Line drawing function|Licence}}
  
<!--T:35-->
+
<!--T:49-->
 
[[Category:Poweruser Documentation]]
 
[[Category:Poweruser Documentation]]
 
[[Category:Python Code]]
 
[[Category:Python Code]]
[[Category:Tutorials]]
 
  
 
</translate>
 
</translate>
 
{{clear}}
 
{{clear}}

Revision as of 16:08, 27 January 2019

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎polski • ‎română • ‎русский • ‎svenska • ‎Türkçe

In this page we will show how to build a simple Qt Dialog with Qt Designer, Qt's official tool for designing interfaces, then convert it to python code, then use it inside FreeCAD. I'll assume in the example that you know how to edit and run python scripts already, and that you can do simple things in a terminal window such as navigate, etc. You must also have, of course, pyqt installed.

Designing the dialog

In CAD applications, designing a good UI (User Interface) is very important. About everything the user will do will be through some piece of interface: reading dialog boxes, pressing buttons, choosing between icons, etc. So it is very important to think carefully to what you want to do, how you want the user to behave, and how will be the workflow of your action.

There are a couple of concepts to know when designing interface:

  • Modal/non-modal dialogs: A modal dialog appears in front of your screen, stopping the action of the main window, forcing the user to respond to the dialog, while a non-modal dialog doesn't stop you from working on the main window. In some case the first is better, in other cases not.
  • Identifying what is required and what is optional: Make sure the user knows what he must do. Label everything with proper description, use tooltips, etc.
  • Separating commands from parameters: This is usually done with buttons and text input fields. The user knows that clicking a button will produce an action while changing a value inside a text field will change a parameter somewhere. Nowadays, though, users usually know well what is a button, what is an input field, etc. The interface toolkit we are using, Qt, is a state-of-the-art toolkit, and we won't have to worry much about making things clear, since they will already be very clear by themselves.

So, now that we have well defined what we will do, it's time to open the qt designer. Let's design a very simple dialog, like this:

Qttestdialog.jpg

We will then use this dialog in FreeCAD to produce a nice rectangular plane. You might find it not very useful to produce nice rectangular planes, but it will be easy to change it later to do more complex things. When you open it, Qt Designer looks like this:

Qtdesigner-screenshot.jpg

It is very simple to use. On the left bar you have elements that can be dragged on your widget. On the right side you have properties panels displaying all kinds of editable properties of selected elements. So, begin with creating a new widget. Select "Dialog without buttons", since we don't want the default Ok/Cancel buttons. Then, drag on your widget 3 labels, one for the title, one for writing "Height" and one for writing "Width". Labels are simple texts that appear on your widget, just to inform the user. If you select a label, on the right side will appear several properties that you can change if you want, such as font style, height, etc.

Then, add 2 LineEdits, which are text fields that the user can fill in, one for the height and one for the width. Here too, we can edit properties. For example, why not set a default value? For example 1.00 for each. This way, when the user will see the dialog, both values will be filled already and if he is satisfied he can directly press the button, saving precious time. Then, add a PushButton, which is the button the user will need to press after he filled the 2 fields.

Note that I chose very simple controls here, but Qt has many more options, for example you could use Spinboxes instead of LineEdits, etc... Have a look at what is available, you will surely have other ideas.

That's about all we need to do in Qt Designer. One last thing, though, let's rename all our elements with easier names, so it will be easier to identify them in our scripts:

Qtpropeditor.jpg

Converting our dialog to python

Now, let's save our widget somewhere. It will be saved as an .ui file, that we will easily convert to python script with pyuic. On windows, the pyuic program is bundled with pyqt (to be verified), on linux you probably will need to install it separately from your package manager (on debian-based systems, it is part of the pyqt4-dev-tools package). To do the conversion, you'll need to open a terminal window (or a command prompt window on windows), navigate to where you saved your .ui file, and issue:

pyuic mywidget.ui > mywidget.py

In Windows pyuic.py is located in "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py" For conversion create a batch file called "compQt4.bat:

@"C:\Python27\python" "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py" -x %1.ui > %1.py

In the DOS console type without extension

compQt4 myUiFile

Into Linux : to do

Since FreeCAD progressively moved away from PyQt after version 0.13, in favour of PySide (Choose your PySide install building PySide), to make the file based on PySide now you have to use:

pyside-uic mywidget.ui -o mywidget.py

In Windows uic.py are located in "C:\Python27\Lib\site-packages\PySide\scripts\uic.py" For create batch file "compSide.bat":

@"C:\Python27\python" "C:\Python27\Lib\site-packages\PySide\scripts\uic.py" %1.ui > %1.py

In the DOS console type without extension

compSide myUiFile

Into Linux : to do


On some systems the program is called pyuic4 instead of pyuic. This will simply convert the .ui file into a python script. If we open the mywidget.py file, its contents is very easy to understand:

from PySide import QtCore, QtGui

class Ui_Dialog(object):
    def setupUi(self, Dialog):
        Dialog.setObjectName("Dialog")
        Dialog.resize(187, 178)
        self.title = QtGui.QLabel(Dialog)
        self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
        self.title.setObjectName("title")
        self.label_width = QtGui.QLabel(Dialog)
        ...

        self.retranslateUi(Dialog)
        QtCore.QMetaObject.connectSlotsByName(Dialog)

   def retranslateUi(self, Dialog):
        Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
        self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
        ...

As you see it has a very simple structure: a class named Ui_Dialog is created, that stores the interface elements of our widget. That class has two methods, one for setting up the widget, and one for translating its contents, which is part of the general Qt mechanism for translating interface elements. The setup method simply creates, one by one, the widgets as we defined them in Qt Designer, and sets their options as we decided earlier. Then, the whole interface gets translated, and finally, the slots get connected (we'll talk about that later).

We can now create a new widget and use this class to create its interface. We can already see our widget in action, by putting our mywidget.py file in a place where FreeCAD will find it (in the FreeCAD bin directory, or in any of the Mod subdirectories), and, in the FreeCAD python interpreter, issue:

from PySide import QtGui
import mywidget
d = QtGui.QWidget()
d.ui = mywidget.Ui_Dialog()
d.ui.setupUi(d)
d.show()

And our dialog will appear! Note that our Python interpreter is still working, we have a non-modal dialog. So, to close it, we can (apart from clicking its close icon, of course) issue:

d.hide()

Making our dialog do something

Now that we can show and hide our dialog, we just need to add one last part: To make it do something! If you play a bit with Qt designer, you'll quickly discover a whole section called "signals and slots". Basically, it works like this: elements on your widgets (in Qt terminology, those elements are themselves widgets) can send signals. Those signals differ according to the widget type. For example, a button can send a signal when it is pressed and when it is released. Those signals can be connected to slots, which can be special functionality of other widgets (for example a dialog has a "close" slot to which you can connect the signal from a close button), or can be custom functions. The PyQt Reference Documentation lists all the qt widgets, what they can do, what signals they can send, etc...

What we will do here, is to create a new function that will create a plane based on height and width, and to connect that function to the pressed signal emitted by our "Create!" button. So, let's begin with importing our FreeCAD modules, by putting the following line at the top of the script, where we already import QtCore and QtGui:

import FreeCAD, Part

Then, let's add a new function to our Ui_Dialog class:

def createPlane(self):
    try:
        # first we check if valid numbers have been entered
        w = float(self.width.text())
        h = float(self.height.text())
    except ValueError:
        print "Error! Width and Height values must be valid numbers!"
    else:
        # create a face from 4 points
        p1 = FreeCAD.Vector(0,0,0)
        p2 = FreeCAD.Vector(w,0,0)
        p3 = FreeCAD.Vector(w,h,0)
        p4 = FreeCAD.Vector(0,h,0)
        pointslist = [p1,p2,p3,p4,p1]
        mywire = Part.makePolygon(pointslist)
        myface = Part.Face(mywire)
        Part.show(myface)
        self.hide()

Then, we need to inform Qt to connect the button to the function, by placing the following line just before QtCore.QMetaObject.connectSlotsByName(Dialog):

QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)

This, as you see, connects the pressed() signal of our create object (the "Create!" button), to a slot named createPlane, which we just defined. That's it! Now, as a final touch, we can add a little function to create the dialog, it will be easier to call. Outside the Ui_Dialog class, let's add this code:

class plane():
   def __init__(self):
       self.d = QtGui.QWidget()
       self.ui = Ui_Dialog()
       self.ui.setupUi(self.d)
       self.d.show()

(Python reminder: the __init__ method of a class is automatically executed whenever a new object is created!) Then, from FreeCAD, we only need to do:

import mywidget
myDialog = mywidget.plane()

That's all Folks... Now you can try all kinds of things, like for example inserting your widget in the FreeCAD interface (see the Code snippets page), or making much more advanced custom tools, by using other elements on your widget.

The complete script

This is the complete script, for reference:

# -*- coding: utf-8 -*-

# Form implementation generated from reading ui file 'mywidget.ui'
#
# Created: Mon Jun  1 19:09:10 2009
#      by: PyQt4 UI code generator 4.4.4
# Modified for PySide 16:02:2015 
# WARNING! All changes made in this file will be lost!

from PySide import QtCore, QtGui
import FreeCAD, Part 

class Ui_Dialog(object):
   def setupUi(self, Dialog):
       Dialog.setObjectName("Dialog")
       Dialog.resize(187, 178)
       self.title = QtGui.QLabel(Dialog)
       self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
       self.title.setObjectName("title")
       self.label_width = QtGui.QLabel(Dialog)
       self.label_width.setGeometry(QtCore.QRect(10, 50, 57, 16))
       self.label_width.setObjectName("label_width")
       self.label_height = QtGui.QLabel(Dialog)
       self.label_height.setGeometry(QtCore.QRect(10, 90, 57, 16))
       self.label_height.setObjectName("label_height")
       self.width = QtGui.QLineEdit(Dialog)
       self.width.setGeometry(QtCore.QRect(60, 40, 111, 26))
       self.width.setObjectName("width")
       self.height = QtGui.QLineEdit(Dialog)
       self.height.setGeometry(QtCore.QRect(60, 80, 111, 26))
       self.height.setObjectName("height")
       self.create = QtGui.QPushButton(Dialog)
       self.create.setGeometry(QtCore.QRect(50, 140, 83, 26))
       self.create.setObjectName("create")

       self.retranslateUi(Dialog)
       QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
       QtCore.QMetaObject.connectSlotsByName(Dialog)

   def retranslateUi(self, Dialog):
       Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
       self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
       self.label_width.setText(QtGui.QApplication.translate("Dialog", "Width", None, QtGui.QApplication.UnicodeUTF8))
       self.label_height.setText(QtGui.QApplication.translate("Dialog", "Height", None, QtGui.QApplication.UnicodeUTF8))
       self.create.setText(QtGui.QApplication.translate("Dialog", "Create!", None, QtGui.QApplication.UnicodeUTF8))

   def createPlane(self):
       try:
           # first we check if valid numbers have been entered
           w = float(self.width.text())
           h = float(self.height.text())
       except ValueError:
           print "Error! Width and Height values must be valid numbers!"
       else:
           # create a face from 4 points
           p1 = FreeCAD.Vector(0,0,0)
           p2 = FreeCAD.Vector(w,0,0)
           p3 = FreeCAD.Vector(w,h,0)
           p4 = FreeCAD.Vector(0,h,0)
           pointslist = [p1,p2,p3,p4,p1]
           mywire = Part.makePolygon(pointslist)
           myface = Part.Face(mywire)
           Part.show(myface)

class plane():
   def __init__(self):
       self.d = QtGui.QWidget()
       self.ui = Ui_Dialog()
       self.ui.setupUi(self.d)
       self.d.show()

Creation of a dialog with buttons

Method 1

An example of a dialog box complete with its connections.

# -*- coding: utf-8 -*-
# Create by flachyjoe

from PySide import QtCore, QtGui

try:
    _fromUtf8 = QtCore.QString.fromUtf8
except AttributeError:
    def _fromUtf8(s):
        return s

try:
    _encoding = QtGui.QApplication.UnicodeUTF8
    def _translate(context, text, disambig):
        return QtGui.QApplication.translate(context, text, disambig, _encoding)
except AttributeError:
    def _translate(context, text, disambig):
        return QtGui.QApplication.translate(context, text, disambig)


class Ui_MainWindow(object):

     def __init__(self, MainWindow):
        self.window = MainWindow

        MainWindow.setObjectName(_fromUtf8("MainWindow"))
        MainWindow.resize(400, 300)
        self.centralWidget = QtGui.QWidget(MainWindow)
        self.centralWidget.setObjectName(_fromUtf8("centralWidget"))

        self.pushButton = QtGui.QPushButton(self.centralWidget)
        self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
        self.pushButton.setObjectName(_fromUtf8("pushButton"))
        self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton

        self.lineEdit = QtGui.QLineEdit(self.centralWidget)
        self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
        self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
        self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit

        self.checkBox = QtGui.QCheckBox(self.centralWidget)
        self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
        self.checkBox.setChecked(True)
        self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
        self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox

        self.radioButton = QtGui.QRadioButton(self.centralWidget)
        self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
        self.radioButton.setObjectName(_fromUtf8("radioButton"))
        self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton

        MainWindow.setCentralWidget(self.centralWidget)

        self.menuBar = QtGui.QMenuBar(MainWindow)
        self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
        self.menuBar.setObjectName(_fromUtf8("menuBar"))
        MainWindow.setMenuBar(self.menuBar)

        self.mainToolBar = QtGui.QToolBar(MainWindow)
        self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
        MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)

        self.statusBar = QtGui.QStatusBar(MainWindow)
        self.statusBar.setObjectName(_fromUtf8("statusBar"))
        MainWindow.setStatusBar(self.statusBar)

        self.retranslateUi(MainWindow)

     def retranslateUi(self, MainWindow):
        MainWindow.setWindowTitle(_translate("MainWindow", "MainWindow", None))
        self.pushButton.setText(_translate("MainWindow", "OK", None))
        self.lineEdit.setText(_translate("MainWindow", "tyty", None))
        self.checkBox.setText(_translate("MainWindow", "CheckBox", None))
        self.radioButton.setText(_translate("MainWindow", "RadioButton", None))

     def on_checkBox_clicked(self):
        if self.checkBox.checkState()==0:
            App.Console.PrintMessage(str(self.checkBox.checkState())+"  CheckBox KO\r\n")
        else:     
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox OK\r\n")
#        App.Console.PrintMessage(str(self.lineEdit.setText("tititi"))+" LineEdit\r\n") #write text to the lineEdit window !
#        str(self.lineEdit.setText("tititi")) #écrit le texte dans la fenêtre lineEdit
        App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit\r\n")

     def on_radioButton_clicked(self):
        if self.radioButton.isChecked():
             App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio OK\r\n")
        else:
             App.Console.PrintMessage(str(self.radioButton.isChecked())+"  Radio KO\r\n")

     def on_lineEdit_clicked(self):
#        if self.lineEdit.textChanged():
             App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")

     def on_pushButton_clicked(self):
        App.Console.PrintMessage("Terminé\r\n")
        self.window.hide()

MainWindow = QtGui.QMainWindow()
ui = Ui_MainWindow(MainWindow)
MainWindow.show()

Here the same window but with an icon on each button.

Download associated icons (click right "Copy the image below ...)"

Icone01.png Icone02.png Icone03.png

# -*- coding: utf-8 -*-

from PySide import QtCore, QtGui

try:
    _fromUtf8 = QtCore.QString.fromUtf8
except AttributeError:
    def _fromUtf8(s):
        return s

try:
    _encoding = QtGui.QApplication.UnicodeUTF8
    def _translate(context, text, disambig):
        return QtGui.QApplication.translate(context, text, disambig, _encoding)
except AttributeError:
    def _translate(context, text, disambig):
        return QtGui.QApplication.translate(context, text, disambig)


class Ui_MainWindow(object):

     def __init__(self, MainWindow):
        self.window = MainWindow
        path = FreeCAD.ConfigGet("UserAppData")
#        path = FreeCAD.ConfigGet("AppHomePath")

        MainWindow.setObjectName(_fromUtf8("MainWindow"))
        MainWindow.resize(400, 300)
        self.centralWidget = QtGui.QWidget(MainWindow)
        self.centralWidget.setObjectName(_fromUtf8("centralWidget"))

        self.pushButton = QtGui.QPushButton(self.centralWidget)
        self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
        self.pushButton.setObjectName(_fromUtf8("pushButton"))
        self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton

        self.lineEdit = QtGui.QLineEdit(self.centralWidget)
        self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
        self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
        self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit

        self.checkBox = QtGui.QCheckBox(self.centralWidget)
        self.checkBox.setGeometry(QtCore.QRect(30, 90, 100, 20))
        self.checkBox.setChecked(True)
        self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
        self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox

        self.radioButton = QtGui.QRadioButton(self.centralWidget)
        self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
        self.radioButton.setObjectName(_fromUtf8("radioButton"))
        self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton

        MainWindow.setCentralWidget(self.centralWidget)

        self.menuBar = QtGui.QMenuBar(MainWindow)
        self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
        self.menuBar.setObjectName(_fromUtf8("menuBar"))
        MainWindow.setMenuBar(self.menuBar)

        self.mainToolBar = QtGui.QToolBar(MainWindow)
        self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
        MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)

        self.statusBar = QtGui.QStatusBar(MainWindow)
        self.statusBar.setObjectName(_fromUtf8("statusBar"))
        MainWindow.setStatusBar(self.statusBar)

        self.retranslateUi(MainWindow)

        # Affiche un icone sur le bouton PushButton
        # self.image_01 = "C:\Program Files\FreeCAD0.13\Icone01.png" # adapt the icon name
        self.image_01 = path+"Icone01.png" # adapt the name of the icon
        icon01 = QtGui.QIcon() 
        icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
        self.pushButton.setIcon(icon01) 
        self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button

        # Affiche un icone sur le bouton RadioButton 
        # self.image_02 = "C:\Program Files\FreeCAD0.13\Icone02.png" # adapt the name of the icon
        self.image_02 = path+"Icone02.png" # adapter le nom de l'icone
        icon02 = QtGui.QIcon() 
        icon02.addPixmap(QtGui.QPixmap(self.image_02),QtGui.QIcon.Normal, QtGui.QIcon.Off)
        self.radioButton.setIcon(icon02) 
        # self.radioButton.setLayoutDirection(QtCore.Qt.RightToLeft) #  This command reverses the direction of the button

        # Affiche un icone sur le bouton CheckBox 
        # self.image_03 = "C:\Program Files\FreeCAD0.13\Icone03.png" # the name of the icon
        self.image_03 = path+"Icone03.png" # adapter le nom de l'icone
        icon03 = QtGui.QIcon() 
        icon03.addPixmap(QtGui.QPixmap(self.image_03),QtGui.QIcon.Normal, QtGui.QIcon.Off)
        self.checkBox.setIcon(icon03) 
        # self.checkBox.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button


     def retranslateUi(self, MainWindow):
        MainWindow.setWindowTitle(_translate("MainWindow", "FreeCAD", None))
        self.pushButton.setText(_translate("MainWindow", "OK", None))
        self.lineEdit.setText(_translate("MainWindow", "tyty", None))
        self.checkBox.setText(_translate("MainWindow", "CheckBox", None))
        self.radioButton.setText(_translate("MainWindow", "RadioButton", None))

     def on_checkBox_clicked(self):
        if self.checkBox.checkState()==0:
            App.Console.PrintMessage(str(self.checkBox.checkState())+"  CheckBox KO\r\n")
        else:     
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox OK\r\n")
           # App.Console.PrintMessage(str(self.lineEdit.setText("tititi"))+" LineEdit\r\n") # write text to the lineEdit window !
           # str(self.lineEdit.setText("tititi")) #écrit le texte dans la fenêtre lineEdit
        App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit\r\n")

     def on_radioButton_clicked(self):
        if self.radioButton.isChecked():
             App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio OK\r\n")
        else:
             App.Console.PrintMessage(str(self.radioButton.isChecked())+"  Radio KO\r\n")

     def on_lineEdit_clicked(self):
          # if self.lineEdit.textChanged():
          App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")

     def on_pushButton_clicked(self):
        App.Console.PrintMessage("Terminé\r\n")
        self.window.hide()

MainWindow = QtGui.QMainWindow()
ui = Ui_MainWindow(MainWindow)
MainWindow.show()

Here the code to display the icon on the pushButton, change the name for another button, (radioButton, checkBox) and the path to the icon.

# Affiche un icône sur le bouton PushButton
        # self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # the name of the icon
        self.image_01 = path+"icone01.png" # the name of the icon
        icon01 = QtGui.QIcon() 
        icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
        self.pushButton.setIcon(icon01) 
        self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button

The command UserAppData gives the user path AppHomePath gives the installation path of FreeCAD

#        path = FreeCAD.ConfigGet("UserAppData")
        path = FreeCAD.ConfigGet("AppHomePath")

This command reverses the horizontal button, right to left.

self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button

Method 2

Another method to display a window, here by creating a file QtForm.py which contains the header program (module called with import QtForm), and a second module that contains the code window all these accessories, and your code (the calling module).

This method requires two separate files, but allows to shorten your program using the file ' ' QtForm.py ' ' import. Then distribute the two files together, they are inseparable.

The file QtForm.py

# -*- coding: utf-8 -*-
# Create by flachyjoe
from PySide import QtCore, QtGui

try:
    _fromUtf8 = QtCore.QString.fromUtf8
except AttributeError:
   def _fromUtf8(s):
      return s

try:
    _encoding = QtGui.QApplication.UnicodeUTF8
    def _translate(context, text, disambig):
      return QtGui.QApplication.translate(context, text, disambig, _encoding)
except AttributeError:
   def _translate(context, text, disambig):
      return QtGui.QApplication.translate(context, text, disambig)

class Form(object):
   def __init__(self, title, width, height):
      self.window = QtGui.QMainWindow()
      self.title=title
      self.window.setObjectName(_fromUtf8(title))
      self.window.setWindowTitle(_translate(self.title, self.title, None))
      self.window.resize(width, height)

   def show(self):
      self.createUI()
      self.retranslateUI()
      self.window.show()
   
   def setText(self, control, text):
      control.setText(_translate(self.title, text, None))

The calling file that contains the window and your code.

The file my_file.py

The connections are to do, a good exercise.

# -*- coding: utf-8 -*-
# Create by flachyjoe
from PySide import QtCore, QtGui
import QtForm

class myForm(QtForm.Form):
   def createUI(self):
      self.centralWidget = QtGui.QWidget(self.window)
      self.window.setCentralWidget(self.centralWidget)
      
      self.pushButton = QtGui.QPushButton(self.centralWidget)
      self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
      self.pushButton.clicked.connect(self.on_pushButton_clicked)
      
      self.lineEdit = QtGui.QLineEdit(self.centralWidget)
      self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
      
      self.checkBox = QtGui.QCheckBox(self.centralWidget)
      self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
      self.checkBox.setChecked(True)
      
      self.radioButton = QtGui.QRadioButton(self.centralWidget)
      self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
   
   def retranslateUI(self):
      self.setText(self.pushButton, "Fermer")
      self.setText(self.lineEdit, "essai de texte")
      self.setText(self.checkBox, "CheckBox")
      self.setText(self.radioButton, "RadioButton")
   
   def on_pushButton_clicked(self):
      self.window.hide()

myWindow=myForm("Fenetre de test",400,300)
myWindow.show()

Other example


Are treated :

  1. icon for window
  2. horizontalSlider
  3. progressBar horizontal
  4. verticalSlider
  5. progressBar vertical
  6. lineEdit
  7. lineEdit
  8. doubleSpinBox
  9. doubleSpinBox
  10. doubleSpinBox
  11. button
  12. button
  13. radioButton with icons
  14. checkBox with icon checked and unchecked
  15. textEdit
  16. graphicsView with 2 graphes

The code page and the icons Qt_Example

Icon personalised in ComboView

Here an example to create an object with properties and icon personalised in ComboView

Download the example icon to the same directory as the macro icon Example for the macro

Use of an icon for three different use cases: icon_in_file_disk (format .png), icon_XPM_in_macro (format .XPM) and icon_resource_FreeCAD

icon personalised


import PySide
import FreeCAD, FreeCADGui, Part
from pivy import coin
from PySide import QtGui ,QtCore
from PySide.QtGui import *
from PySide.QtCore import *
import Draft

global path
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
path = param.GetString("MacroPath","") + "/"                        # macro path
path = path.replace("\\","/")                                       # convert the "\" to "/"


class IconViewProviderToFile:                                       # Class ViewProvider create Property view of object
    def __init__( self, obj, icon):
        self.icone = icon
        
    def getIcon(self):                                              # GetIcon
        return self.icone
        
    def attach(self, obj):                                          # Property view of object
        self.modes = []
        self.modes.append("Flat Lines")
        self.modes.append("Shaded")
        self.modes.append("Wireframe")
        self.modes.append("Points")
        obj.addDisplayMode( coin.SoGroup(),"Flat Lines" )           # Display Mode
        obj.addDisplayMode( coin.SoGroup(),"Shaded" )
        obj.addDisplayMode( coin.SoGroup(),"Wireframe" )
        obj.addDisplayMode( coin.SoGroup(),"Points" )
        return self.modes

    def getDisplayModes(self,obj):
        return self.modes

#####################################################
########## Example with icon to file # begin ########
#####################################################

object1 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_In_File_Disk")                                     # create your object
object1.addProperty("App::PropertyString","Identity", "ExampleTitle0", "Identity of object").Identity = "FCSpring"        # Identity of object
object1.addProperty("App::PropertyFloat" ,"Pitch",    "ExampleTitle0", "Pitch betwen 2 heads").Pitch  = 2.0               # other Property Data
object1.addProperty("App::PropertyBool"  ,"View",     "ExampleTitle1", "Hello world").View            = True              # ...
object1.addProperty("App::PropertyColor" ,"LineColor","ExampleTitle2", "Color to choice").LineColor   = (0.13,0.15,0.37)  # ...
#...other Property Data
#...other Property Data
#
object1.ViewObject.Proxy = IconViewProviderToFile( object1, path + "FreeCADIco.png")                                      # icon download to file
App.ActiveDocument.recompute()
#
#__Detail__:
# FreeCAD.ActiveDocument.addObject( = create now object personalized
# "App::FeaturePython",             = object as FeaturePython
# "Icon_In_File_Disk")              = internal name of your object
#
#
# "App::PropertyString",    = type of Property , availlable : PropertyString, PropertyFloat, PropertyBool, PropertyColor
# "Identity",               = name of the feature
# "ExampleTitle0",          = title of the "section"
# "Identity of object")     = tooltip displayed on mouse
# .Identity                 = variable (same of name of the feature)
# object1.ViewObject.Proxy  = create the view object and gives the icon
#
########## example with icon to file end



#####################################################
########## Example with icon in macro # begin #######
#####################################################

def setIconInMacro(self):        # def contener the icon in format .xpm
    # File format XPM created by Gimp "https://www.gimp.org/"
    # Choice palette Tango
    # Create your masterwork ...
    # For export the image in XPM format
    #     Menu File > Export as > .xpm
    # (For convert image true color in Tango color palette : 
    #     Menu Image > Mode > Indexed ... > Use custom palette > Tango Icon Theme > Convert)
    return """
            /* XPM */
            static char * XPM[] = {
            "22 24 5 1",
            " 	c None",
            ".	c #CE5C00",
            "+	c #EDD400",
            "@	c #F57900",
            "#	c #8F5902",
            "                      ",
            "                      ",
            "  ....                ",
            "  ..@@@@..            ",
            "  . ...@......        ",
            "  .+++++++++...       ",
            "  .      ....++...    ",
            "  .@..@@@@@@.+++++..  ",
            "  .@@@@@..#  ++++ ..  ",
            "  .       ++++  .@..  ",
            "  .++++++++  .@@@.+.  ",
            " .      ..@@@@@. ++.  ",
            " ..@@@@@@@@@.  +++ .  ",
            " ....@...# +++++ @..  ",
            " .    ++++++++ .@. .  ",
            " .++++++++  .@@@@ .   ",
            " .   #....@@@@. ++.   ",
            " .@@@@@@@@@.. +++ .   ",
            " ........  +++++...   ",
            " ...  ..+++++ ..@..   ",
            "    ......  .@@@ +.   ",
            "          ......++.   ",
            "                ...   ",
            "                      "};
        """

object2 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_XPM_In_Macro")                                    #
object2.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
#...other Property Data
#...other Property Data
#
object2.ViewObject.Proxy = IconViewProviderToFile( object2, setIconInMacro(""))              # icon in macro (.XPM)
App.ActiveDocument.recompute()
########## example with icon in macro end



####################################################################
########## Example with icon to FreeCAD ressource # begin ##########
####################################################################

object3 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_Ressource_FreeCAD")                               #
object3.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
#...other Property Data
#...other Property Data
#
object3.ViewObject.Proxy = IconViewProviderToFile( object3, ":/icons/Draft_Draft.svg")       # icon to FreeCAD ressource
App.ActiveDocument.recompute()
########## example with icon to FreeCAD ressource end

Complete example creating a cube and its icon

#https://forum.freecadweb.org/viewtopic.php?t=10255#p83319
import FreeCAD, Part, math
from FreeCAD import Base
from PySide import QtGui

global path
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
path = param.GetString("MacroPath","") + "/"                        # macro path
path = path.replace("\\","/")                                       # convert the "\" to "/"

def setIconInMacro(self):
    return """
        /* XPM */
        static char * xpm[] = {
        "22 22 12 1",
        " 	c None",
        ".	c #A40000",
        "+	c #2E3436",
        "@	c #CE5C00",
        "#	c #F57900",
        "$	c #FCAF3E",
        "%	c #5C3566",
        "&	c #204A87",
        "*	c #555753",
        "=	c #3465A4",
        "-	c #4E9A06",
        ";	c #729FCF",
        "                      ",
        "                      ",
        "                      ",
        "        ..   ..       ",
        "       +@#+++.$$      ",
        "       +.#+%..$$      ",
        "       &*$  &*#*      ",
        "      &   =&=  =      ",
        "   ++&  +.==   %=     ",
        "  ++$@ ..$ %=   &     ",
        "  ..-&%.#$$ &## +=$   ",
        "   .#  ..$ ..#%%.#$$  ",
        "     ;    =+=## %-$#  ",
        "     &=   ;&   %=     ",
        "      ;+ &=;  %=      ",
        "      ++$- +*$-       ",
        "      .#&&+.@$$       ",
        "      ..$# ..$#       ",
        "       ..   ..        ",
        "                      ",
        "                      ",
        "                      "};
        """

class PartFeature:
    def __init__(self, obj):
        obj.Proxy = self

class Box(PartFeature):
    def __init__(self, obj):
        PartFeature.__init__(self, obj)
        obj.addProperty("App::PropertyLength", "Length", "Box", "Length of the box").Length = 1.0
        obj.addProperty("App::PropertyLength", "Width",  "Box", "Width of the box" ).Width  = 1.0
        obj.addProperty("App::PropertyLength", "Height", "Box", "Height of the box").Height = 1.0

    def onChanged(self, fp, prop):
        try:
            if prop == "Length" or prop == "Width" or prop == "Height":
                fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
        except:
            pass

    def execute(self, fp):
        fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)

class ViewProviderBox:
    def __init__(self, obj, icon):
        obj.Proxy  = self
        self.icone = icon
        
    def getIcon(self):
        return self.icone

    def attach(self, obj):
        return

    def setupContextMenu(self, obj, menu):
        action = menu.addAction("Set default height")
        action.triggered.connect(lambda f=self.setDefaultHeight, arg=obj:f(arg))

        action = menu.addAction("Hello World")
        action.triggered.connect(self.showHelloWorld)

    def setDefaultHeight(self, view):
        view.Object.Height = 15.0

    def showHelloWorld(self):
        QtGui.QMessageBox.information(None, "Hi there", "Hello World")

def makeBox():
    FreeCAD.newDocument()
    a=FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Box")
    Box(a)
#    ViewProviderBox(a.ViewObject, path + "FreeCADIco.png")    # icon download to file
#    ViewProviderBox(a.ViewObject,  ":/icons/Draft_Draft.svg") # icon to FreeCAD ressource
    ViewProviderBox(a.ViewObject,  setIconInMacro(""))        # icon in macro (.XPM)
    App.ActiveDocument.recompute()

makeBox()

Use QFileDialog for writing to a file

Complete code:

# -*- coding: utf-8 -*-
import PySide
from PySide import QtGui ,QtCore
from PySide.QtGui import *
from PySide.QtCore import *
path = FreeCAD.ConfigGet("UserAppData")

try:
    SaveName = QFileDialog.getSaveFileName(None,QString.fromLocal8Bit("Save a file txt"),path,             "*.txt") # PyQt4
#                                                                     "here the text displayed on windows" "here the filter (extension)"   
except Exception:
    SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Save a file txt", path,             "*.txt") # PySide
#                                                                     "here the text displayed on windows" "here the filter (extension)"   
if SaveName == "":                                                            # if the name file are not selected then Abord process
    App.Console.PrintMessage("Process aborted"+"\n")
else:                                                                         # if the name file are selected or created then 
    App.Console.PrintMessage("Registration of "+SaveName+"\n")                # text displayed to Report view (Menu > View > Report view checked)
    try:                                                                      # detect error ...
        file = open(SaveName, 'w')                                            # open the file selected to write (w)
        try:                                                                  # if error detected to write ...
            # here your code
            print "here your code"
            file.write(str(1)+"\n")                                           # write the number convert in text with (str())
            file.write("FreeCAD the best")                                    # write the the text with ("  ")
        except Exception:                                                     # if error detected to write
            App.Console.PrintError("Error write file "+"\n")                  # detect error ... display the text in red (PrintError)
        finally:                                                              # if error detected to write ... or not the file is closed
            file.close()                                                      # if error detected to write ... or not the file is closed
    except Exception:
        App.Console.PrintError("Error Open file "+SaveName+"\n")      # detect error ... display the text in red (PrintError)

Use QFileDialog to read a file

Complete code:

# -*- coding: utf-8 -*-
import PySide
from PySide import QtGui ,QtCore
from PySide.QtGui import *
from PySide.QtCore import *
path = FreeCAD.ConfigGet("UserAppData")

OpenName = ""
try:
    OpenName = QFileDialog.getOpenFileName(None,QString.fromLocal8Bit("Read a file txt"),path,             "*.txt") # PyQt4
#                                                                     "here the text displayed on windows" "here the filter (extension)"   
except Exception:
    OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Read a file txt", path,             "*.txt") #PySide
#                                                                     "here the text displayed on windows" "here the filter (extension)"   
if OpenName == "":                                                            # if the name file are not selected then Abord process
    App.Console.PrintMessage("Process aborted"+"\n")
else:
    App.Console.PrintMessage("Read "+OpenName+"\n")                           # text displayed to Report view (Menu > View > Report view checked)
    try:                                                                      # detect error to read file
        file = open(OpenName, "r")                                            # open the file selected to read (r)  # (rb is binary)
        try:                                                                  # detect error ...
            # here your code
            print "here your code"
            op = OpenName.split("/")                                          # decode the path
            op2 = op[-1].split(".")                                           # decode the file name 
            nomF = op2[0]                                                     # the file name are isolated

            App.Console.PrintMessage(str(nomF)+"\n")                          # the file name are displayed

            for ligne in file:                                                # read the file
                X  = ligne.rstrip('\n\r') #.split()                           # decode the line
                print X                                                       # print the line in report view other method 
                                                                              # (Menu > Edit > preferences... > Output window > Redirect internal Python output (and errors) to report view checked) 
        except Exception:                                                     # if error detected to read
            App.Console.PrintError("Error read file "+"\n")                   # detect error ... display the text in red (PrintError)
        finally:                                                              # if error detected to read ... or not error the file is closed
            file.close()                                                      # if error detected to read ... or not error the file is closed
    except Exception:                                                         # if one error detected to read file
        App.Console.PrintError("Error in Open the file "+OpenName+"\n")       # if one error detected ... display the text in red (PrintError)

Use QColorDialog to get the color

Complete code:

# -*- coding: utf-8 -*-
# https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QColor.html
import PySide
from PySide import QtGui ,QtCore
from PySide.QtGui import *
from PySide.QtCore import *
path = FreeCAD.ConfigGet("UserAppData")

couleur = QtGui.QColorDialog.getColor()
if couleur.isValid():
    red   = int(str(couleur.name()[1:3]),16)    # decode hexadecimal to int()
    green = int(str(couleur.name()[3:5]),16)    # decode hexadecimal to int()
    blue  = int(str(couleur.name()[5:7]),16)    # decode hexadecimal to int()

    print couleur                               # 
    print "hexadecimal ",couleur.name()         # color format hexadecimal mode 16
    print "Red   color ",red                    # color format decimal
    print "Green color ",green                  # color format decimal
    print "Blue  color ",blue                   # color format decimal

Some useful commands

# Here the code to display the icon on the '''pushButton''', 
# change the name to another button, ('''radioButton, checkBox''') as well as the path to the icon,

       # Displays an icon on the button PushButton
       # self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # he name of the icon
       self.image_01 = path+"icone01.png" # the name of the icon
       icon01 = QtGui.QIcon() 
       icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
       self.pushButton.setIcon(icon01) 
       self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button


# path = FreeCAD.ConfigGet("UserAppData") # gives the user path
  path = FreeCAD.ConfigGet("AppHomePath") # gives the installation path of FreeCAD

# This command reverses the horizontal button, right to left
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the horizontal button

# Displays an info button
self.pushButton.setToolTip(_translate("MainWindow", "Quitter la fonction", None)) # Displays an info button

# This function gives a color button
self.pushButton.setStyleSheet("background-color: red") # This function gives a color button

# This function gives a color to the text of the button
self.pushButton.setStyleSheet("color : #ff0000") # This function gives a color to the text of the button

# combinaison des deux, bouton et texte
self.pushButton.setStyleSheet("color : #ff0000; background-color : #0000ff;" ) #  combination of the two, button, and text

# replace the icon in the main window
MainWindow.setWindowIcon(QtGui.QIcon('C:\Program Files\FreeCAD0.13\View-C3P.png'))

# connects a lineEdit on execute
self.lineEdit.returnPressed.connect(self.execute) # connects a lineEdit on "def execute" after validation on enter
# self.lineEdit.textChanged.connect(self.execute) # connects a lineEdit on "def execute" with each keystroke on the keyboard

# display text in a lineEdit
self.lineEdit.setText(str(val_X)) # Displays the value in the lineEdit (convert to string)

# extract the string contained in a lineEdit
 val_X = self.lineEdit.text() # extract the (string) string contained in lineEdit
 val_X = float(val_X0)        # converted the string to an floating
 val_X = int(val_X0)          # convert the string to an integer

# This code allows you to change the font and its attributes
       font = QtGui.QFont()
       font.setFamily("Times New Roman")
       font.setPointSize(10)
       font.setWeight(10)
       font.setBold(True) # same result with tags "<b>your text</b>" (in quotes)
       self.label_6.setFont(font)
       self.label_6.setObjectName("label_6")
       self.label_6.setStyleSheet("color : #ff0000") # This function gives a color to the text
       self.label_6.setText(_translate("MainWindow", "Select a view", None))

By using the characters with accents, where you get the error :

UnicodeDecodeError: 'utf8' codec can't decode bytes in position 0-2: invalid data

Several solutions are possible.

# conversion from a lineEdit
App.activeDocument().CopyRight.Text = str(unicode(self.lineEdit_20.text() , 'ISO-8859-1').encode('UTF-8'))
DESIGNED_BY = unicode(self.lineEdit_01.text(), 'ISO-8859-1').encode('UTF-8')

or with the procedure

def utf8(unio):
    return unicode(unio).encode('UTF8')

UnicodeEncodeError: 'ascii' codec can't encode character u'\xe9' in position 9: ordinal not in range(128)

# conversion
a = u"Nom de l'élément : "
f.write('''a.encode('iso-8859-1')'''+str(element_)+"\n")

or with the procedure

def iso8859(encoder):
    return unicode(encoder).encode('iso-8859-1')

or

iso8859(unichr(176))

or

unichr(ord(176))

or

uniteSs = "mm"+iso8859(unichr(178))
print unicode(uniteSs, 'iso8859')