SnapSourceEnablingBehavior enum

Controls how snap sources are enabled when calling SnapSettings.syncSourceSettingsUsingRules.

Inheritance
Available extensions

Values

preserve → const SnapSourceEnablingBehavior

Preserves SnapSourceSettings.isEnabled values.

When passed to SnapSettings.syncSourceSettingsUsingRules, all new SnapSourceSettings added to the SnapSettings.sourceSettings collection will have the default SnapSourceSettings.isEnabled value of false, and existing SnapSourceSettings will be unaffected.

setFromRules → const SnapSourceEnablingBehavior

Enables SnapSourceSettings that have rule-based snapping behaviors.

When passed to SnapSettings.syncSourceSettingsUsingRules, all SnapSourceSettings in the SnapSettings.sourceSettings collection with a SnapSourceSettings.ruleBehavior of SnapRuleBehavior.rulesPreventSnapping or SnapRuleBehavior.rulesLimitSnapping will have SnapSourceSettings.isEnabled set to true.

Any new SnapSourceSettings added to the SnapSettings.sourceSettings collection with a SnapSourceSettings.ruleBehavior of SnapRuleBehavior.none will have a SnapSourceSettings.isEnabled value of false, and existing SnapSourceSettings with a SnapSourceSettings.ruleBehavior of SnapRuleBehavior.none will be unaffected.

Properties

coreValue → RT_SnapSourceEnablingBehavior
Convert to internal value.
no setter
hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<SnapSourceEnablingBehavior>
A constant List of the values in this enum, in order of their declaration.