Enumerations

The following enumerations are defined in the C++ SDK.

Enumeration Description
Encoding An enumeration of character encodings. SeeCoded Character Sets for more information.
Category File type categories (such as word processor or spreadsheet). These are listed in File Classes.
Format File formats (e.g. Word, Excel, PDF etc.). These are listed in Supported Formats.
LogicalPDFDirection This enumeration is used to specify paragraph ordering when filtering a PDF.
MetadataValueType A list of the possible value types for metadata items.
MetadataKey The standard keys that KeyView can use for metadata field standardization.
OCROrientation The options for detecting rotated text during OCR.
OCRTextFindingMode The algorithms for finding text during OCR.
OCRDetectAlphabet The options for alphabet detection during OCR.
SubFile::Type This enumeration lists the possible categories of subfiles.
SummaryInfoType This enumeration is a return type from the SummaryInfoItem class.

LogicalPDFDirection

The following table lists the values of the LogicalPDFDirection enumeration.

Value Description
raw Unstructured paragraph flow. This is the default behavior.
ltr Paragraphs are output from left to right.
rtl Paragraphs are ouput from right to left. This is most useful for languages with a right-to-left reading order.
automatic The PDF reader determines the paragraph direction for each PDF page, and then sets the direction accordingly.

MetadataValueType

A list of the possible value types for metadata items. A value from this enumeration is returned from the function value_type().

Value Description
Bool A Boolean.
Int64 A 64-bit integer.
Double A double.
DateTime Absolute date/time value, as an integral number of epoch seconds.
TargetEncodingString A string presented in your configured target encoding.
Binary Binary data.
MIPLabel Microsoft Information Protection sensitivity label (MIPLabel) type. See The MIPLabel Class.

MetadataKey

This enumerated type defines the standard keys that KeyView can use for metadata field standardization. The values from this enumeration are returned by the standard_key method of a MetadataElement. The value MetadataKey::Other indicates that a metadata element does not represent a standardized field. This enumeration is defined in Keyview_Metadata.hpp. For a list of the standard metadata keys, see Standardized Metadata Fields.

OCROrientation

The following table lists the values of the OCROrientation enumeration.

Value Description
Upright OCR only attempts to detect text that is upright.
Any OCR attempts to detect text that is upright, or rotated in 90-degree increments from upright.

OCRTextFindingMode

The following table lists the values of the OCRTextFindingMode enumeration.

Value Description
Document A scanned or printed page of formatted text, such as a report, magazine, or letter.
Scene An image of a general scene that contains text, such as a photograph or TV footage.
Hollow A scene image containing outlined text, such as white characters with a black border which are often used in television subtitles.
Auto The IDOL OCR library selects the algorithm automatically.

OCRDetectAlphabet

The following table lists the values of the OCRDetectAlphabet enumeration.

Value Description
Off OCR does not detect the alphabet.
Listed OCR detects the alphabet, but only considers alphabets that are represented in your chosen list of languages.
All OCR detects the alphabet that is used, and considers all alphabets.

SubFile::Type

The following table lists the values of the SubFile::Type enumeration.

Value Description
Main The subfile is at the top level of the main file. This is the default subfile type.
Attachment The subfile is an attachment in a file.
OLE The subfile is an embedded OLE object in a compound document.
Folder The subfile is a folder or the artificial root node.
Uncategorised_Image An embedded image that has not been categorized by the reader.
Embedded_Image An embedded image.
Embedded_Icon An icon used to represent an embedded file.
Embedded_Content An image used to represent content for an embedded file. This could be an preview image of the actual content, or another representation such as an icon.
Embedded_Preview A preview of an embedded file. This is usually an image that shows part of the embedded file.
XrML The subfile contains the XrML that describes the RMS protection used on an RMS-encrypted main file.

NOTE: The enumeration SubFile::Type is a scoped enumeration, as well as being a member of class Subfile. Therefore, you must always refer to the values by using a full qualification. For example:

if(subfile.type() == SubFile::Type::Folder)

NOT

if(subfile.type() == Folder)

SummaryInfoType

DEPRECATED: The SummaryInfoType enumeration is deprecated in KeyView 23.2.0 and later.

The SummaryInfoType enumeration has the following values:

Bool
Int
Double
TargetEncodingString
Utf8String
DateTime

NOTE: The enumerator names for SummaryInfoType are generic, so SummaryInfoType is a scoped enumeration; that is, you must always refer to the values by using a qualification with the enumeration name. For example:

if(item.type() == SummaryInfoType::Double)

NOT

if(item.type() == Double)