173 lines
6.5 KiB
Python
173 lines
6.5 KiB
Python
# ***************************************************************************
|
|
# * (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
|
|
# * (c) 2009, 2010 Ken Cline <cline@frii.com> *
|
|
# * (c) 2020 Eliud Cabrera Castillo <e.cabrera-castillo@tum.de> *
|
|
# * *
|
|
# * This file is part of the FreeCAD CAx development system. *
|
|
# * *
|
|
# * 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. *
|
|
# * *
|
|
# * FreeCAD 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 FreeCAD; if not, write to the Free Software *
|
|
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
# * USA *
|
|
# * *
|
|
# ***************************************************************************
|
|
"""Provides GUI tools to create simple Text objects.
|
|
|
|
The textual block can consist of multiple lines.
|
|
"""
|
|
## @package gui_texts
|
|
# \ingroup draftguitools
|
|
# \brief Provides GUI tools to create simple Text objects.
|
|
|
|
## \addtogroup draftguitools
|
|
# @{
|
|
import sys
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
import FreeCAD as App
|
|
import FreeCADGui as Gui
|
|
import Draft_rc
|
|
import DraftVecUtils
|
|
import draftguitools.gui_base_original as gui_base_original
|
|
import draftguitools.gui_tool_utils as gui_tool_utils
|
|
|
|
from draftutils.translate import translate
|
|
from draftutils.messages import _toolmsg
|
|
|
|
# The module is used to prevent complaints from code checkers (flake8)
|
|
True if Draft_rc.__name__ else False
|
|
|
|
|
|
class Text(gui_base_original.Creator):
|
|
"""Gui command for the Text tool."""
|
|
|
|
def GetResources(self):
|
|
"""Set icon, menu and tooltip."""
|
|
|
|
return {'Pixmap': 'Draft_Text',
|
|
'Accel': "T, E",
|
|
'MenuText': QT_TRANSLATE_NOOP("Draft_Text", "Text"),
|
|
'ToolTip': QT_TRANSLATE_NOOP("Draft_Text", "Creates a multi-line annotation. CTRL to snap.")}
|
|
|
|
def Activated(self):
|
|
"""Execute when the command is called."""
|
|
super().Activated(name="Text")
|
|
if self.ui:
|
|
self.text = ''
|
|
self.ui.sourceCmd = self
|
|
self.ui.pointUi(title=translate("draft", self.featureName), icon="Draft_Text")
|
|
self.ui.isRelative.hide()
|
|
self.ui.continueCmd.show()
|
|
self.call = self.view.addEventCallback("SoEvent", self.action)
|
|
self.active = True
|
|
self.ui.xValue.setFocus()
|
|
self.ui.xValue.selectAll()
|
|
_toolmsg(translate("draft", "Pick location point"))
|
|
|
|
def finish(self, cont=False):
|
|
"""Terminate the operation.
|
|
|
|
Parameters
|
|
----------
|
|
cont: bool or None, optional
|
|
Restart (continue) the command if `True`, or if `None` and
|
|
`ui.continueMode` is `True`.
|
|
"""
|
|
self.end_callbacks(self.call)
|
|
super().finish(self)
|
|
if cont or (cont is None and self.ui and self.ui.continueMode):
|
|
self.Activated()
|
|
|
|
def createObject(self):
|
|
"""Create the actual object in the current document."""
|
|
rot, sup, pts, fil = self.getStrings()
|
|
base = pts[1:-1]
|
|
|
|
text_list = self.text
|
|
|
|
if not text_list:
|
|
self.finish()
|
|
return None
|
|
|
|
# If the last element is an empty string "" we remove it
|
|
if not text_list[-1]:
|
|
text_list.pop()
|
|
|
|
t_list = ['"' + line + '"' for line in text_list]
|
|
|
|
list_as_text = ", ".join(t_list)
|
|
|
|
string = '[' + list_as_text + ']'
|
|
|
|
Gui.addModule("Draft")
|
|
_cmd = 'Draft.make_text'
|
|
_cmd += '('
|
|
_cmd += string + ', '
|
|
_cmd += 'placement=pl, '
|
|
_cmd += 'screen=None, height=None, line_spacing=None'
|
|
_cmd += ')'
|
|
_cmd_list = ['pl = FreeCAD.Placement()',
|
|
'pl.Rotation.Q = ' + rot,
|
|
'pl.Base = ' + base,
|
|
'_text_ = ' + _cmd,
|
|
'Draft.autogroup(_text_)',
|
|
'FreeCAD.ActiveDocument.recompute()']
|
|
self.commit(translate("draft", "Create Text"),
|
|
_cmd_list)
|
|
self.finish(cont=None)
|
|
|
|
def action(self, arg):
|
|
"""Handle the 3D scene events.
|
|
|
|
This is installed as an EventCallback in the Inventor view.
|
|
|
|
Parameters
|
|
----------
|
|
arg: dict
|
|
Dictionary with strings that indicates the type of event received
|
|
from the 3D view.
|
|
"""
|
|
if arg["Type"] == "SoKeyboardEvent":
|
|
if arg["Key"] == "ESCAPE":
|
|
self.finish()
|
|
elif arg["Type"] == "SoLocation2Event": # mouse movement detection
|
|
if self.active:
|
|
(self.point,
|
|
ctrlPoint, info) = gui_tool_utils.getPoint(self, arg)
|
|
gui_tool_utils.redraw3DView()
|
|
elif arg["Type"] == "SoMouseButtonEvent":
|
|
if arg["State"] == "DOWN" and arg["Button"] == "BUTTON1":
|
|
if self.point:
|
|
self.active = False
|
|
Gui.Snapper.off()
|
|
self.node.append(self.point)
|
|
self.ui.textUi()
|
|
self.ui.textValue.setFocus()
|
|
|
|
def numericInput(self, numx, numy, numz):
|
|
"""Validate the entry fields in the user interface.
|
|
|
|
This function is called by the toolbar or taskpanel interface
|
|
when valid x, y, and z have been entered in the input fields.
|
|
"""
|
|
self.point = App.Vector(numx, numy, numz)
|
|
self.node.append(self.point)
|
|
self.ui.textUi()
|
|
self.ui.textValue.setFocus()
|
|
|
|
|
|
Gui.addCommand('Draft_Text', Text())
|
|
|
|
## @}
|