class MFeedbackLine

Jump to documentation

public members:

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 )

Documentation

Description

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.

Functions

MStatus MFeedbackLine:: setFormat (const MString &format)

Description

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.

Arguments

• format the format string for the feedback line

Return Value

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

MStatus MFeedbackLine:: setTitle (const MString &title)

Description

Set the title string.

Arguments

• title the title string

Return Value

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

MStatus MFeedbackLine:: setValue (short index, double value)

Description

Set the value of a given index in the feedback line

Arguments

• index the index whose value should be set
• value the value of the index

Return Value

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

void MFeedbackLine:: clear ()

Description

Clear whatever is showing in the feedback line.

Return Value

• none

bool MFeedbackLine:: showFeedback ()

Description

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

Return Value

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

void MFeedbackLine:: setShowFeedback (bool showFeedback )

Description

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

Arguments

• showFeedback whether or not the feedback line should display data

Return Value

• none

This class has no child classes.