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

#include <MToolsInfo.h>

List of all members.

---

Detailed Description

Tool information.

MToolsInfo is a caretaker class used to keep track of the state of the current tool property sheet. The tool writer should make sure to call the setDirtyFlag method when any of the values are modified. The dirty flag is used to indicate that the UI needs to be updated when the value of a tool property sheet option has changed.

Static Public Member Functions
static void	setDirtyFlag (const MPxContext &context)
static void	resetDirtyFlag ()
static bool	isDirty ()

---

Member Function Documentation

void MToolsInfo::setDirtyFlag

(

const MPxContext &

context

)

[static]

This method should be called by a tool when the value of a tool property sheet option has changed. The dirty flag will only be set if this is the current tool.

Parameters:

[in]

context

the context whose value has changed

Examples:

helixTool.cpp.

void MToolsInfo::resetDirtyFlag

(

)

[static]

This method resets the dirty flag, such that the state becomes clean.

bool MToolsInfo::isDirty

(

)

[static]

This method returns whether or not the dirty flag is set.

Returns:

true if the dirty flag is set, false otherwise.