LabRPS: /* Messages */

2024-10-27T00:52:51Z

Messages

← Older revision		Revision as of 17:52, 26 October 2024
Line 11:		Line 11:
	== Messages ==		== Messages ==

	{{Emphasis\|See also:}} ~~[[Console API\|Console API]], and~~ [[LabRPS Scripting Basics\|LabRPS Scripting Basics]].		{{Emphasis\|See also:}} [[LabRPS Scripting Basics\|LabRPS Scripting Basics]].

	The report view displays messages from the internal LabRPS {{incode\|Console}} class.		The report view displays messages from the internal LabRPS {{incode\|Console}} class.

LabRPS: Created page with "== Introduction == The Report view is a panel that shows text messages from LabRPS processes and tools. It is available in the menu {{MenuCommand|{{StdMenu|View}} → Panels → Report view}}. Certain properties of this panel, like color of the text and whether to display it automatically on warnings or errors, can be configured in the {{MenuCommand|General → Report view}} tab of the Preferences_Editor#Report_view|Preferences Edi..."

2024-10-27T00:50:00Z

Created page with "== Introduction == The Report view is a panel that shows text messages from LabRPS processes and tools. It is available in the menu {{MenuCommand|{{StdMenu|View}} → Panels → Report view}}. Certain properties of this panel, like color of the text and whether to display it automatically on warnings or errors, can be configured in the {{MenuCommand|General → Report view}} tab of the Preferences_Editor#Report_view|Preferences Edi..."

New page

== Introduction ==

The [[Report view|Report view]] is a panel that shows text messages from LabRPS processes and tools. It is available in the menu {{MenuCommand|{{StdMenu|[[Std View Menu|View]]}} → Panels → Report view}}.

Certain properties of this panel, like color of the text and whether to display it automatically on warnings or errors, can be configured in the {{MenuCommand|General → Report view}} tab of the [[Preferences_Editor#Report_view|Preferences Editor]].

[[File:LabRPS_Report_view.png|800px]]

{{Caption|The report view showing messages when LabRPS has just started.}}

== Messages ==

{{Emphasis|See also:}} [[Console API|Console API]], and [[LabRPS Scripting Basics|LabRPS Scripting Basics]].

The report view displays messages from the internal LabRPS {{incode|Console}} class.
* {{incode|LabRPS.Console.PrintMessage("text")}}, print any sort of informative message, that doesn't imply any misbehavior; for example, print the coordinates of points, the result of a distance calculation, the number of vertices in a shape, etc. By default, in black color.
* {{incode|LabRPS.Console.PrintWarning("text")}}, print messages that are intended to warn the user about strange behavior in the application. Warnings should be shown when some functionality is missing but the software still works acceptably. By default, in yellow color.
* {{incode|LabRPS.Console.PrintError("text")}}, print messages that are intended to be error messages, that is, when a critical component is missing that makes a certain operation fail. By default, in red color.
* {{incode|LabRPS.Console.PrintLog("text")}}, print messages that are going into the logs. These messages could be anything that is valuable to troubleshoot a problem in the future by reading the logs, for example, starting or closing a workbench. By default, in blue color.

These functions can be used from the [[Python console|Python console]] directly, or from [[Macros|macros]] and custom workbenches.

[[File:LabRPS_Report_view_example.png|800px]]

{{Caption|Example messages in the report view: a general message, a warning, an error, and a logged message.}}

== Actions ==

Right clicking the report view opens a context menu with the following commands:
* {{MenuCommand|Options}}:
** {{MenuCommand|Display message types}}: see [[Preferences_Editor#Output_window|Preferences Editor]].
** {{MenuCommand|Show output window on}}: idem.
** {{MenuCommand|Redirect Python output}}: idem.
** {{MenuCommand|Redirect Python errors}}: idem.
** {{MenuCommand|Go to end}}: if checked the report view will scroll to the bottom when a new message is added.
* {{MenuCommand|Copy}}: stores the selected text in the clipboard for later pasting; it is disabled if nothing is selected.
* {{MenuCommand|Select all}}: selects all text in the report view.
* {{MenuCommand|Clear}}: erases all messages in the report view. This is useful if you want to troubleshoot a tool that prints messages to the report view, and want to be sure there are no old messages from previous tools.
* {{MenuCommand|Save As}}: save the messages in the report view to a text file.

{{Interface navi}}
{{Std Base navi}}
{{Userdocnavi}}

Report view - Revision history

LabRPS: /* Messages */