The ToolProperties JavaScript global object. Controls the Tool Properties. More...

Public Slots
General options
void	setApplyAllArts (bool b)
	Sets the Apply to Line Art and Colour Art checkbox state to b; in the Select Tool Options. More...

Brush Options
void	setDrawBehindMode (bool b)
	Toggles the Draw Behind mode of the Brush tool. More...

void	setAutoCreateColourArt (bool b)
	Sets the auto create colour art mode of the current tool to b if applicable. More...

void	setAutoFlattenMode (bool b)
	Sets the auto flatten mode if applicable. More...

void	setRespectProtectedColourMode (bool b)
	Sets the Respect Protected Colour mode if applicable. More...

void	setDrawingMagnifierMode (bool b)
	Sets the magnifier mode. More...

Drawing selection
void	setMarkeeMode (bool b)
	Sets the select tool mode selection to Lasso or Marquee. If b is true, the mode will be set to Marquee. More...

void	setSnapping (bool contour, bool align, bool grid)
	Sets the snapping mode for the contour, align and grid mode all to the modes specified in argument. More...

void	setPermanentSelectionMode (bool b)
	Toggles the permanent selection mode. More...

void	setSelectByColourMode (bool b)
	Sets the select by colour mode of the Select tool . More...

Contour editor tool options
void	setShowHideAllContourEditingControls (bool b)
	Toggles whether contour editor shows all tool controls or not. More...

Transform tool options
void	setPegSelectionMode (bool b)
	Sets the selection mode of the transform tool to peg mode if b is true. More...

void	setTransformToolSnapping (bool align, bool grid)
	Sets the align and grid snapping modes of the transform tool. More...

void	setShowHideManipulatorControls (bool b)
	Hides the transform tool manipulator if b is true. More...

void	setDisablePivotControl (bool b)
	Disables the pivot Transform tool manipulator if b is true. A pivot control will still be displayed but will not be manipulatable. More...

paint options
void	setPaintAndRemoveTextureMode (bool b)
	Instruct the paint tool to remove the opacity texture if b is true. More...

void	setUsedStoredColourGradientMode (bool b)
	Instruct the paint tool to use the gradient/texture matrix stored in the tool if b is true. More...

void	setPaintToolShouldSelectPaintedZonesAfterPainting (bool b)
	If b is true, the paint tool will select the newly painted zone after painting. This can be useful if you want to edit a gradient on multiple zones after painting. More...

void	setApplyAllDrawings (bool b)
	Sets the apply all drawing mode to b. More...

void	setApplyAllVisibleDrawings (bool b)
	Sets the apply all visible drawing mode to b. More...

void	setAutogapClosingMode (int m)
	Sets the auto gap closing mode to m. Mode can be 0, 1, 2 or 3, which corresponds to No Gap, Small, Medium and Large. More...

Rect and ellipse options
void	setAutoFillInside (bool b)
	Sets the auto fill mode of Rectangle and Ellipse tools to b. More...

Cutter options
void	setGestureCutter (bool b)
	Set the cutter's gesture mode to b. More...

void	setMouseGestureBreakeMode (bool b)
	Set the cutter's gesture break mode to b. More...

ink options
void	setShowInkableLines (bool b)
	Shows the inkable lines if b is true. More...

void	setSmartInkLineConnectionMode (bool b)
	Sets the smart ink line connection mode to b. More...

void	setInkLineSelectionMode (bool b)
	Instructs the ink tool to select inked lines after inking if b is true. More...

void	setBringInkedLinesOnTop (bool b)
	Instructs the ink tool to bring inked lines on top after inking if b is true. More...

void	setInkJoinMode (String joinType)
	Sets the join mode of the inked lines to be joinType. Join type can be one of: "ROUND_JOIN", "MITER_JOIN" or "BEVEL_JOIN". More...

general option
void	setPencilTipMode (String pencilTip)
	Sets the pencil tip shape used by the eraser, cutter, and ink tools whenever an existing pencil line gets split by the tool. More...

line tool options
void	setLineAutoGapClosing (bool b)
	Toggles the auto gap closing functionality for the line and pencil tools. When the auto gap functionality is on, the line or pencil tool tries to add a stroke line to cover the gap between the newly created line and any existing line. More...

int	getAutoGapClosingMode ()
	Gets the auto gap closing mode property. More...

bool	getSnapToContour ()
	Gets the snap to contour property. More...

void	setSnapToContour (bool b)
	Sets the snap to contour property. More...

bool	getSnapToBoundingBoxes ()
	Gets the snap to bounding boxes property. More...

void	setSnapToBoundingBoxes (bool b)
	Sets the snap to bounding boxes property. More...

bool	getSnapToGrid ()
	Gets the snap to grid property. More...

void	setSnapToGrid (bool b)
	Sets the snap to grid property. More...

bool	getMergeWithTopLayer ()
	Gets the merge with top layer property. More...

void	setMergeWithTopLayer (bool b)
	Sets the merge with top layer property. More...

bool	getAutoFlattenMode ()
	Gets the auto flatten mode property. More...

bool	getRespectStickyColor ()
	Gets the respect sticky color property. More...

bool	getPaintDestroyTexture ()
	Gets the paint destroy texture property. More...

void	setPaintDestroyTexture (bool b)
	Sets the paint destroy texture property. More...

bool	getCreateColorArtOnBrush ()
	Gets the create color art on brush property. More...

void	setCreateColorArtOnBrush (bool b)
	Sets create color art on brush property. More...

bool	getDrawBehind (String toolName)
	Gets the draw behind property of the given tool. More...

void	setDrawBehind (String toolName, bool b)
	Sets the draw behind property of the given tool. More...

int	getBrushMode ()
	Gets the brush mode property. More...

void	setBrushMode (int mode)
	Sets the brush mode property. More...

bool	getShowOtherDrawingThumbnail ()
	Gets the show other drawing thumbnail property. More...

void	setShowOtherDrawingThumbnail (bool b)
	Sets the show other drawing thumbnail property. More...

bool	getPreventDrawing ()
	Gets the prevent drawing property. More...

void	setPreventDrawing (bool b)
	Sets the prevent drawing property. More...

bool	getPreventScenePlanning ()
	Gets the prevent scene planning property. More...

void	setPreventScenePlanning (bool b)
	Sets the prevent scene planning property. More...

bool	getShowAllContourEditingControls ()
	Gets the show all conotur editing controls property. More...

bool	getKeepProportions (String toolName)
	Gets keep proportions property of the given tool. More...

void	setKeepProportions (String toolName, bool b)
	Sets the keep proportions property of the given tool. More...

int	getPaintMode ()
	Gets the paint mode property. More...

void	setPaintMode (int mode)
	Sets the paint mode property. More...

int	getBitmapPaintSourceArt ()
	Gets the bitmap paint source art property. More...

void	setBitmapPaintSourceArt (int mode)
	Sets the bitmap paint source art property. More...

int	getBitmapPaintAlpha ()
	Gets the bitmap paint alpha property. More...

void	setBitmapPaintAlpha (int value)
	Sets the bitmap paint alpha property. More...

int	getBitmapPaintColorTolerance ()
	Gets the bitmap paint color tolerance property. More...

void	setBitmapPaintColorTolerance (int value)
	Sets the bitmap paint color tolerance property. More...

int	getBitmapPaintMaxOverlap ()
	Gets the bitmap paint max overlap property. More...

void	setBitmapPaintMaxOverlap (int value)
	Sets the bitmap paint max overlap property. More...

bool	getLineMode (String toolName)
	Gets the line mode property of the given tool. More...

void	setLineMode (String toolName, bool b)
	Sets the line mode property of the given tool. More...

bool	getSnapMode (String toolName)
	Gets the snap mode property of the given tool. More...

void	setSnapMode (String toolName, bool b)
	Sets the snap mode property of the given tool. More...

bool	getPermanentSelectionMode ()
	Gets the permanent selection mode property. More...

int	getElementMode ()
	Gets the element mode property. More...

void	setElementMode (int mode)
	Sets the element mode property. More...

int	getPaintElementMode ()
	Gets the paint element mode property. More...

