e3da572072
This includes `gui_annotationstyleeditor`, `gui_arcs`, `gui_array_simple`, `gui_arrays`, `gui_base`, `gui_base_original`, `gui_beziers`, `gui_circles`, `gui_circulararray`, `gui_clone`, `gui_circulararray`, `gui_clone`, `gui_dimension_ops`, `gui_dimensions`, `gui_downgrade`, `gui_draft2sketch`, `gui_drawing`, `gui_edit`, `gui_edit_arch_objects`, `gui_edit_draft_objects`, `gui_edit_part_objects`, `gui_edit_sketcher_objects`, `gui_ellipses`, `gui_facebinders`, `gui_fillets`, `gui_grid`, `gui_groups`, `gui_heal`, `gui_join`, `gui_labels`, `gui_line_add_delete`, `gui_lineops`, `gui_lines`, `gui_lineslope`, `gui_mirror`, `gui_move`, `gui_offset`, `gui_orthoarray`, `gui_patharray`, `gui_planeproxy`, `gui_pointarray`, `gui_points`, `gui_polararray`, `gui_polygons`, `gui_rectangles`, `gui_rotate`, `gui_scale`, `gui_selectplane`, `gui_shape2dview`, `gui_shapestrings`, `gui_snapper`, `gui_snaps`, `gui_splines`, `gui_split`, `gui_stretch`, `gui_styles`, `gui_subeleemnts`, `gui_texts`, `gui_togglemodes`, `gui_tools_utils`, `gui_trackers`, `gui_trimex`, `gui_upgrade`, `gui_wire2spline`. These are added to the `draftguitools` Doxygen group so that the functions and classes contained in each module are listed appropriately in the automatically generated documentation.
358 lines
15 KiB
Python
358 lines
15 KiB
Python
# -*- coding: utf-8 -*-
|
|
# ***************************************************************************
|
|
# * Copyright (c) 2020 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 *
|
|
# * *
|
|
# ***************************************************************************
|
|
"""Provides GUI tools to create and edit annotation styles."""
|
|
## @package gui_annotationstyleeditor
|
|
# \ingroup draftguitools
|
|
# \brief Provides GUI tools to create and edit annotation styles.
|
|
|
|
## \addtogroup draftguitools
|
|
# @{
|
|
import json
|
|
import PySide.QtGui as QtGui
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
import FreeCAD as App
|
|
import FreeCADGui as Gui
|
|
import draftguitools.gui_base as gui_base
|
|
|
|
from FreeCAD import Units as U
|
|
from draftutils.translate import _tr
|
|
from draftutils.utils import ANNOTATION_STYLE as DEFAULT
|
|
|
|
param = App.ParamGet("User parameter:BaseApp/Preferences/Mod/Draft")
|
|
|
|
|
|
class AnnotationStyleEditor(gui_base.GuiCommandSimplest):
|
|
"""Annotation style editor for text and dimensions.
|
|
|
|
It inherits `GuiCommandSimplest` to set up the document,
|
|
`IsActive`, and other behavior. See this class for more information.
|
|
|
|
Attributes
|
|
----------
|
|
doc: App::Document
|
|
The active document when the command is used, so that the styles
|
|
are saved to this document.
|
|
|
|
styles: dict
|
|
A dictionary with key-value pairs that define the new style.
|
|
|
|
renamed: dict
|
|
A dictionary that holds the name of the style that is renamed
|
|
by the editor.
|
|
|
|
form: PySide.QtWidgets.QDialog
|
|
Holds the loaded interface from the `.ui` file.
|
|
"""
|
|
|
|
def __init__(self):
|
|
super(AnnotationStyleEditor, self).__init__(name=_tr("Annotation style editor"))
|
|
self.doc = None
|
|
self.styles = {}
|
|
self.renamed = {}
|
|
self.form = None
|
|
|
|
def GetResources(self):
|
|
"""Set icon, menu and tooltip."""
|
|
_tip = "Manage or create annotation styles"
|
|
|
|
return {'Pixmap': ":icons/Draft_Annotation_Style.svg",
|
|
'MenuText': QT_TRANSLATE_NOOP("Draft_AnnotationStyleEditor",
|
|
"Annotation styles..."),
|
|
'ToolTip': QT_TRANSLATE_NOOP("Draft_AnnotationStyleEditor",
|
|
_tip)}
|
|
|
|
def Activated(self):
|
|
"""Execute when the command is called.
|
|
|
|
The document attribute is set here by the parent class.
|
|
"""
|
|
super(AnnotationStyleEditor, self).Activated()
|
|
# reset rename table
|
|
self.renamed = {}
|
|
|
|
# load dialog
|
|
ui_file = ":/ui/dialog_AnnotationStyleEditor.ui"
|
|
self.form = Gui.PySideUic.loadUi(ui_file)
|
|
|
|
# restore stored size
|
|
w = param.GetInt("AnnotationStyleEditorWidth", 450)
|
|
h = param.GetInt("AnnotationStyleEditorHeight", 450)
|
|
self.form.resize(w, h)
|
|
|
|
# center the dialog over FreeCAD window
|
|
mw = Gui.getMainWindow()
|
|
self.form.move(mw.frameGeometry().topLeft()
|
|
+ mw.rect().center()
|
|
- self.form.rect().center())
|
|
|
|
# set icons
|
|
self.form.setWindowIcon(QtGui.QIcon(":/icons/Draft_Annotation_Style.svg"))
|
|
self.form.pushButtonDelete.setIcon(QtGui.QIcon(":/icons/edit_Cancel.svg"))
|
|
self.form.pushButtonRename.setIcon(QtGui.QIcon(":/icons/accessories-text-editor.svg"))
|
|
self.form.pushButtonDelete.resize(self.form.pushButtonDelete.sizeHint())
|
|
self.form.pushButtonRename.resize(self.form.pushButtonRename.sizeHint())
|
|
|
|
# fill the styles combo
|
|
self.styles = self.read_meta()
|
|
for style in self.styles.keys():
|
|
self.form.comboBoxStyles.addItem(style)
|
|
|
|
# connect signals/slots
|
|
self.form.comboBoxStyles.currentIndexChanged.connect(self.on_style_changed)
|
|
self.form.pushButtonDelete.clicked.connect(self.on_delete)
|
|
self.form.pushButtonRename.clicked.connect(self.on_rename)
|
|
for attr in DEFAULT.keys():
|
|
control = getattr(self.form, attr)
|
|
for signal in ("clicked", "textChanged",
|
|
"valueChanged", "stateChanged",
|
|
"currentIndexChanged"):
|
|
if hasattr(control, signal):
|
|
getattr(control, signal).connect(self.update_style)
|
|
break
|
|
|
|
# show editor dialog
|
|
result = self.form.exec_()
|
|
|
|
# process if OK was clicked
|
|
if result:
|
|
self.save_meta(self.styles)
|
|
|
|
# store dialog size
|
|
param.SetInt("AnnotationStyleEditorWidth", self.form.width())
|
|
param.SetInt("AnnotationStyleEditorHeight", self.form.height())
|
|
|
|
def read_meta(self):
|
|
"""Read the document Meta attribute and return a dict."""
|
|
styles = {}
|
|
meta = self.doc.Meta
|
|
for key, value in meta.items():
|
|
if key.startswith("Draft_Style_"):
|
|
styles[key[12:]] = json.loads(value)
|
|
return styles
|
|
|
|
def save_meta(self, styles):
|
|
"""Save a dict to the document Meta attribute and update objects."""
|
|
# save meta
|
|
changedstyles = []
|
|
meta = self.doc.Meta
|
|
for key, value in styles.items():
|
|
try:
|
|
strvalue = json.dumps(value)
|
|
except Exception:
|
|
print("debug: unable to serialize this:", value)
|
|
if ("Draft_Style_" + key in meta
|
|
and meta["Draft_Style_" + key] != strvalue):
|
|
changedstyles.append(key)
|
|
meta["Draft_Style_" + key] = strvalue
|
|
|
|
# remove deleted styles
|
|
todelete = []
|
|
for key, value in meta.items():
|
|
if key.startswith("Draft_Style_"):
|
|
if key[12:] not in styles:
|
|
todelete.append(key)
|
|
for key in todelete:
|
|
del meta[key]
|
|
|
|
self.doc.Meta = meta
|
|
|
|
# propagate changes to all annotations
|
|
for obj in self.get_annotations():
|
|
vobj = obj.ViewObject
|
|
try:
|
|
curent = vobj.AnnotationStyle
|
|
except AssertionError:
|
|
# empty annotation styles list
|
|
pass
|
|
else:
|
|
if vobj.AnnotationStyle in self.renamed.keys():
|
|
# the style has been renamed
|
|
# temporarily add the new style and switch to it
|
|
vobj.AnnotationStyle = vobj.AnnotationStyle + [self.renamed[vobj.AnnotationStyle]]
|
|
vobj.AnnotationStyle = self.renamed[vobj.AnnotationStyle]
|
|
if vobj.AnnotationStyle in styles.keys():
|
|
if vobj.AnnotationStyle in changedstyles:
|
|
# the style has changed
|
|
for attr, attrvalue in styles[vobj.AnnotationStyle].items():
|
|
if hasattr(vobj, attr):
|
|
try:
|
|
getattr(vobj,attr).setValue(attrvalue)
|
|
except:
|
|
try:
|
|
setattr(vobj,attr,attrvalue)
|
|
except:
|
|
unitvalue = U.Quantity(attrvalue, U.Length).Value
|
|
setattr(vobj,attr,unitvalue)
|
|
else:
|
|
# the style has been removed
|
|
vobj.AnnotationStyle = ""
|
|
vobj.AnnotationStyle = [""] + list(styles.keys())
|
|
|
|
def on_style_changed(self, index):
|
|
"""Execute as a callback when the styles combobox changes."""
|
|
if index <= 1:
|
|
# nothing happens
|
|
self.form.pushButtonDelete.setEnabled(False)
|
|
self.form.pushButtonRename.setEnabled(False)
|
|
self.fill_editor(None)
|
|
if index == 1:
|
|
# Add new... entry
|
|
reply = QtGui.QInputDialog.getText(None,
|
|
"Create new style",
|
|
"Style name:")
|
|
if reply[1]:
|
|
# OK or Enter pressed
|
|
name = reply[0]
|
|
if name in self.styles:
|
|
reply = QtGui.QMessageBox.information(None,
|
|
"Style exists",
|
|
"This style name already exists")
|
|
else:
|
|
# create new default style
|
|
self.styles[name] = {}
|
|
for key, val in DEFAULT.items():
|
|
self.styles[name][key] = val[1]
|
|
self.form.comboBoxStyles.addItem(name)
|
|
self.form.comboBoxStyles.setCurrentIndex(self.form.comboBoxStyles.count() - 1)
|
|
elif index > 1:
|
|
# Existing style
|
|
self.form.pushButtonDelete.setEnabled(True)
|
|
self.form.pushButtonRename.setEnabled(True)
|
|
self.fill_editor(self.form.comboBoxStyles.itemText(index))
|
|
|
|
def on_delete(self):
|
|
"""Execute as a callback when the delete button is pressed."""
|
|
index = self.form.comboBoxStyles.currentIndex()
|
|
style = self.form.comboBoxStyles.itemText(index)
|
|
|
|
if self.get_style_users(style):
|
|
reply = QtGui.QMessageBox.question(None,
|
|
"Style in use",
|
|
"This style is used by some objects in this document. Are you sure?",
|
|
QtGui.QMessageBox.Yes | QtGui.QMessageBox.No,
|
|
QtGui.QMessageBox.No)
|
|
if reply == QtGui.QMessageBox.No:
|
|
return
|
|
self.form.comboBoxStyles.removeItem(index)
|
|
del self.styles[style]
|
|
|
|
def on_rename(self):
|
|
"""Execute as a callback when the rename button is pressed."""
|
|
index = self.form.comboBoxStyles.currentIndex()
|
|
style = self.form.comboBoxStyles.itemText(index)
|
|
|
|
reply = QtGui.QInputDialog.getText(None,
|
|
"Rename style",
|
|
"New name:",
|
|
QtGui.QLineEdit.Normal,
|
|
style)
|
|
if reply[1]:
|
|
# OK or Enter pressed
|
|
newname = reply[0]
|
|
if newname in self.styles:
|
|
reply = QtGui.QMessageBox.information(None,
|
|
"Style exists",
|
|
"This style name already exists")
|
|
else:
|
|
self.form.comboBoxStyles.setItemText(index, newname)
|
|
value = self.styles[style]
|
|
del self.styles[style]
|
|
self.styles[newname] = value
|
|
self.renamed[style] = newname
|
|
|
|
def fill_editor(self, style):
|
|
"""Fill the editor fields with the contents of a style."""
|
|
if style is None:
|
|
style = {}
|
|
for key, val in DEFAULT.items():
|
|
style[key] = val[1]
|
|
|
|
if not isinstance(style, dict):
|
|
if style in self.styles:
|
|
style = self.styles[style]
|
|
else:
|
|
print("debug: unable to fill dialog from style", style)
|
|
|
|
for key, value in style.items():
|
|
control = getattr(self.form, key)
|
|
if DEFAULT[key][0] == "str":
|
|
control.setText(value)
|
|
elif DEFAULT[key][0] == "font":
|
|
control.setCurrentFont(QtGui.QFont(value))
|
|
elif DEFAULT[key][0] == "color":
|
|
r = ((value >> 24) & 0xFF) / 255.0
|
|
g = ((value >> 16) & 0xFF) / 255.0
|
|
b = ((value >> 8) & 0xFF) / 255.0
|
|
color = QtGui.QColor.fromRgbF(r, g, b)
|
|
control.setProperty("color", color)
|
|
elif DEFAULT[key][0] in ["int", "float"]:
|
|
control.setValue(value)
|
|
elif DEFAULT[key][0] == "bool":
|
|
control.setChecked(value)
|
|
elif DEFAULT[key][0] == "index":
|
|
control.setCurrentIndex(value)
|
|
|
|
def update_style(self, arg=None):
|
|
"""Update the current style with the values from the editor."""
|
|
index = self.form.comboBoxStyles.currentIndex()
|
|
if index > 1:
|
|
values = {}
|
|
style = self.form.comboBoxStyles.itemText(index)
|
|
for key in DEFAULT.keys():
|
|
control = getattr(self.form, key)
|
|
if DEFAULT[key][0] == "str":
|
|
values[key] = control.text()
|
|
elif DEFAULT[key][0] == "font":
|
|
values[key] = control.currentFont().family()
|
|
elif DEFAULT[key][0] == "color":
|
|
values[key] = control.property("color").rgb() << 8
|
|
elif DEFAULT[key][0] in ["int", "float"]:
|
|
values[key] = control.value()
|
|
elif DEFAULT[key][0] == "bool":
|
|
values[key] = control.isChecked()
|
|
elif DEFAULT[key][0] == "index":
|
|
values[key] = control.currentIndex()
|
|
self.styles[style] = values
|
|
|
|
def get_annotations(self):
|
|
"""Get all the objects that support annotation styles."""
|
|
users = []
|
|
for obj in self.doc.Objects:
|
|
vobj = obj.ViewObject
|
|
if "AnnotationStyle" in vobj.PropertiesList:
|
|
users.append(obj)
|
|
return users
|
|
|
|
def get_style_users(self, style):
|
|
"""Get all objects using a certain style."""
|
|
users = []
|
|
for obj in self.get_annotations():
|
|
if obj.ViewObject.AnnotationStyle == style:
|
|
users.append(obj)
|
|
return users
|
|
|
|
|
|
Gui.addCommand('Draft_AnnotationStyleEditor', AnnotationStyleEditor())
|
|
|
|
## @}
|