class MToolsInfo

Jump to documentation

public members:

static void	setDirtyFlag (const MPxContext &context)
static void	resetDirtyFlag ()
static bool	isDirty ()

Documentation

Description

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.

Functions

void MToolsInfo:: setDirtyFlag (const MPxContext &context)

Description

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.

Arguments

• context the context whose value has changed

Return Value

• none

void MToolsInfo:: resetDirtyFlag ()

Description

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

Arguments

• none

Return Value

• none

bool MToolsInfo:: isDirty ()

Description

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

Arguments

• none

Return Value

• true
• false

This class has no child classes.