void	setPaintElementMode (int mode)
	Sets paint element mode property. More...

int	getFrameMode ()
	Gets the frame mode property. More...

void	setFrameMode (int mode)
	Sets the frame mode property. More...

int	getAntialiasingMode ()
	Gets the antialiasing mode property. More...

void	setAntialiasingMode (int mode)
	Sets the antialiasing mode property. More...

bool	getApplyToAllLayers ()
	Gets the apply to all layers property. More...

void	setApplyToAllLayers (bool b)
	Sets the apply to all layers property. More...

bool	getShowAdvancedControls ()
	Gets the show advanced controls property. More...

void	setShowAdvancedControls (bool b)
	Sets the show advanced controls property. More...

bool	getAutoFillInside (String toolName)
	Gets the auto fill inside property of the given tool. More...

void	setAutoFillInside (String toolName, bool b)
	Sets the auto fill inside property of the given tool. More...

bool	getTrimExtraLines (String toolName)
	Gets the trim extra lines property of the given tool. More...

void	setTrimExtraLines (String toolName, bool b)
	Sets the trim extra lines property of the given tool. More...

bool	getTrimExtraLinesMatch (String toolName)
	Gets the trim extra lines match property of the given tool. More...

void	setTrimExtraLinesMatch (String toolName, bool b)
	Sets the trim extra lines match property of the given tool. More...

bool	getLockColor (String toolName)
	Gets the lock color property of the given tool. More...

void	setLockColor (String toolName, bool b)
	Sets the lock color property of the given tool. More...

bool	getZoomInMode ()
	Gets the zoom in mode property. More...

void	setZoomInMode (bool b)
	Sets the zoom in mode property. More...

bool	getSelectByColor ()
	Gets the select by color property. More...

void	setSelectByColor (bool b)
	Sets the select by color property. More...

bool	getSelectionIsLasso ()
	Gets the selection is lasso property. More...

void	setSelectionIsLasso (bool b)
	Sets the selection is lasso property. More...

bool	getBoundingBoxMovable ()
	Gets the bounding box movable property. More...

void	setBoundingBoxMovable (bool b)
	Sets the bounding box movable property. More...

bool	getChangeSymbolPivotOnAllFrames ()
	Gets the change symbol pivot on all frames property. More...

void	setChangeSymbolPivotOnAllFrames (bool b)
	Sets the change symbol pivot on all frames property. More...

bool	getAutoGapLineClosing ()
	Gets the auto gap line closing property. More...

void	setAutoGapLineClosing (bool b)
	Sets the auto gap line closing property. More...

int	getSelectionMode ()
	Gets the selection mode property. More...

void	setSelectionMode (int mode)
	Sets the selection mode property. More...

int	getControlPointSelectionMode ()
	Gets the control point selection mode property. More...

void	setControlPointSelectionMode (int mode)
	Sets the control point selection mode property. More...

int	getToolResolutionWidth ()
	Gets the tool resolution width property. More...

void	setToolResolutionWidth (int width)
	Sets the tool resolution width property. More...

int	getToolResolutionHeight ()
	Gets the tool resolution height property. More...

void	setToolResolutionHeight (int height)
	Sets the tool resolution height property. More...

bool	getHideManipulatorControls ()
	Gets hide manipulator controls property. More...

void	setHideManipulatorControls (bool b)
	Sets the hide manipulator controls property. More...

bool	getHideTranslateManipulatorControls ()
	Gets the hide translate manipulator controls property. More...

void	setHideTranslateManipulatorControls (bool b)
	Sets the hide translate manipulator controls property. More...

bool	getHideScaleManipulatorControls ()
	Gets the hide scale manipulator controls property. More...

void	setHideScaleManipulatorControls (bool b)
	Sets the hide scale manipulator controls property. More...

bool	getHideRotateManipulatorControls ()
	Gets the hide rotate manipulator controls property. More...

void	setHideRotateManipulatorControls (bool b)
	Sets the hide rotate manipulator controls property. More...

bool	getDisablePivotManipulatorControl ()
	Gets the hide pivot manipulator controls property. More...

void	setDisablePivotManipulatorControl (bool b)
	Sets the hide pivot manipulator controls property. More...

bool	getSnapTo3DMode ()
	Gets the snap to 3D mode property. More...

void	setSnapTo3DMode (bool b)
	Sets the snap to 3D mode property. More...

int	getSmoothSelector ()
	Gets the smooth selector property. More...

void	setSmoothSelector (int mode)
	Sets the smooth selector property. More...

bool	getSmoothShowPoints ()
	Gets the smooth show points property. More...

void	setSmoothShowPoints (bool b)
	Sets the smooth show points property. More...

bool	getCutEnableCutterGesture ()
	Gets the enable cutter gesture property. More...

void	setCutEnableCutterGesture (bool b)
	Sets the enable cutter gesture property. More...

bool	getCutEnableBreakGesture ()
	Gets the enable break gesture property. More...

void	setCutEnableBreakGesture (bool b)
	Sets the enable break gesture property. More...

double	getStrokeSmoothValue ()
	Gets the stroke smooth value property. More...

void	setStrokeSmoothValue (double d)
	Sets the stroke smooth value property. More...

bool	getLockPenStyleWidth (String toolName)
	Gets the lock pen style width property of the given tool. More...

void	setLockPenStyleWidth (String toolName, bool b)
	Sets the lock pen style width property of the given tool. More...

bool	getLineBuildingMode ()
	Gets the line building mode property. More...

void	setLineBuildingMode (bool b)
	Sets the line building mode property. More...

bool	getThicknessAdjustMode ()
	Gets the thickness adjust mode property. More...

void	setThicknessAdjustMode (bool b)
	Sets the thickness adjust mode property. More...

bool	getLinePushingMode ()
	Gets the line pushing mode property. More...

void	setLinePushingMode (bool b)
	Sets the line pushing mode property. More...

int	getTextFont ()
	Gets the text font property. More...

void	setTextFont (int font)
	Sets the text font property. More...

int	getTextSize ()
	Gets the text size property. More...

void	setTextSize (int size)
	Sets the text size property. More...

int	getTextStyle ()
	Gets the text style property. More...

void	setTextStyle (int style)
	Sets the text style property. More...

int	getTextAlignment ()
	Gets the text alignment property. More...

void	setTextAlignment (int alignment)
	Sets the text alignment property. More...

bool	getAutoKerning ()
	Gets the text auto kerning property. More...

void	setAutoKerning (bool b)
	Sets the text auto kerning property. More...

int	getTextKerning ()
	Gets the text kerning property. More...

void	setTextKerning (int kerning)
	Sets the text kerning property. More...

int	getTextIndent ()
	Gets the text indent property. More...

void	setTextIndent (int indent)
	Sets the text indent property. More...

int	getTextLineSpace ()
	Gets the text line space property. More...

void	setTextLineSpace (int lineSpace)
	Sets the text line space property. More...

bool	getRetraceMode ()
	Gets the retrace mode property. More...

void	setRetraceMode (bool b)
	Sets the retrace mode property. More...

double	getRetraceOffsetMax ()
	Gets the maximum retrace offset property. More...

void	setRetraceOffsetMax (double max)
	Sets the maximum retrace offset property. More...

double	getRetraceTiltMax ()
	Gets the maximum retrace tilt property. More...

void	setRetraceTiltMax (double max)
	Sets the maximum retrace tilt property. More...

double	getRetraceProbability ()
	Gets the retrace probability property. More...

void	setRetraceProbability (double probability)
	Sets the retrace probability property. More...

double	getRetraceNoiseMax ()
	Gets the maximum retrace noise property. More...

void	setRetraceNoiseMax (double max)
	Sets the maximum retrace noise property. More...

double	getSmoothPenStyleMin ()
	Gets the smooth pen style minimum property. More...

void	setSmoothPenStyleMin (double value)
	Sets the smooth pen style minimum property. More...

double	getSmoothPenStyleMinRatio ()
	Gets the smooth pen style minimum ratio property. More...

void	setSmoothPenStyleMinRatio (double value)
	Sets the smooth pen style minimum ratio property. More...

