DrawingToolParams Class Reference

The DrawingToolParams JavaScript class. Set or unset the "apply on all drawings" setting of the DrawingTools methods. More...

Public Slots

void setRange (int)
 Returns the current progress update. More...
 
void setProgress (int)
 Sets the maximum position that pulses will generate. More...
 
void canceled ()
 Called when progress updates. Emits signal "pulse". More...
 
bool wasCanceled ()
 Signals cancelation of the processing. More...
 

Signals

void pulse (int, int)
 Returns true if a cancelation signal was received. More...
 

Public Member Functions

bool applyAllDrawings ()
 
void setApplyAllDrawings (bool b)
 
int range ()
 
int progress ()
 Returns the maximum position that pulses will generate. More...
 

Properties

bool applyAllDrawings
 
int range
 
int progress
 
bool wasCanceled
 

Detailed Description

The DrawingToolParams JavaScript class. Set or unset the "apply on all drawings" setting of the DrawingTools methods.

Member Function Documentation

◆ applyAllDrawings()

bool DrawingToolParams::applyAllDrawings ( )

◆ canceled

void DrawingToolParams::canceled ( )
slot

Called when progress updates. Emits signal "pulse".

◆ progress()

int DrawingToolParams::progress ( )

Returns the maximum position that pulses will generate.

◆ pulse

void DrawingToolParams::pulse ( int  ,
int   
)
signal

Returns true if a cancelation signal was received.

◆ range()

int DrawingToolParams::range ( )

◆ setApplyAllDrawings()

void DrawingToolParams::setApplyAllDrawings ( bool  b)

◆ setProgress

void DrawingToolParams::setProgress ( int  )
slot

Sets the maximum position that pulses will generate.

◆ setRange

void DrawingToolParams::setRange ( int  )
slot

Returns the current progress update.

◆ wasCanceled

bool DrawingToolParams::wasCanceled ( )
slot

Signals cancelation of the processing.

Property Documentation

◆ applyAllDrawings

bool DrawingToolParams::applyAllDrawings
readwrite

◆ progress

int DrawingToolParams::progress
readwrite

◆ range

int DrawingToolParams::range
readwrite

◆ wasCanceled

bool DrawingToolParams::wasCanceled
read