MFeedbackLine Class Reference
[OpenMayaUI - API module for user interface]

#include <MFeedbackLine.h>

List of all members.

---

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.

Static Public Member Functions
static MStatus	setFormat (const MString &format)
static MStatus	setTitle (const MString &title)
static MStatus	setValue (short index, double value)
static void	clear ()
static bool	showFeedback ()
static void	setShowFeedback (bool showFeedback)

---

Member Function Documentation

MStatus MFeedbackLine::setFormat

(

const MString &

format

)

[static]

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:

• MS::kSuccess operation successful
• MS::kInsufficientMemory insufficient memory

Examples:

moveNumericTool.cpp.

MStatus MFeedbackLine::setTitle

(

const MString &

title

)

[static]

Set the title string.

Parameters:

[in]

title

the title string

Returns:

• MS::kSuccess operation successful
• MS::kInsufficientMemory insufficient memory

Examples:

moveNumericTool.cpp.

MStatus MFeedbackLine::setValue	(	short	index,
		double	value
	)			[static]

Set the value of a given index in the feedback line

Parameters:

[in]	index	the index whose value should be set
[in]	value	the value of the index

Returns:

• MS::kSuccess operation successful
• MS::kInsufficientMemory insufficient memory

Examples:

moveNumericTool.cpp.

void MFeedbackLine::clear

(

)

[static]

Clear whatever is showing in the feedback line.

bool MFeedbackLine::showFeedback

(

)

[static]

Return whether or not the feedback line is is supposed to be displaying data.

Returns:

• true the feedback line is displaying data
• false the feedback line is not displaying data

void MFeedbackLine::setShowFeedback

(

bool

showFeedback

)

[static]

Set whether the feedback line is supposed to be displaying data.

Parameters:

[in]

showFeedback

whether or not the feedback line should display data