double	getSmoothPenStyleMax ()
	Gets the smooth pen style maximum property. More...

void	setSmoothPenStyleMax (double value)
	Sets the smooth pen style maximum property. More...

double	getSmoothPenStyleCenterSmooth ()
	Gets the smooth pen style center smooth property. More...

void	setSmoothPenStyleCenterSmooth (double value)
	Sets the smooth pen style center smooth property. More...

bool	getDrawingMagnifier ()
	Gets the drawing magnifier property. More...

void	setDrawingMagnifier (bool b)
	Sets the drawing magnifier property. More...

bool	getInkSelectionMode ()
	Gets the ink selection mode property. More...

void	setInkSelectionMode (bool b)
	Sets the ink selection mode property. More...

bool	getInkIntelligentMode ()
	Gets the ink intelligent mode property. More...

void	setInkIntelligentMode (bool b)
	Sets the ink intelligent mode property. More...

bool	getInkRaiseMode ()
	Gets the ink raise mode property. More...

void	setInkRaiseMode (bool b)
	Sets the ink raise mode property. More...

bool	getInkShowInkableLines ()
	Gets the show inkable lines property. More...

void	setInkShowInkableLines (bool b)
	Sets the show inkable lines property. More...

int	getInkJoinMode ()
	Gets the ink join mode property. More...

void	setInkJoinMode (int mode)
	Sets the ink join mode property. More...

bool	getSelectAfterPaintOrInk ()
	Gets the select after paint or ink property. More...

void	setSelectAfterPaintOrInk (bool b)
	Sets the select after paint or ink property. More...

int	getDrawingType ()
	Gets the drawing type property. More...

void	setDrawingType (int mode)
	Sets the drawing type property. More...

int	getPerspectiveMode ()
	Gets the perspective mode property. More...

void	setPerspectiveMode (int mode)
	Sets the perspective mode property. More...

int	getPencilTipMode (String toolName)
	Gets the pencil tip mode property of the given tool. More...

void	setPencilTipMode (String toolName, int mode)
	Sets the pencil tip mode property of the given tool. More...

QScriptValue	getAllGlobalProperties ()
	Gets all of the global properties. More...

void	setGlobalProperties (QScriptValue newValues)
	Sets the global properties found in the parameter. More...

QScriptValue	getAllToolSpecificProperties (String toolName)
	Gets all of the specific properties of the given tool. More...

void	setAllToolSpecificProperties (String toolName, QScriptValue newValues)
	Sets the specific properties of the given tool. More...

QScriptValue	toolNames ()
	Gets all of the available tools. More...

QScriptValue	getToolIdFromName (String toolName)

Detailed Description

The ToolProperties JavaScript global object. Controls the Tool Properties.

This object controls most of the tool properties that can be found on the Tool Properties Panel. The Tool Presets view must have been loaded for these function to be available.

Member Function Documentation

◆ getAllGlobalProperties

QScriptValue ToolProperties::getAllGlobalProperties ( )

slot

Gets all of the global properties.

A global property is a tool property that is unique to a tool, or is set globally for all tools.

Returns: an object storing the values of all the global tool properties.

◆ getAllToolSpecificProperties

QScriptValue ToolProperties::getAllToolSpecificProperties ( String toolName )

slot

Gets all of the specific properties of the given tool.

Parameters

toolName : The tool to get the properties of.

Returns: an object storing the values of all the specified tool's properties.

◆ getAntialiasingMode

int ToolProperties::getAntialiasingMode ( )

slot

Gets the antialiasing mode property.

Possible values are: AntialiasingOff = 0 AntialiasingOn = 1

Returns: the antialiasing mode.

◆ getApplyToAllLayers

bool ToolProperties::getApplyToAllLayers ( )

slot

Gets the apply to all layers property.

Returns: the apply to all layers flag.

◆ getAutoFillInside

bool ToolProperties::getAutoFillInside ( String toolName )

slot

Gets the auto fill inside property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the auto fill inside flag of the given tool.

◆ getAutoFlattenMode

bool ToolProperties::getAutoFlattenMode ( )

slot

Gets the auto flatten mode property.

Returns: the auto flatten mode flag.

◆ getAutoGapClosingMode

int ToolProperties::getAutoGapClosingMode ( )

slot

Gets the auto gap closing mode property.

Possible values are: NONE = 0 SMALL = 1 MEDIUM = 2 LARGE = 3

Returns: the auto gap closing mode value.

◆ getAutoGapLineClosing

bool ToolProperties::getAutoGapLineClosing ( )

slot

Gets the auto gap line closing property.

Returns: the auto gap line closing flag.

◆ getAutoKerning

bool ToolProperties::getAutoKerning ( )

slot

Gets the text auto kerning property.

Returns: the text auto kerning flag.

◆ getBitmapPaintAlpha

int ToolProperties::getBitmapPaintAlpha ( )

slot

Gets the bitmap paint alpha property.

Returns: the bitmap paint alpha value.

◆ getBitmapPaintColorTolerance

int ToolProperties::getBitmapPaintColorTolerance ( )

slot

Gets the bitmap paint color tolerance property.

Returns: the bitmap paint color tolerance value.

◆ getBitmapPaintMaxOverlap

int ToolProperties::getBitmapPaintMaxOverlap ( )

slot

Gets the bitmap paint max overlap property.

Returns: the bitmap paint max overlap value.

◆ getBitmapPaintSourceArt

int ToolProperties::getBitmapPaintSourceArt ( )

slot

Gets the bitmap paint source art property.

Possible values are: BitmapPaintSourceUnderlayArt = 0 BitmapPaintSourceColorArt = 1 BitmapPaintSourceLineArt = 2 BitmapPaintSourceOverlayArt = 3 BitmapPaintSourceCurrentArt = 255

Returns: the bitmap paint source art mode.

◆ getBoundingBoxMovable

bool ToolProperties::getBoundingBoxMovable ( )

slot

Gets the bounding box movable property.

Returns: the bounding box movable flag.

◆ getBrushMode

int ToolProperties::getBrushMode ( )

slot

Gets the brush mode property.

Possible values are: BRUSH = 0 REPAINT_BRUSH = 1 DRAWBEHIND_BRUSH = 2

Returns: the brush mode property value.

◆ getChangeSymbolPivotOnAllFrames

bool ToolProperties::getChangeSymbolPivotOnAllFrames ( )

slot

Gets the change symbol pivot on all frames property.

Returns: the change symbol pivot on all frames flag.

◆ getControlPointSelectionMode

int ToolProperties::getControlPointSelectionMode ( )

slot

Gets the control point selection mode property.

Possible values are: Drawing = 0 ControlPoint = 1

Returns: the control point selection mode.

◆ getCreateColorArtOnBrush

bool ToolProperties::getCreateColorArtOnBrush ( )

slot

Gets the create color art on brush property.

Returns: the create color art on brush flag.

◆ getCutEnableBreakGesture

bool ToolProperties::getCutEnableBreakGesture ( )

slot

Gets the enable break gesture property.

Returns: the enable break gesture flag.

◆ getCutEnableCutterGesture

bool ToolProperties::getCutEnableCutterGesture ( )

slot

Gets the enable cutter gesture property.

Returns: the enable cutter gesture flag.

◆ getDisablePivotManipulatorControl

bool ToolProperties::getDisablePivotManipulatorControl ( )

slot

Gets the hide pivot manipulator controls property.

Returns: the hide pivot manipulator controls flag.

◆ getDrawBehind

bool ToolProperties::getDrawBehind ( String toolName )

slot

Gets the draw behind property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the draw behind flag of the given tool.

◆ getDrawingMagnifier

bool ToolProperties::getDrawingMagnifier ( )

slot

Gets the drawing magnifier property.

Returns: the drawing magnifier flag.

◆ getDrawingType

int ToolProperties::getDrawingType ( )

slot

Gets the drawing type property.

Possible values are: DrawingVector = 0 DrawingBitmap = 1

Returns: the drawing type.

◆ getElementMode

int ToolProperties::getElementMode ( )

slot

Gets the element mode property.

