PySide

From FreeCAD Documentation
Revision as of 16:26, 25 January 2015 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
PySide

Depuis peu, FreeCAD travaille avec PySide au lieu de PyQt. Ce changement a été principalement fait pour adapter la licence, PySide ayant une licence LGPL qui est plus compatible avec FreeeCAD. A part cela, PySide fonctionne exactement de la même manière que PyQt, et dans FreeCAD vous pouvez généralement utiliser l'un ou l'autre, comme vous désirez. Si vous choisissez d'utiliser PySide, il suffit de remplacer tous les "PyQt" dans les exemples de code ci-dessous avec "PySide".

Differences entren PySide et PyQt


PyQt est un module python qui permet aux applications python de créer, d'accéder et de modifier les applications Qt.
Vous pouvez l'utiliser par exemple:

  • pour créer vos propres programmes Qt en python,
  • ou pour accéder et modifier l'interface d'une application qt en cours d'exécution, comme FreeCAD.

En utilisant le module PyQt dans FreeCAD, vous avez le contrôle total de son interface. Vous pouvez par exemple:

  • Ajouter vos propres fenêtres, des widgets et des barres d'outils.
  • Ajouter ou masquer des éléments des fenêtres existantes.
  • Changer, rediriger ou ajouter des connexions entre tous ces éléments.

PyQt dispose d'une vaste documentation sur son API , et il a de nombreux tutoriels sur le net pour vous en apprendre le fonctionnement.

Si vous voulez travailler sur l'interface de FreeCAD, la première chose à faire est de créer une référence à la fenêtre principale de FreeCAD.
Faisons:

import sys
from PySide import QtGui ,QtCore 
app = QtGui.qApp
mw = FreeCADGui.getMainWindow()

Ensuite, vous pouvez par exemple naviguer à travers tous les widgets de l'interface:

for child in mw.children():
   print 'widget name = ', child.objectName(), ', widget type = ', child

Les widgets d'une interface Qt sont généralement imbriqués dans des "conteneurs" widgets, de sorte que les enfants de notre fenêtre principale peuvent contenir d'autres enfants. Selon le type de widget, vous pouvez faire énormément de choses.
Vérifiez la documentation de l'API pour voir ce qui est possible.

Ajout d'un nouveau widget, par exemple un dockWidget (qui peut être placé dans l'un des panneaux latéraux de FreeCAD) est facile:

myWidget = QtGui.QDockWidget()
mw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myWidget)

Vous pouvez ensuite ajouter ce que vous voulez directement sur votre widget:

myWidget.setObjectName("my Nice New Widget")
myWidget.resize(QtCore.QSize(300,100)) # sets size of the widget
label = QtGui.QLabel("Hello World", myWidget) # creates a label
label.setGeometry(QtCore.QRect(2,50,200,24))  # sets its size
label.setObjectName("myLabel") # sets its name, so it can be found by name

Mais la meilleure méthode est de créer un objet "interface utilisateur" (UI) qui fera toute la configuration de votre widget. Le gros avantage est, qu'une telle interface utilisateur peut être créées graphiquement avec le programme Qt Designer. Un objet typique généré par Qt Designer est fait comme ceci:

class myWidget_Ui(object):
  def setupUi(self, myWidget):
    myWidget.setObjectName("my Nice New Widget")
    myWidget.resize(QtCore.QSize(300,100).expandedTo(myWidget.minimumSizeHint())) # sets size of the widget

    self.label = QtGui.QLabel(myWidget) # creates a label
    self.label.setGeometry(QtCore.QRect(50,50,200,24)) # sets its size
    self.label.setObjectName("label") # sets its name, so it can be found by name

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

Pour l'utiliser, il suffit de l'appliquer à votre widget fraîchement créé, comme ceci:

app = QtGui.qApp
FCmw = app.activeWindow()
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