Also perform several improvements such as PEP8 cleanup, write complete docstring, type checking of the input arguments, accepting a full placement to modify the position, and deprecating the older call. Update the Gui Command as well.
80 lines
3.6 KiB
Python
80 lines
3.6 KiB
Python
# ***************************************************************************
|
|
# * Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
|
|
# * Copyright (c) 2009, 2010 Ken Cline <cline@frii.com> *
|
|
# * *
|
|
# * 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 *
|
|
# * *
|
|
# ***************************************************************************
|
|
"""Provide the object code for Draft Text objects."""
|
|
## @package text
|
|
# \ingroup DRAFT
|
|
# \brief Provide the object code for Draft Text objects.
|
|
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
import FreeCAD as App
|
|
|
|
from draftobjects.draft_annotation import DraftAnnotation
|
|
|
|
|
|
class Text(DraftAnnotation):
|
|
"""The Draft Text object."""
|
|
|
|
def __init__(self, obj):
|
|
super(Text, self).__init__(obj, "Text")
|
|
self.set_properties(obj)
|
|
obj.Proxy = self
|
|
|
|
def set_properties(self, obj):
|
|
"""Add properties to the object and set them."""
|
|
properties = obj.PropertiesList
|
|
|
|
if "Placement" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The placement of the base point "
|
|
"of the first line")
|
|
obj.addProperty("App::PropertyPlacement",
|
|
"Placement",
|
|
"Base",
|
|
_tip)
|
|
obj.Placement = App.Placement()
|
|
|
|
if "Text" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The text displayed by this object.\n"
|
|
"It is a list of strings; each element "
|
|
"in the list will be displayed "
|
|
"in its own line.")
|
|
obj.addProperty("App::PropertyStringList",
|
|
"Text",
|
|
"Base",
|
|
_tip)
|
|
obj.Text = []
|
|
|
|
def onDocumentRestored(self, obj):
|
|
"""Execute code when the document is restored.
|
|
|
|
It calls the parent class to add missing annotation properties.
|
|
"""
|
|
super(Text, self).onDocumentRestored(obj)
|
|
|
|
|
|
# Alias for compatibility with v0.18 and earlier
|
|
DraftText = Text
|