Possible values are: SelectedElements = 0 VisibleElements = 1 LinkedElements = 2

Returns: the element mode.

◆ getFrameMode

int ToolProperties::getFrameMode ( )

slot

Gets the frame mode property.

Possible values are: CurrentFrame = 0 AllFrames = 1 OnionSkinFrames = 2

Returns: the frame mode.

◆ getHideManipulatorControls

bool ToolProperties::getHideManipulatorControls ( )

slot

Gets hide manipulator controls property.

Returns: the hide manipulator controls flag.

◆ getHideRotateManipulatorControls

bool ToolProperties::getHideRotateManipulatorControls ( )

slot

Gets the hide rotate manipulator controls property.

Returns: the hide rotate manipulator controls flag.

◆ getHideScaleManipulatorControls

bool ToolProperties::getHideScaleManipulatorControls ( )

slot

Gets the hide scale manipulator controls property.

Returns: the hide scale manipulator controls flag.

◆ getHideTranslateManipulatorControls

bool ToolProperties::getHideTranslateManipulatorControls ( )

slot

Gets the hide translate manipulator controls property.

Returns: the hide translate manipulator controls flag.

◆ getInkIntelligentMode

bool ToolProperties::getInkIntelligentMode ( )

slot

Gets the ink intelligent mode property.

Returns: the ink intelligent mode.

◆ getInkJoinMode

int ToolProperties::getInkJoinMode ( )

slot

Gets the ink join mode property.

Possible values are: UNDEFINED_JOIN = 0 ROUND_JOIN = 1 MITER_JOIN = 2 BEVEL_JOIN = 3

Returns: the ink join mode.

◆ getInkRaiseMode

bool ToolProperties::getInkRaiseMode ( )

slot

Gets the ink raise mode property.

Returns: the ink raise mode.

◆ getInkSelectionMode

bool ToolProperties::getInkSelectionMode ( )

slot

Gets the ink selection mode property.

Returns: the ink selection mode.

◆ getInkShowInkableLines

bool ToolProperties::getInkShowInkableLines ( )

slot

Gets the show inkable lines property.

Returns: the show inkable lines flag.

◆ getKeepProportions

bool ToolProperties::getKeepProportions ( String toolName )

slot

Gets keep proportions property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the keep proportions flag of the given tool.

◆ getLineBuildingMode

bool ToolProperties::getLineBuildingMode ( )

slot

Gets the line building mode property.

Returns: the line building mode.

◆ getLineMode

bool ToolProperties::getLineMode ( String toolName )

slot

Gets the line mode property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the line mode flag of the given tool.

◆ getLinePushingMode

bool ToolProperties::getLinePushingMode ( )

slot

Gets the line pushing mode property.

Returns: the line pushing mode.

◆ getLockColor

bool ToolProperties::getLockColor ( String toolName )

slot

Gets the lock color property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the lock color flag of the given tool.

◆ getLockPenStyleWidth

bool ToolProperties::getLockPenStyleWidth ( String toolName )

slot

Gets the lock pen style width property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the lock pen style width flag of the given tool.

◆ getMergeWithTopLayer

bool ToolProperties::getMergeWithTopLayer ( )

slot

Gets the merge with top layer property.

Returns: the merge with top layer flag.

◆ getPaintDestroyTexture

bool ToolProperties::getPaintDestroyTexture ( )

slot

Gets the paint destroy texture property.

Returns: the paint destroy texture flag.

◆ getPaintElementMode

int ToolProperties::getPaintElementMode ( )

slot

Gets the paint element mode property.

Possible values are: SelectedElements = 0 VisibleElements = 1 LinkedElements = 2

Returns: the paint element mode.

◆ getPaintMode

int ToolProperties::getPaintMode ( )

slot

Gets the paint mode property.

Possible values are: PAINT = 0 UNPAINT = 1 REPAINT = 2 PAINT_UNPAINTED = 3

Returns: the paint mode.

◆ getPencilTipMode

int ToolProperties::getPencilTipMode ( String toolName )

slot

Gets the pencil tip mode property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the pencil tip mode of the given tool.

◆ getPermanentSelectionMode

bool ToolProperties::getPermanentSelectionMode ( )

slot

Gets the permanent selection mode property.

Returns: the permanent selection mode.

◆ getPerspectiveMode

int ToolProperties::getPerspectiveMode ( )

slot

Gets the perspective mode property.

Possible values are: PerspectiveMode = 0 LatticeMode = 1

Returns: the perspective mode.

◆ getPreventDrawing

bool ToolProperties::getPreventDrawing ( )

slot

Gets the prevent drawing property.

Returns: the prevent drawing flag.

◆ getPreventScenePlanning

bool ToolProperties::getPreventScenePlanning ( )

slot

Gets the prevent scene planning property.

Returns: the prevent drawing flag.

◆ getRespectStickyColor

bool ToolProperties::getRespectStickyColor ( )

slot

Gets the respect sticky color property.

Returns: the respect sticky color flag.

◆ getRetraceMode

bool ToolProperties::getRetraceMode ( )

slot

Gets the retrace mode property.

Returns: the retrace mode.

◆ getRetraceNoiseMax

double ToolProperties::getRetraceNoiseMax ( )

slot

Gets the maximum retrace noise property.

Returns: the maximum retrace noise value.

◆ getRetraceOffsetMax

double ToolProperties::getRetraceOffsetMax ( )

slot

Gets the maximum retrace offset property.

Returns: the maximum retrace offset value.

◆ getRetraceProbability

double ToolProperties::getRetraceProbability ( )

slot

Gets the retrace probability property.

Returns: the retrace probability value.

◆ getRetraceTiltMax

double ToolProperties::getRetraceTiltMax ( )

slot

Gets the maximum retrace tilt property.

Returns: the maximum retrace tilt value.

◆ getSelectAfterPaintOrInk

bool ToolProperties::getSelectAfterPaintOrInk ( )

slot

Gets the select after paint or ink property.

Returns: the select after paint or ink flag.

◆ getSelectByColor

bool ToolProperties::getSelectByColor ( )

slot

Gets the select by color property.

Returns: the select by color flag.

◆ getSelectionIsLasso

bool ToolProperties::getSelectionIsLasso ( )

slot

Gets the selection is lasso property.

Possible values are: Lasso mode = true Markee mode = false

Returns: true if selection is in lasso mode, false if markee.

◆ getSelectionMode

int ToolProperties::getSelectionMode ( )

slot

Gets the selection mode property.

Possible values are: NORMAL_SELECTION = 0 ELEMENT_SELECTION = 1 PEG_SELECTION = 2 TOP_MOST_SELECTION = 3

Returns: the selection mode.

◆ getShowAdvancedControls

bool ToolProperties::getShowAdvancedControls ( )

slot

Gets the show advanced controls property.

Returns: the show advanced controls flag.

◆ getShowAllContourEditingControls

bool ToolProperties::getShowAllContourEditingControls ( )

slot

Gets the show all conotur editing controls property.

Returns: the show all conotur editing controls flag.

◆ getShowOtherDrawingThumbnail

bool ToolProperties::getShowOtherDrawingThumbnail ( )

slot

Gets the show other drawing thumbnail property.

Returns: the show other drawing thumbnail flag.

◆ getSmoothPenStyleCenterSmooth

double ToolProperties::getSmoothPenStyleCenterSmooth ( )

slot

Gets the smooth pen style center smooth property.

Returns: the smooth pen style center smooth value.

◆ getSmoothPenStyleMax

double ToolProperties::getSmoothPenStyleMax ( )

slot

Gets the smooth pen style maximum property.

Returns: the smooth pen style maximum value.

◆ getSmoothPenStyleMin

double ToolProperties::getSmoothPenStyleMin ( )

slot

Gets the smooth pen style minimum property.

Returns: the smooth pen style minimum value.

◆ getSmoothPenStyleMinRatio

double ToolProperties::getSmoothPenStyleMinRatio ( )

slot

Gets the smooth pen style minimum ratio property.

Returns: the smooth pen style minimum ratio value.

◆ getSmoothSelector

