Detailed Description

Feedback line.

The MFeedbackLine class is used to display information back to the user. The format for the feedback line which indicates the number and type of the arguments should be set with the setFormat method. The values of the arguments should be set using the setValue method.

#include <MFeedbackLine.h>

List of all members.

Static Public Member Functions
static MStatus	setFormat (const MString &format)
	Set the format string for the feedback line.
static MStatus	setTitle (const MString &title)
	Set the title string.
static MStatus	setValue (short index, double value)
	Set the value of a given index in the feedback line.
static void	clear ()
	Clear whatever is showing in the feedback line.
static bool	showFeedback ()
	Return whether or not the feedback line is is supposed to be displaying data.
static void	setShowFeedback (bool showFeedback)
	Set whether the feedback line is supposed to be displaying data.
static const char *	className ()
	Returns the name of this class. Search for all occurrences

Member Function Documentation

MStatus setFormat ( const MString & format ) [static]

Search for all occurrences

Set the format string for the feedback line.

The format begins with a format specifier "^" followed by the format size, format decimal character ".", decimal size, and format type. For example: the format "^6.3f" which specifies that there is going to be one value given, it is a float, with 3 decimal places shown.

Parameters:

[in] format the format string for the feedback line

Returns: