Draft: standardized module to build messages

This commit is contained in:
vocx-fc
2020-02-03 13:17:08 -06:00
committed by Yorik van Havre
parent a80ba25896
commit 814c97b70d
2 changed files with 50 additions and 0 deletions

View File

@@ -54,6 +54,7 @@ SET(Draft_utilities
draftutils/gui_utils.py
draftutils/todo.py
draftutils/translate.py
draftutils/messages.py
)
SET(Draft_objects

View File

@@ -0,0 +1,49 @@
"""Provide message utility functions for the Draft Workbench."""
## @package messages
# \ingroup DRAFT
# \brief Provide message utility functions for the Draft Workbench.
# ***************************************************************************
# * (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 *
# * *
# ***************************************************************************
import FreeCAD as App
def _msg(text, end="\n"):
"""Write messages to console including the line ending."""
App.Console.PrintMessage(text + end)
def _wrn(text, end="\n"):
"""Write warnings to console including the line ending."""
App.Console.PrintWarning(text + end)
def _err(text, end="\n"):
"""Write errors to console including the line ending."""
App.Console.PrintError(text + end)
def _log(text, end="\n"):
"""Write messages to the log file including the line ending."""
App.Console.PrintLog(text + end)