Skip to main content

Enums

Enum
ButtonId
CaptureResult
DeviceFlags
DeviceType
EncryptionType
HashType
LicenseStatus
SignatureStorageType

ButtonId

Defines the value of the buttons on the signature capture window.

enum ButtonId
Defines possible button IDs for button click events.
Values
OkButton that when pressed, accepts the current signature input (value = 0)
ClearButton that when pressed, clears the current signature input (value = 1)
CancelButton that when pressed, cancels the signature capture process (value = 2)
PreviousButton for navigating to the previous screen (Epic only, not implemented) (value = 3)
NextButton for navigating to the next screen (Epic only, not implemented) (value = 4)

CaptureResult

Returns the status of the signature capture once the capture process has finished.

enum CaptureResult
Defines possible results of a capture operation.
Values
CaptureResult_InvalidThe result of the signature capture is invalid (value = 0)
CaptureResult_PendingThe signature capture process is still pending (value = 1)
CaptureResult_CancelledThe signature capture process was canceled (value = 2)
CaptureResult_SuccessThe signature capture process was successful (value = 3)
CaptureResult_NextRequest to move to the next page/screen (value = 4)
CaptureResult_PrevRequest to move to the previous page/screen (value = 5)
CaptureResult_PadDisconnectThe signature pad was disconnected (value = 6)
CaptureResult_PadErrorThe signature pad encountered an error (value = 7)
CaptureResult_LicenseErrorA license issue prevented the capture (value = 8)
CaptureResult_OtherErrorAn unspecified error occurred (value = 9)

DeviceFlags

Indicates status or characteristics flags associated with a signature device.

enum DeviceFlags
Defines possible flags for signature devices.
Values
InvalidIndicates that the device flags are invalid (value = 0)

DeviceType

Indicates the type of signature capture device in use (e.g. STU-540).

enum DeviceType
Defines the type of capture device currently in use.
Values
InvalidThe device type is invalid (value = -1)
NoneNo device is connected or selected (value = 0)
OpaqueA standard opaque tablet device (value = 1)
IntegratedAn integrated display device, such as a built-in tablet (value = 2)
DiscreteA discrete external display device (value = 3)

EncryptionType

Specifies the encryption method to be used when handling sensitive data.

enum EncryptionType
Defines available encryption strategies.
Values
NoneNo encryption is applied (value = 0)
SymmetricData is encrypted using symmetric-key encryption (value = 1)
PublicKeyData is encrypted using public-key encryption (value = 2)

HashType

Specifies the hashing algorithm to be used when computing digital hashes.
Values must match those of florentis::hash_t and WacomGSS::ut::HashType.

enum HashType
Defines possible hashing algorithms.
Values
NoneNo hash is applied (value = 0)
MD5MD5 hashing algorithm (value = 1)
SHA1SHA-1 hashing algorithm (value = 2)
SHA224SHA-224 hashing algorithm (value = 3)
SHA256SHA-256 hashing algorithm (value = 4)
SHA384SHA-384 hashing algorithm (value = 5)
SHA512SHA-512 hashing algorithm (value = 6)

LicenseStatus

Represents the current licensing status of the signature capture system.

enum LicenseStatus
Defines possible licensing states for the system.
Values
DeviceNotLicensedThe connected device is not licensed (value = -4)
LicenseExpiredThe license has expired (value = -3)
LicenseInvalidThe license is invalid (value = -2)
NoLicenseNo license was provided (value = -1)
ValidThe license is valid (value = 0)
LicensedThe system is fully licensed (value = 1)
LicensedForEvaluationThe system is licensed for evaluation purposes (value = 2)
LicensedForDemoThe system is licensed for demonstration purposes (value = 3)

SignatureStorageType

Specifies the format in which the signature is returned as.

enum SignatureStorageType
Defines possible formats for storing signature data.
Values
ISigObjSignature is returned as an object (value = 0)
SigTextSignature is returned as a string (value = 1)
SigDataSignature is returned as a byte array (value = 2)
ISO_19785_3_2015_XML_FULLSignature is returned as a full XML string in ISO/IEC 19785-3:2015 format (value = 3)
ISO_19794_7_2007Signature is returned as a byte array in ISO/IEC 19794-7:2007 format (value = 4)
ISO_19794_7_2014Signature is returned as a byte array in ISO/IEC 19794-7:2014 format (value = 5)
ISO_19794_7_2021Signature is returned as a byte array in ISO/IEC 19794-7:2021 format (value = 6)