Material: Created material editor

Materal editor is now funcional, abeit not complete. Can be used to
create and save new cards. Lauch from within FreeCAD with
import MaterialEditor; MaterialEditor.openEditor()

src/Mod/Material/CMakeLists.txt

@@ -4,6 +4,7 @@ SET(Material_SRCS
     InitGui.py
     Material.py
     importFCMat.py
+    MaterialEditor.py
 )
 SOURCE_GROUP("" FILES ${Material_SRCS})
 
@@ -34,3 +35,11 @@ INSTALL(
     FILES ${Material_SRCS}
     DESTINATION Mod/Material
 )
+
+INSTALL(
+    DIRECTORY
+        StandardMaterial
+    DESTINATION
+        ${CMAKE_INSTALL_DATADIR}/Mod/Material
+    FILES_MATCHING PATTERN "*.FCMat*"
+)

src/Mod/Material/MaterialEditor.py

@@ -0,0 +1,239 @@
+#***************************************************************************
+#*                                                                         *
+#*   Copyright (c) 2013 - Yorik van Havre <yorik@uncreated.net>            *  
+#*                                                                         *
+#*   This program is free software; you can redistribute it and/or modify  *
+#*   it under the terms of the GNU Lesser General Public License (LGPL)    *
+#*   as published by the Free Software Foundation; either version 2 of     *
+#*   the License, or (at your option) any later version.                   *
+#*   for detail see the LICENCE text file.                                 *
+#*                                                                         *
+#*   This program is distributed in the hope that it will be useful,       *
+#*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+#*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+#*   GNU Library General Public License for more details.                  *
+#*                                                                         *
+#*   You should have received a copy of the GNU Library General Public     *
+#*   License along with this program; if not, write to the Free Software   *
+#*   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
+#*   USA                                                                   *
+#*                                                                         *
+#***************************************************************************
+
+import FreeCAD, os
+from PyQt4 import QtCore, QtGui, uic
+
+__title__="FreeCAD material editor"
+__author__ = "Yorik van Havre"
+__url__ = "http://www.freecadweb.org"
+
+class MaterialEditor(QtGui.QDialog):
+
+    def __init__(self, obj = None, prop = None):
+        "Initializes, optionally with an object name and a material property name to edit"
+        QtGui.QDialog.__init__(self)
+        self.obj = obj
+        self.prop = prop
+        self.customprops = []
+        # load the UI file from the same directory as this script
+        uic.loadUi(os.path.dirname(__file__)+os.sep+"materials-editor.ui",self)
+        self.ui = self
+        # additional UI fixes and tweaks
+        self.ButtonURL.setIcon(QtGui.QIcon(":/icons/internet-web-browser.svg"))
+        self.ButtonDeleteProperty.setEnabled(False)
+        self.standardButtons.button(QtGui.QDialogButtonBox.Ok).setAutoDefault(False)
+        self.standardButtons.button(QtGui.QDialogButtonBox.Cancel).setAutoDefault(False)
+        self.updateCards()
+        self.Editor.header().resizeSection(0,200)
+        self.Editor.expandAll()
+        self.Editor.setFocus()
+        # TODO allow to enter a custom property by pressing Enter in the lineedit (currently closes the dialog)
+        self.Editor.setEditTriggers(QtGui.QAbstractItemView.NoEditTriggers)
+        QtCore.QObject.connect(self.ComboMaterial, QtCore.SIGNAL("currentIndexChanged(QString)"), self.updateContents)
+        QtCore.QObject.connect(self.ButtonURL, QtCore.SIGNAL("clicked()"), self.openProductURL)
+        QtCore.QObject.connect(self.standardButtons, QtCore.SIGNAL("accepted()"), self.accept)
+        QtCore.QObject.connect(self.standardButtons, QtCore.SIGNAL("rejected()"), self.reject)
+        QtCore.QObject.connect(self.ButtonAddProperty, QtCore.SIGNAL("clicked()"), self.addCustomProperty)
+        QtCore.QObject.connect(self.EditProperty, QtCore.SIGNAL("returnPressed()"), self.addCustomProperty)
+        QtCore.QObject.connect(self.ButtonDeleteProperty, QtCore.SIGNAL("clicked()"), self.deleteCustomProperty)
+        QtCore.QObject.connect(self.Editor, QtCore.SIGNAL("itemDoubleClicked(QTreeWidgetItem*,int)"), self.itemClicked)
+        QtCore.QObject.connect(self.Editor, QtCore.SIGNAL("currentItemChanged(QTreeWidgetItem*,QTreeWidgetItem*)"), self.checkDeletable)
+        QtCore.QObject.connect(self.ButtonOpen, QtCore.SIGNAL("clicked()"), self.openfile)
+        QtCore.QObject.connect(self.ButtonSave, QtCore.SIGNAL("clicked()"), self.savefile)
+        # update the editor with the contents of the property, if we have one
+        if self.prop and self.obj:
+            d = FreeCAD.ActiveDocument.getObject(self.obj).getPropertyByName(self.prop)
+            self.updateContents(d)
+
+    def updateCards(self):
+        "updates the contents of the materials combo with existing material cards"
+        # look for cards in both resources dir and user folder. 
+        # User cards with same name will override system cards
+        paths = [FreeCAD.getResourceDir() + os.sep + "Mod" + os.sep + "Material" + os.sep + "StandardMaterial"]
+        paths.append(FreeCAD.ConfigGet("UserAppData"))
+        self.cards = {}
+        for p in paths:
+            for f in os.listdir(p):
+                b,e = os.path.splitext(f)
+                if e.upper() == ".FCMAT":
+                    self.cards[b] = p + os.sep + f
+        if self.cards:
+            self.ComboMaterial.clear()
+            self.ComboMaterial.addItem("") # add a blank item first
+            for k,i in self.cards.iteritems():
+                self.ComboMaterial.addItem(k)
+
+    def updateContents(self,data):
+        "updates the contents of the editor with the given data (can be the name of a card or a dictionary)"
+        if isinstance(data,dict):
+            self.clearEditor()
+            for k,i in data.iteritems():
+                k = self.expandKey(k)
+                slot = self.Editor.findItems(k,QtCore.Qt.MatchRecursive,0)
+                if len(slot) == 1:
+                    slot = slot[0]
+                    slot.setText(1,i)
+                else:
+                    self.addCustomProperty(k,i)
+        elif isinstance(data,QtCore.QString):
+            k = str(data)
+            if k:
+                if k in self.cards:
+                    import importFCMat
+                    d = importFCMat.read(self.cards[k])
+                    if d:
+                        self.updateContents(d)
+
+    def openProductURL(self):
+        "opens the contents of the ProductURL field in an external browser"
+        url = str(self.Editor.findItems(translate("Material","Product URL"),QtCore.Qt.MatchRecursive,0)[0].text(1))
+        if url:
+            QtGui.QDesktopServices.openUrl(QtCore.QUrl(url, QtCore.QUrl.TolerantMode))
+
+    def accept(self):
+        "if we are editing a property, set the property values"
+        if self.prop and self.obj:
+            d = self.getDict()
+            o = FreeCAD.ActiveDocument.getObject(self.obj)
+            setattr(o,self.prop,d)
+        QtGui.QDialog.accept(self)
+
+    def expandKey(self, key):
+        "adds spaces before caps in a KeyName"
+        nk = ""
+        for l in key:
+            if l.isupper():
+                if nk:
+                    # this allows for series of caps, such as ProductURL
+                    if not nk[-1].isupper():
+                        nk += " "
+            nk += l
+        return nk
+
+    def collapseKey(self, key):
+        "removes the spaces in a Key Name"
+        nk = ""
+        for l in key:
+            if l != " ":
+                nk += l
+        return nk
+
+    def clearEditor(self):
+        "Clears the contents of the editor"
+        for i1 in range(self.Editor.topLevelItemCount()):
+            w = self.Editor.topLevelItem(i1)
+            for i2 in range(w.childCount()):
+                c = w.child(i2)
+                c.setText(1,"")
+        for k in self.customprops:
+            self.deleteCustomProperty(k)
+
+    def addCustomProperty(self, key = None, value = None):
+        "Adds a custom property to the editor, optionally with a value"
+        if not key:
+            key = str(self.EditProperty.text())
+        if key:
+            if not key in self.customprops:
+                if not self.Editor.findItems(key,QtCore.Qt.MatchRecursive,0):
+                    top = self.Editor.findItems(translate("Material","User defined"),QtCore.Qt.MatchExactly,0)
+                    if top:
+                        i = QtGui.QTreeWidgetItem(top[0])
+                        i.setFlags(QtCore.Qt.ItemIsSelectable|QtCore.Qt.ItemIsEditable|QtCore.Qt.ItemIsDragEnabled|QtCore.Qt.ItemIsUserCheckable|QtCore.Qt.ItemIsEnabled)
+                        i.setText(0,key)
+                        self.customprops.append(key)
+                        self.EditProperty.setText("")
+                        if value:
+                            i.setText(1,value)
+
+    def deleteCustomProperty(self, key = None):
+        "Deletes a custom property from the editor"
+        if not key:
+            key = str(self.Editor.currentItem().text(0))
+        if key:
+            if key in self.customprops:
+                i = self.Editor.findItems(key,QtCore.Qt.MatchRecursive,0)
+                if i:
+                    top = self.Editor.findItems(translate("Material","User defined"),QtCore.Qt.MatchExactly,0)
+                    if top:
+                        top = top[0]
+                        ii = top.indexOfChild(i[0])
+                        if ii >= 0:
+                            top.takeChild(ii)
+                            self.customprops.remove(key)
+
+    def itemClicked(self, item, column):
+        "Edits an item if it is not in the first column"
+        if column > 0:
+            self.Editor.editItem(item, column)
+
+    def checkDeletable(self,current,previous):
+        "Checks if the current item is a custom property, if yes enable the delete button"
+        if str(current.text(0)) in self.customprops:
+            self.ButtonDeleteProperty.setEnabled(True)
+        else:
+            self.ButtonDeleteProperty.setEnabled(False)
+
+    def getDict(self):
+        "returns a dictionnary from the contents of the editor"
+        d = {}
+        for i1 in range(self.Editor.topLevelItemCount()):
+            w = self.Editor.topLevelItem(i1)
+            for i2 in range(w.childCount()):
+                c = w.child(i2)
+                # TODO the following should be translated back to english,since text(0) could be translated
+                d[self.collapseKey(str(c.text(0)))] = unicode(c.text(1))
+        return d
+
+    def openfile(self):
+        "Opens a FCMat file"
+        filename = QtGui.QFileDialog.getOpenFileName(QtGui.qApp.activeWindow(),'Open FreeCAD Material file','*.FCMat')
+        if filename:
+            self.clearEditor()
+            import importFCMat
+            d = importFCMat.read(filename)
+            if d:
+                self.updateContents(d)
+
+    def savefile(self):
+        "Saves a FCMat file"
+        name = str(self.Editor.findItems(translate("Material","Name"),QtCore.Qt.MatchRecursive,0)[0].text(1))
+        if not name:
+            name = "Material"
+        filename = QtGui.QFileDialog.getSaveFileName(QtGui.qApp.activeWindow(),'Save FreeCAD Material file',name+'.FCMat')
+        if filename:
+            d = self.getDict()
+            if d:
+                import importFCMat
+                importFCMat.write(filename,d)
+
+
+def translate(context,text):
+    "translates text"
+    return text #TODO use Qt translation mechanism here
+
+def openEditor(obj = None, prop = None):
+    """openEditor([obj,prop]): opens the editor, optionally with
+    an object name and material property name to edit"""
+    editor = MaterialEditor(obj,prop)
+    editor.show()
+