int ToolProperties::getSmoothSelector ( )

slot

Gets the smooth selector property.

Possible values are: SMOOTH_BRUSH = 0 SMOOTH_MARQUEE = 1 SMOOTH_LASSO = 2

Returns: the smooth selector mode.

◆ getSmoothShowPoints

bool ToolProperties::getSmoothShowPoints ( )

slot

Gets the smooth show points property.

Returns: the smooth show points flag.

◆ getSnapMode

bool ToolProperties::getSnapMode ( String toolName )

slot

Gets the snap mode property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the snap mode flag of the given tool.

◆ getSnapTo3DMode

bool ToolProperties::getSnapTo3DMode ( )

slot

Gets the snap to 3D mode property.

Returns: the snap to 3D mode.

◆ getSnapToBoundingBoxes

bool ToolProperties::getSnapToBoundingBoxes ( )

slot

Gets the snap to bounding boxes property.

Returns: the snap to bounding boxes flag.

◆ getSnapToContour

bool ToolProperties::getSnapToContour ( )

slot

Gets the snap to contour property.

Returns: the snap to contour flag.

◆ getSnapToGrid

bool ToolProperties::getSnapToGrid ( )

slot

Gets the snap to grid property.

Returns: the snap to grid flag.

◆ getStrokeSmoothValue

double ToolProperties::getStrokeSmoothValue ( )

slot

Gets the stroke smooth value property.

Returns: the stroke smooth value.

◆ getTextAlignment

int ToolProperties::getTextAlignment ( )

slot

Gets the text alignment property.

Returns: the text alignment.

◆ getTextFont

int ToolProperties::getTextFont ( )

slot

Gets the text font property.

Returns: the text font.

◆ getTextIndent

int ToolProperties::getTextIndent ( )

slot

Gets the text indent property.

Returns: the text indent.

◆ getTextKerning

int ToolProperties::getTextKerning ( )

slot

Gets the text kerning property.

Returns: the text kerning.

◆ getTextLineSpace

int ToolProperties::getTextLineSpace ( )

slot

Gets the text line space property.

Returns: the text line space value.

◆ getTextSize

int ToolProperties::getTextSize ( )

slot

Gets the text size property.

Returns: the text size.

◆ getTextStyle

int ToolProperties::getTextStyle ( )

slot

Gets the text style property.

Returns: the text style.

◆ getThicknessAdjustMode

bool ToolProperties::getThicknessAdjustMode ( )

slot

Gets the thickness adjust mode property.

Returns: the thickness adjust mode.

◆ getToolIdFromName

QScriptValue ToolProperties::getToolIdFromName ( String toolName )

slot

Returns: a numeric identifier for the tool named toolName.

◆ getToolResolutionHeight

int ToolProperties::getToolResolutionHeight ( )

slot

Gets the tool resolution height property.

Returns: the tool resolution height.

◆ getToolResolutionWidth

int ToolProperties::getToolResolutionWidth ( )

slot

Gets the tool resolution width property.

Returns: the tool resolution width.

◆ getTrimExtraLines

bool ToolProperties::getTrimExtraLines ( String toolName )

slot

Gets the trim extra lines property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the trim extra lines flag of the given tool.

◆ getTrimExtraLinesMatch

bool ToolProperties::getTrimExtraLinesMatch ( String toolName )

slot

Gets the trim extra lines match property of the given tool.

Parameters

toolName : The tool to get the property of.

Returns: the trim extra lines match flag of the given tool.

◆ getZoomInMode

bool ToolProperties::getZoomInMode ( )

slot

Gets the zoom in mode property.

Returns: the zoom in mode flag.

◆ setAllToolSpecificProperties

void ToolProperties::setAllToolSpecificProperties	(	String	toolName,
		QScriptValue	newValues
	)

slot

Sets the specific properties of the given tool.

Parameters

toolName	: The tool to set the properties of.
newValues	: An object storing the new values of all or some of the specified tool's properties.

◆ setAntialiasingMode

void ToolProperties::setAntialiasingMode ( int mode )

slot

Sets the antialiasing mode property.

Possible values are: AntialiasingOff = 0 AntialiasingOn = 1

Parameters

mode	: The value to set the antialiasing mode to.

◆ setApplyAllArts

void ToolProperties::setApplyAllArts ( bool b )

slot

Sets the Apply to Line Art and Colour Art checkbox state to b; in the Select Tool Options.

Parameters

b	: When true sets the Apply to Line Art and Colour Art checkbox state to checked. When false, unchecks it.

◆ setApplyAllDrawings

void ToolProperties::setApplyAllDrawings ( bool b )

slot

Sets the apply all drawing mode to b.

Parameters

b	: When true enables the apply all drawing mode.

See also: ToolProperties::getFrameMode

◆ setApplyAllVisibleDrawings

void ToolProperties::setApplyAllVisibleDrawings ( bool b )

slot

Sets the apply all visible drawing mode to b.

Parameters

b	: When true enables the apply all visible drawing mode.

See also: ToolProperties::getElementMode

◆ setApplyToAllLayers

void ToolProperties::setApplyToAllLayers ( bool b )

slot

Sets the apply to all layers property.

Parameters

b	: The new apply to all layers flag.

◆ setAutoCreateColourArt

void ToolProperties::setAutoCreateColourArt ( bool b )

slot

Sets the auto create colour art mode of the current tool to b if applicable.

Parameters

b	: When true enables the auto create colour art mode of the current tool. When false disables it.

◆ setAutoFillInside [1/2]

void ToolProperties::setAutoFillInside ( bool b )

slot

Sets the auto fill mode of Rectangle and Ellipse tools to b.

Parameters

b	: When true enables the auto fill mode of the Rectangle and Ellipse tools.

◆ setAutoFillInside [2/2]

void ToolProperties::setAutoFillInside	(	String	toolName,
		bool	b
	)

slot

Sets the auto fill inside property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new auto fill inside flag.

◆ setAutoFlattenMode

void ToolProperties::setAutoFlattenMode ( bool b )

slot

Sets the auto flatten mode if applicable.

Parameters

b	: When true enables the auto flatten mode if applicable. When false disables it.

◆ setAutogapClosingMode

void ToolProperties::setAutogapClosingMode ( int m )

slot

Sets the auto gap closing mode to m. Mode can be 0, 1, 2 or 3, which corresponds to No Gap, Small, Medium and Large.

Parameters

m	: Sets the auto gap closing mode to 0, 1, 2 or 3, which corresponds to No Gap, Small, Medium and Large.

◆ setAutoGapLineClosing

void ToolProperties::setAutoGapLineClosing ( bool b )

slot

Sets the auto gap line closing property.

Parameters

b	: The new auto gap line closing flag.

◆ setAutoKerning

void ToolProperties::setAutoKerning ( bool b )

slot

Sets the text auto kerning property.

Parameters

b	: The new text auto kerning flag.

◆ setBitmapPaintAlpha

void ToolProperties::setBitmapPaintAlpha ( int value )

slot

Sets the bitmap paint alpha property.

Parameters

value : The new bitmap paint alpha value.

◆ setBitmapPaintColorTolerance

void ToolProperties::setBitmapPaintColorTolerance ( int value )

slot

Sets the bitmap paint color tolerance property.

Parameters

value : The new bitmap paint color tolerance value.

◆ setBitmapPaintMaxOverlap

void ToolProperties::setBitmapPaintMaxOverlap ( int value )

slot

Sets the bitmap paint max overlap property.

Parameters

value : The new bitmap paint max overlap value.

◆ setBitmapPaintSourceArt

void ToolProperties::setBitmapPaintSourceArt ( int mode )

slot

Sets the bitmap paint source art property.

Possible values are: BitmapPaintSourceUnderlayArt = 0 BitmapPaintSourceColorArt = 1 BitmapPaintSourceLineArt = 2 BitmapPaintSourceOverlayArt = 3 BitmapPaintSourceCurrentArt = 255

Parameters

mode	: The mode to set the bitmap paint source art to.

◆ setBoundingBoxMovable

void ToolProperties::setBoundingBoxMovable ( bool b )

slot

Sets the bounding box movable property.

