AnnotationTool enum

Copyright © 2018-2026 PSPDFKit GmbH. All rights reserved.

THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE PSPDFKIT LICENSE AGREEMENT. UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES. This notice may not be removed from this file.

The annotation creation tool to activate when entering annotation creation mode on a viewer.

Mirrors the pigeon-generated enum of the same name in nutrient_flutter_platform_interface/lib/src/api/nutrient_api.g.dart. The pigeon version is transport-only; this one is the public API surface and is what NutrientControllerInterface.enterAnnotationCreationMode expects.

Inheritance
Implemented types
Available extensions

Values

inkPen → const AnnotationTool
inkMagic → const AnnotationTool
inkHighlighter → const AnnotationTool
freeText → const AnnotationTool
freeTextCallOut → const AnnotationTool
stamp → const AnnotationTool
image → const AnnotationTool
highlight → const AnnotationTool
underline → const AnnotationTool
squiggly → const AnnotationTool
strikeOut → const AnnotationTool
line → const AnnotationTool
arrow → const AnnotationTool
square → const AnnotationTool
circle → const AnnotationTool
polygon → const AnnotationTool
polyline → const AnnotationTool
eraser → const AnnotationTool
cloudy → const AnnotationTool
caret → const AnnotationTool
richMedia → const AnnotationTool
screen → const AnnotationTool
file → const AnnotationTool
widget → const AnnotationTool
redaction → const AnnotationTool
signature → const AnnotationTool
stampImage → const AnnotationTool
note → const AnnotationTool
sound → const AnnotationTool
measurementAreaRect → const AnnotationTool
measurementAreaPolygon → const AnnotationTool
measurementAreaEllipse → const AnnotationTool
measurementPerimeter → const AnnotationTool
measurementDistance → const AnnotationTool

Properties

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<AnnotationTool>
A constant List of the values in this enum, in order of their declaration.