from __future__ import annotations
import io
from typing import List, Iterator, Tuple, Optional, Any, TYPE_CHECKING, Callable
from ctypes import *
from datetime import datetime
from numbers import Number
from pdftools_sdk.internal import _lib
from pdftools_sdk.internal.utils import _string_to_utf16, _utf16_to_string
from pdftools_sdk.internal.streams import _StreamDescriptor, _NativeStream
from pdftools_sdk.internal.native_base import _NativeBase
from pdftools_sdk.internal.native_object import _NativeObject
import pdftools_sdk.internal
if TYPE_CHECKING:
from pdftools_sdk.ocr.page_processing_mode import PageProcessingMode
from pdftools_sdk.ocr.tagging_mode import TaggingMode
else:
PageProcessingMode = "pdftools_sdk.ocr.page_processing_mode.PageProcessingMode"
TaggingMode = "pdftools_sdk.ocr.tagging_mode.TaggingMode"
[docs]
class PageOptions(_NativeObject):
"""
Options for OCR processing of pages
These options control page-level OCR processing and tagging.
"""
[docs]
def __init__(self):
"""
"""
_lib.PdfToolsOcr_PageOptions_New.argtypes = []
_lib.PdfToolsOcr_PageOptions_New.restype = c_void_p
ret_val = _lib.PdfToolsOcr_PageOptions_New()
if ret_val is None:
_NativeBase._throw_last_error(False)
super()._initialize(ret_val)
@property
def mode(self) -> PageProcessingMode:
"""
The mode for processing pages
Default value: :attr:`pdftools_sdk.ocr.page_processing_mode.PageProcessingMode.NONE`
Returns:
pdftools_sdk.ocr.page_processing_mode.PageProcessingMode
"""
from pdftools_sdk.ocr.page_processing_mode import PageProcessingMode
_lib.PdfToolsOcr_PageOptions_GetMode.argtypes = [c_void_p]
_lib.PdfToolsOcr_PageOptions_GetMode.restype = c_int
ret_val = _lib.PdfToolsOcr_PageOptions_GetMode(self._handle)
if ret_val == 0:
_NativeBase._throw_last_error()
return PageProcessingMode(ret_val)
@mode.setter
def mode(self, val: PageProcessingMode) -> None:
"""
The mode for processing pages
Default value: :attr:`pdftools_sdk.ocr.page_processing_mode.PageProcessingMode.NONE`
Args:
val (pdftools_sdk.ocr.page_processing_mode.PageProcessingMode):
property value
"""
from pdftools_sdk.ocr.page_processing_mode import PageProcessingMode
if not isinstance(val, PageProcessingMode):
raise TypeError(f"Expected type {PageProcessingMode.__name__}, but got {type(val).__name__}.")
_lib.PdfToolsOcr_PageOptions_SetMode.argtypes = [c_void_p, c_int]
_lib.PdfToolsOcr_PageOptions_SetMode.restype = c_bool
if not _lib.PdfToolsOcr_PageOptions_SetMode(self._handle, c_int(val.value)):
_NativeBase._throw_last_error(False)
@property
def tagging(self) -> TaggingMode:
"""
The mode for processing tagging information
Default value: :attr:`pdftools_sdk.ocr.tagging_mode.TaggingMode.AUTO`
Returns:
pdftools_sdk.ocr.tagging_mode.TaggingMode
"""
from pdftools_sdk.ocr.tagging_mode import TaggingMode
_lib.PdfToolsOcr_PageOptions_GetTagging.argtypes = [c_void_p]
_lib.PdfToolsOcr_PageOptions_GetTagging.restype = c_int
ret_val = _lib.PdfToolsOcr_PageOptions_GetTagging(self._handle)
if ret_val == 0:
_NativeBase._throw_last_error()
return TaggingMode(ret_val)
@tagging.setter
def tagging(self, val: TaggingMode) -> None:
"""
The mode for processing tagging information
Default value: :attr:`pdftools_sdk.ocr.tagging_mode.TaggingMode.AUTO`
Args:
val (pdftools_sdk.ocr.tagging_mode.TaggingMode):
property value
"""
from pdftools_sdk.ocr.tagging_mode import TaggingMode
if not isinstance(val, TaggingMode):
raise TypeError(f"Expected type {TaggingMode.__name__}, but got {type(val).__name__}.")
_lib.PdfToolsOcr_PageOptions_SetTagging.argtypes = [c_void_p, c_int]
_lib.PdfToolsOcr_PageOptions_SetTagging.restype = c_bool
if not _lib.PdfToolsOcr_PageOptions_SetTagging(self._handle, c_int(val.value)):
_NativeBase._throw_last_error(False)
@staticmethod
def _create_dynamic_type(handle):
return PageOptions._from_handle(handle)
@classmethod
def _from_handle(cls, handle):
"""
Internal factory method for constructing an instance using an internal handle.
This method creates an instance of the class by bypassing the public constructor.
"""
instance = PageOptions.__new__(cls) # Bypass __init__
instance._initialize(handle)
return instance
def _initialize(self, handle):
super()._initialize(handle)