Parameters

b	: The new bounding box movable flag.

◆ setBringInkedLinesOnTop

void ToolProperties::setBringInkedLinesOnTop ( bool b )

slot

Instructs the ink tool to bring inked lines on top after inking if b is true.

Parameters

b	: When true instructs the ink tool to bring inked lines on top after inking.

◆ setBrushMode

void ToolProperties::setBrushMode ( int mode )

slot

Sets the brush mode property.

Possible values are: BRUSH = 0 REPAINT_BRUSH = 1 DRAWBEHIND_BRUSH = 2

Parameters

mode	: The value to set the brush mode to.

◆ setChangeSymbolPivotOnAllFrames

void ToolProperties::setChangeSymbolPivotOnAllFrames ( bool b )

slot

Sets the change symbol pivot on all frames property.

Parameters

b	: The new change symbol pivot on all frames flag.

◆ setControlPointSelectionMode

void ToolProperties::setControlPointSelectionMode ( int mode )

slot

Sets the control point selection mode property.

Possible values are: Drawing = 0 ControlPoint = 1

Parameters

mode	: The value to set the control point selection mode to.

◆ setCreateColorArtOnBrush

void ToolProperties::setCreateColorArtOnBrush ( bool b )

slot

Sets create color art on brush property.

Parameters

b	: The create color art on brush flag.

◆ setCutEnableBreakGesture

void ToolProperties::setCutEnableBreakGesture ( bool b )

slot

Sets the enable break gesture property.

Parameters

b	: The new enable break gesture flag.

◆ setCutEnableCutterGesture

void ToolProperties::setCutEnableCutterGesture ( bool b )

slot

Sets the enable cutter gesture property.

Parameters

b	: The new enable cutter gesture flag.

◆ setDisablePivotControl

void ToolProperties::setDisablePivotControl ( bool b )

slot

Disables the pivot Transform tool manipulator if b is true. A pivot control will still be displayed but will not be manipulatable.

Parameters

b	: When true disables the pivot Transform tool manipulator.

◆ setDisablePivotManipulatorControl

void ToolProperties::setDisablePivotManipulatorControl ( bool b )

slot

Sets the hide pivot manipulator controls property.

Parameters

b	: The new hide pivot manipulator controls flag.

◆ setDrawBehind

void ToolProperties::setDrawBehind	(	String	toolName,
		bool	b
	)

slot

Sets the draw behind property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new draw behind flag.

◆ setDrawBehindMode

void ToolProperties::setDrawBehindMode ( bool b )

slot

Toggles the Draw Behind mode of the Brush tool.

Parameters

b	: When true enables the Draw Behind mode of the Brush tool. When false, disables it.

◆ setDrawingMagnifier

void ToolProperties::setDrawingMagnifier ( bool b )

slot

Sets the drawing magnifier property.

Parameters

b	: The new drawing magnifier flag.

◆ setDrawingMagnifierMode

void ToolProperties::setDrawingMagnifierMode ( bool b )

slot

Sets the magnifier mode.

Parameters

b	: When true enables the magnifier mode. When false disables it.

◆ setDrawingType

void ToolProperties::setDrawingType ( int mode )

slot

Sets the drawing type property.

Possible values are: DrawingVector = 0 DrawingBitmap = 1

Parameters

mode	: The value to set the drawing type to.

◆ setElementMode

void ToolProperties::setElementMode ( int mode )

slot

Sets the element mode property.

Possible values are: SelectedElements = 0 VisibleElements = 1 LinkedElements = 2

Parameters

mode	: The value to set the element mode to.

◆ setFrameMode

void ToolProperties::setFrameMode ( int mode )

slot

Sets the frame mode property.

Possible values are: CurrentFrame = 0 AllFrames = 1 OnionSkinFrames = 2

Parameters

mode	: The value to set the frame mode to.

◆ setGestureCutter

void ToolProperties::setGestureCutter ( bool b )

slot

Set the cutter's gesture mode to b.

Parameters

b	: When true enables the cutter's gesture mode.

◆ setGlobalProperties

void ToolProperties::setGlobalProperties ( QScriptValue newValues )

slot

Sets the global properties found in the parameter.

A global property is a tool property that is unique to a tool, or is set globally for all tools.

Parameters

newValues : An object storing all or some of the global properties to set new values of.

◆ setHideManipulatorControls

void ToolProperties::setHideManipulatorControls ( bool b )

slot

Sets the hide manipulator controls property.

Parameters

b	: The new hide manipulator controls flag.

◆ setHideRotateManipulatorControls

void ToolProperties::setHideRotateManipulatorControls ( bool b )

slot

Sets the hide rotate manipulator controls property.

Parameters

b	: The new hide rotate manipulator controls flag.

◆ setHideScaleManipulatorControls

void ToolProperties::setHideScaleManipulatorControls ( bool b )

slot

Sets the hide scale manipulator controls property.

Parameters

b	: The new hide scale manipulator controls flag.

◆ setHideTranslateManipulatorControls

void ToolProperties::setHideTranslateManipulatorControls ( bool b )

slot

Sets the hide translate manipulator controls property.

Parameters

b	: The new hide translate manipulator controls flag.

◆ setInkIntelligentMode

void ToolProperties::setInkIntelligentMode ( bool b )

slot

Sets the ink intelligent mode property.

Parameters

b	: The new ink intelligent mode.

◆ setInkJoinMode [1/2]

void ToolProperties::setInkJoinMode ( String joinType )

slot

Sets the join mode of the inked lines to be joinType. Join type can be one of: "ROUND_JOIN", "MITER_JOIN" or "BEVEL_JOIN".

Parameters

joinType : Sets the join mode of the inked lines to be joinType.

◆ setInkJoinMode [2/2]

void ToolProperties::setInkJoinMode ( int mode )

slot

Sets the ink join mode property.

Possible values are: UNDEFINED_JOIN = 0 ROUND_JOIN = 1 MITER_JOIN = 2 BEVEL_JOIN = 3

Parameters

mode	: The value to set the ink join mode to.

◆ setInkLineSelectionMode

void ToolProperties::setInkLineSelectionMode ( bool b )

slot

Instructs the ink tool to select inked lines after inking if b is true.

Parameters

b	: When true instructs the ink tool to select inked lines after inking.

◆ setInkRaiseMode

void ToolProperties::setInkRaiseMode ( bool b )

slot

Sets the ink raise mode property.

Parameters

b	: The new ink raise mode.

◆ setInkSelectionMode

void ToolProperties::setInkSelectionMode ( bool b )

slot

Sets the ink selection mode property.

Parameters

b	: The new ink selection mode.

◆ setInkShowInkableLines

void ToolProperties::setInkShowInkableLines ( bool b )

slot

Sets the show inkable lines property.

Parameters

b	: The new show inkable lines flag.

◆ setKeepProportions

void ToolProperties::setKeepProportions	(	String	toolName,
		bool	b
	)

slot

Sets the keep proportions property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new keep proportions flag.

◆ setLineAutoGapClosing

void ToolProperties::setLineAutoGapClosing ( bool b )

slot

Toggles the auto gap closing functionality for the line and pencil tools. When the auto gap functionality is on, the line or pencil tool tries to add a stroke line to cover the gap between the newly created line and any existing line.

Parameters

b	: When true enables the auto gap closing functionality for the Line and Pencil tools.

◆ setLineBuildingMode

void ToolProperties::setLineBuildingMode ( bool b )

slot

Sets the line building mode property.

Parameters

b	: The new line building mode.

◆ setLineMode

void ToolProperties::setLineMode	(	String	toolName,
		bool	b
	)

slot

Sets the line mode property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new line mode flag.

◆ setLinePushingMode

void ToolProperties::setLinePushingMode ( bool b )

slot

Sets the line pushing mode property.

Parameters

b	: The new line pushing mode.

◆ setLockColor

void ToolProperties::setLockColor	(	String	toolName,
		bool	b
	)

slot

Sets the lock color property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new lock color flag.

◆ setLockPenStyleWidth

void ToolProperties::setLockPenStyleWidth	(	String	toolName,
		bool	b
	)

slot

Sets the lock pen style width property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new lock pen style width flag.

◆ setMarkeeMode

void ToolProperties::setMarkeeMode ( bool b )

slot

Sets the select tool mode selection to Lasso or Marquee. If b is true, the mode will be set to Marquee.

Parameters

b	: When true sets the selection mode to Marquee. When false sets the selection mode to Lasso.

◆ setMergeWithTopLayer

void ToolProperties::setMergeWithTopLayer ( bool b )

slot

Sets the merge with top layer property.

Parameters

b	: The new merge with top layer flag.

◆ setMouseGestureBreakeMode

void ToolProperties::setMouseGestureBreakeMode ( bool b )

slot

Set the cutter's gesture break mode to b.

Parameters

b	: When true enables the cutter's gesture break mode.

◆ setPaintAndRemoveTextureMode

void ToolProperties::setPaintAndRemoveTextureMode ( bool b )

slot

Instruct the paint tool to remove the opacity texture if b is true.

Parameters

b	: When true enables the remove texture when painting mode is turned on.

◆ setPaintDestroyTexture

void ToolProperties::setPaintDestroyTexture ( bool b )

slot

Sets the paint destroy texture property.

Parameters

b	: The new paint destroy texture flag.

◆ setPaintElementMode

void ToolProperties::setPaintElementMode ( int mode )

slot

Sets paint element mode property.

Possible values are: SelectedElements = 0 VisibleElements = 1 LinkedElements = 2

Parameters

mode	: The value to set the paint element mode to.

◆ setPaintMode

void ToolProperties::setPaintMode ( int mode )

slot

Sets the paint mode property.

Possible values are: PAINT = 0 UNPAINT = 1 REPAINT = 2 PAINT_UNPAINTED = 3

Parameters

mode	: The value to set the paint mode to.

◆ setPaintToolShouldSelectPaintedZonesAfterPainting

void ToolProperties::setPaintToolShouldSelectPaintedZonesAfterPainting ( bool b )

slot

If b is true, the paint tool will select the newly painted zone after painting. This can be useful if you want to edit a gradient on multiple zones after painting.

Parameters

b	: When true the paint tool will select the newly painted zone after painting.

◆ setPegSelectionMode

void ToolProperties::setPegSelectionMode ( bool b )

slot

Sets the selection mode of the transform tool to peg mode if b is true.

Parameters

b	: When true enables the selection mode of the transform tool to peg mode.

◆ setPencilTipMode [1/2]

void ToolProperties::setPencilTipMode ( String pencilTip )

slot

Sets the pencil tip shape used by the eraser, cutter, and ink tools whenever an existing pencil line gets split by the tool.

Parameters

pencilTip : Can have one of the following values: "ROUND_TIP", "FLAT_TIP" or "BEVEL_TIP".

◆ setPencilTipMode [2/2]

void ToolProperties::setPencilTipMode	(	String	toolName,
		int	mode
	)

slot

Sets the pencil tip mode property of the given tool.

Parameters

toolName	: The tool to set the property of.
mode	: The new pencil tip mode.

◆ setPermanentSelectionMode

void ToolProperties::setPermanentSelectionMode ( bool b )

slot

Toggles the permanent selection mode.

Parameters

b	: When true enables the permanent selection mode. When false disables it.

◆ setPerspectiveMode

void ToolProperties::setPerspectiveMode ( int mode )

slot

Sets the perspective mode property.

Possible values are: PerspectiveMode = 0 LatticeMode = 1

Parameters

mode	: The value to set the perspective mode to.

◆ setPreventDrawing

void ToolProperties::setPreventDrawing ( bool b )

slot

Sets the prevent drawing property.

Parameters

b	: The new prevent drawing flag.

◆ setPreventScenePlanning

void ToolProperties::setPreventScenePlanning ( bool b )

slot

Sets the prevent scene planning property.

Parameters

b	: The new prevent drawing flag.

◆ setRespectProtectedColourMode

void ToolProperties::setRespectProtectedColourMode ( bool b )

slot

Sets the Respect Protected Colour mode if applicable.

Parameters

b	: When true enables the Respect Protected Colour mode. When false disables it.

◆ setRetraceMode

void ToolProperties::setRetraceMode ( bool b )

slot

Sets the retrace mode property.

Parameters

b	: The new retrace mode.

◆ setRetraceNoiseMax

void ToolProperties::setRetraceNoiseMax ( double max )

slot

Sets the maximum retrace noise property.

Parameters

max	: The new maximum retrace noise value.

◆ setRetraceOffsetMax

void ToolProperties::setRetraceOffsetMax ( double max )

slot

Sets the maximum retrace offset property.

Parameters

max	: The new maximum retrace offset value.

◆ setRetraceProbability

void ToolProperties::setRetraceProbability ( double probability )

slot

Sets the retrace probability property.

Parameters

probability : The new retrace probability value.

◆ setRetraceTiltMax

void ToolProperties::setRetraceTiltMax ( double max )

slot

Sets the maximum retrace tilt property.

Parameters

max	: The new maximum retrace tilt value.

◆ setSelectAfterPaintOrInk

void ToolProperties::setSelectAfterPaintOrInk ( bool b )

slot

Sets the select after paint or ink property.

Parameters

b	: The new select after paint or ink flag.

◆ setSelectByColor

void ToolProperties::setSelectByColor ( bool b )

slot

Sets the select by color property.

Parameters

b	: The new select by color flag.

◆ setSelectByColourMode

void ToolProperties::setSelectByColourMode ( bool b )

slot

Sets the select by colour mode of the Select tool .

Parameters

b	: When true enables the select by color mode of the Select tool. When false disables it.

◆ setSelectionIsLasso

void ToolProperties::setSelectionIsLasso ( bool b )

slot

Sets the selection is lasso property.

Possible values are: Lasso mode = true Markee mode = false

Parameters

b	: True to set the selection mode to lasso, false for markee.

◆ setSelectionMode

void ToolProperties::setSelectionMode ( int mode )

slot

Sets the selection mode property.

Possible values are: NORMAL_SELECTION = 0 ELEMENT_SELECTION = 1 PEG_SELECTION = 2 TOP_MOST_SELECTION = 3

Parameters

mode	: The value to set the selection mode to.

◆ setShowAdvancedControls

void ToolProperties::setShowAdvancedControls ( bool b )

slot

Sets the show advanced controls property.

Parameters

b	: The new show advanced controls flag.

◆ setShowHideAllContourEditingControls

void ToolProperties::setShowHideAllContourEditingControls ( bool b )

slot

Toggles whether contour editor shows all tool controls or not.

Parameters

b	: When true contour editer shows all tool controls. When false hides them.

◆ setShowHideManipulatorControls

void ToolProperties::setShowHideManipulatorControls ( bool b )

slot

Hides the transform tool manipulator if b is true.

Parameters

b	: When true hides the transform tool manipulator.

◆ setShowInkableLines

void ToolProperties::setShowInkableLines ( bool b )

slot

Shows the inkable lines if b is true.

Parameters

b	: When true shows the inkable lines.

◆ setShowOtherDrawingThumbnail

void ToolProperties::setShowOtherDrawingThumbnail ( bool b )

slot

Sets the show other drawing thumbnail property.

Parameters

b	: The new show other drawing thumbnail flag.

◆ setSmartInkLineConnectionMode

void ToolProperties::setSmartInkLineConnectionMode ( bool b )

slot

Sets the smart ink line connection mode to b.

Parameters

b	: When true enables the smart ink line connection mode.

◆ setSmoothPenStyleCenterSmooth

void ToolProperties::setSmoothPenStyleCenterSmooth ( double value )

slot

Sets the smooth pen style center smooth property.

Parameters

value : The new smooth pen style center smooth value.

◆ setSmoothPenStyleMax

void ToolProperties::setSmoothPenStyleMax ( double value )

slot

Sets the smooth pen style maximum property.

Parameters

value : The new smooth pen style maximum value.

◆ setSmoothPenStyleMin

void ToolProperties::setSmoothPenStyleMin ( double value )

slot

Sets the smooth pen style minimum property.

Parameters

value : The new smooth pen style minimum value.

◆ setSmoothPenStyleMinRatio

void ToolProperties::setSmoothPenStyleMinRatio ( double value )

slot

Sets the smooth pen style minimum ratio property.

Parameters

value : The new smooth pen style minimum ratio value.

◆ setSmoothSelector

void ToolProperties::setSmoothSelector ( int mode )

slot

Sets the smooth selector property.

Possible values are: SMOOTH_BRUSH = 0 SMOOTH_MARQUEE = 1 SMOOTH_LASSO = 2

Parameters

mode	: The value to set the smooth selector mode to.

◆ setSmoothShowPoints

void ToolProperties::setSmoothShowPoints ( bool b )

slot

Sets the smooth show points property.

Parameters

b	: The new smooth show points flag.

◆ setSnapMode

void ToolProperties::setSnapMode	(	String	toolName,
		bool	b
	)

slot

Sets the snap mode property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new snap mode flag.

◆ setSnapping

void ToolProperties::setSnapping	(	bool	contour,
		bool	align,
		bool	grid
	)

slot

Sets the snapping mode for the contour, align and grid mode all to the modes specified in argument.

Parameters

contour	: When true enables the snapping mode for the contour mode. When false disables it.
align	: When true enables the snapping mode for the align mode. When false disables it.
grid	: When true enables the snapping mode for the grid mode. When false disables it.

◆ setSnapTo3DMode

void ToolProperties::setSnapTo3DMode ( bool b )

slot

Sets the snap to 3D mode property.

Parameters

b	: The new snap to 3D mode flag.

◆ setSnapToBoundingBoxes

void ToolProperties::setSnapToBoundingBoxes ( bool b )

slot

Sets the snap to bounding boxes property.

Parameters

b	: The new snap to bounding boxes flag.

◆ setSnapToContour

void ToolProperties::setSnapToContour ( bool b )

slot

Sets the snap to contour property.

Parameters

b	: The new snap to contour flag.

◆ setSnapToGrid

void ToolProperties::setSnapToGrid ( bool b )

slot

Sets the snap to grid property.

Parameters

b	: The new snap to grid flag.

◆ setStrokeSmoothValue

void ToolProperties::setStrokeSmoothValue ( double d )

slot

Sets the stroke smooth value property.

Parameters

d	: The new stroke smooth value.

◆ setTextAlignment

void ToolProperties::setTextAlignment ( int alignment )

slot

Sets the text alignment property.

Parameters

alignment : The new text alignment.

◆ setTextFont

void ToolProperties::setTextFont ( int font )

slot

Sets the text font property.

Parameters

font	: The new text font.

◆ setTextIndent

void ToolProperties::setTextIndent ( int indent )

slot

Sets the text indent property.

Parameters

indent : The new text indent value.

◆ setTextKerning

void ToolProperties::setTextKerning ( int kerning )

slot

Sets the text kerning property.

Parameters

kerning : The new text kerning.

◆ setTextLineSpace

void ToolProperties::setTextLineSpace ( int lineSpace )

slot

Sets the text line space property.

Parameters

lineSpace : The new text line space value.

◆ setTextSize

void ToolProperties::setTextSize ( int size )

slot

Sets the text size property.

Parameters

size	: The new text size.

◆ setTextStyle

void ToolProperties::setTextStyle ( int style )

slot

Sets the text style property.

Parameters

style : The new text style.

◆ setThicknessAdjustMode

void ToolProperties::setThicknessAdjustMode ( bool b )

slot

Sets the thickness adjust mode property.

Parameters

b	: The new thickness adjust mode.

◆ setToolResolutionHeight

void ToolProperties::setToolResolutionHeight ( int height )

slot

Sets the tool resolution height property.

Parameters

height : The new tool resolution height.

◆ setToolResolutionWidth

void ToolProperties::setToolResolutionWidth ( int width )

slot

Sets the tool resolution width property.

Parameters

width : The new tool resolution width.

◆ setTransformToolSnapping

void ToolProperties::setTransformToolSnapping	(	bool	align,
		bool	grid
	)

slot

Sets the align and grid snapping modes of the transform tool.

Parameters

align	: When true enables the align snapping mode of the transform tool. When false disables it.
grid	: When true enables the grid snapping mode of the transform tool. When false disables it.

◆ setTrimExtraLines

void ToolProperties::setTrimExtraLines	(	String	toolName,
		bool	b
	)

slot

Sets the trim extra lines property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new trim extra lines flag.

◆ setTrimExtraLinesMatch

void ToolProperties::setTrimExtraLinesMatch	(	String	toolName,
		bool	b
	)

slot

Sets the trim extra lines match property of the given tool.

Parameters

toolName	: The tool to set the property of.
b	: The new trim extra lines match flag.

◆ setUsedStoredColourGradientMode

void ToolProperties::setUsedStoredColourGradientMode ( bool b )

slot

Instruct the paint tool to use the gradient/texture matrix stored in the tool if b is true.

Parameters

b	: When true the paint tool will use the gradient/texture matrix stores in the tool.

◆ setZoomInMode

void ToolProperties::setZoomInMode ( bool b )

slot

Sets the zoom in mode property.

Parameters

b	: The new zoom in mode flag.

◆ toolNames

QScriptValue ToolProperties::toolNames ( )

slot

Gets all of the available tools.

Returns: an array with all of the names of available tools.

Public Slots

line tool options

Detailed Description

Member Function Documentation

◆ getAllGlobalProperties

◆ getAllToolSpecificProperties

◆ getAntialiasingMode

◆ getApplyToAllLayers

◆ getAutoFillInside

◆ getAutoFlattenMode

◆ getAutoGapClosingMode

◆ getAutoGapLineClosing

◆ getAutoKerning

◆ getBitmapPaintAlpha

◆ getBitmapPaintColorTolerance

◆ getBitmapPaintMaxOverlap

◆ getBitmapPaintSourceArt

◆ getBoundingBoxMovable

◆ getBrushMode

◆ getChangeSymbolPivotOnAllFrames

◆ getControlPointSelectionMode

◆ getCreateColorArtOnBrush

◆ getCutEnableBreakGesture

◆ getCutEnableCutterGesture

◆ getDisablePivotManipulatorControl

◆ getDrawBehind

◆ getDrawingMagnifier

◆ getDrawingType

◆ getElementMode

◆ getFrameMode

◆ getHideManipulatorControls

◆ getHideRotateManipulatorControls

◆ getHideScaleManipulatorControls

◆ getHideTranslateManipulatorControls

◆ getInkIntelligentMode

◆ getInkJoinMode

◆ getInkRaiseMode

◆ getInkSelectionMode

◆ getInkShowInkableLines

◆ getKeepProportions

◆ getLineBuildingMode

◆ getLineMode

◆ getLinePushingMode

◆ getLockColor

◆ getLockPenStyleWidth

◆ getMergeWithTopLayer

◆ getPaintDestroyTexture

◆ getPaintElementMode

◆ getPaintMode

◆ getPencilTipMode

◆ getPermanentSelectionMode

◆ getPerspectiveMode

◆ getPreventDrawing

◆ getPreventScenePlanning

◆ getRespectStickyColor

◆ getRetraceMode

◆ getRetraceNoiseMax

◆ getRetraceOffsetMax

◆ getRetraceProbability

◆ getRetraceTiltMax

◆ getSelectAfterPaintOrInk

◆ getSelectByColor

◆ getSelectionIsLasso

◆ getSelectionMode

◆ getShowAdvancedControls

◆ getShowAllContourEditingControls

◆ getShowOtherDrawingThumbnail

◆ getSmoothPenStyleCenterSmooth

◆ getSmoothPenStyleMax

◆ getSmoothPenStyleMin

◆ getSmoothPenStyleMinRatio

◆ getSmoothSelector

◆ getSmoothShowPoints

◆ getSnapMode

◆ getSnapTo3DMode

◆ getSnapToBoundingBoxes

◆ getSnapToContour

◆ getSnapToGrid

◆ getStrokeSmoothValue

◆ getTextAlignment