All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::PDF::PowerPointOutputOptions Class Reference

#include <Convert.h>

Public Types

enum  SearchableImageSetting { e_ocr_text = 2, e_ocr_off, e_ocr_always }
 

Public Member Functions

 PowerPointOutputOptions ()
 
void SetPages (int page_from, int page_to)
 
void SetPDFPassword (const UString &password)
 
void SetLanguage (OutputOptionsOCR::LanguageChoice language)
 
void SetPreferredOCREngine (OutputOptionsOCR::PreferredOCREngine engine)
 
void SetCustomOCRLanguage (const UString &ocrlang)
 
void SetSearchableImageSetting (SearchableImageSetting setting)
 

Protected Attributes

TRN_Obj m_obj
 
SDF::ObjSet m_objset
 

Friends

class Convert
 

Detailed Description

A class containing options common to ToPowerPoint functions

Definition at line 1963 of file Convert.h.

Member Enumeration Documentation

Enumerator
e_ocr_text 
e_ocr_off 
e_ocr_always 

Definition at line 2003 of file Convert.h.

Constructor & Destructor Documentation

pdftron::PDF::PowerPointOutputOptions::PowerPointOutputOptions ( )

Creates a PowerPointOutputOptions object with default settings.

Member Function Documentation

void pdftron::PDF::PowerPointOutputOptions::SetCustomOCRLanguage ( const UString ocrlang)

Specifies the custom OCR languages to use.

Note
Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.
Parameters
ocrlangthe OCR language(s).
void pdftron::PDF::PowerPointOutputOptions::SetLanguage ( OutputOptionsOCR::LanguageChoice  language)

Specifies the OCR language. Default is automatic language detection.

Parameters
languagethe OCR language.
void pdftron::PDF::PowerPointOutputOptions::SetPages ( int  page_from,
int  page_to 
)

Specifies a range of pages to be converted. By default all pages are converted. The first page has the page number of 1.

Parameters
page_fromthe first page to be converted.
page_tothe last page to be converted (inclusive). Use a negative value to specify the last page in the PDF.
void pdftron::PDF::PowerPointOutputOptions::SetPDFPassword ( const UString password)

Specifies the password if the PDF requires one.

Parameters
passwordthe PDF password, if required; an empty string otherwise.
void pdftron::PDF::PowerPointOutputOptions::SetPreferredOCREngine ( OutputOptionsOCR::PreferredOCREngine  engine)

Specifies preferred OCR engine.

Parameters
engineThe PreferredOCREngine to OCR.
void pdftron::PDF::PowerPointOutputOptions::SetSearchableImageSetting ( SearchableImageSetting  setting)

Specifies how scanned image pages should be converted. Default is e_ocr_text.

Parameters
settingthe searchable image setting.
Remarks
Pre-existing OCRed content is ignored and a new OCR is performed from scratch.
See Also
SearchableImageSetting

Friends And Related Function Documentation

friend class Convert
friend

Definition at line 2020 of file Convert.h.

Member Data Documentation

TRN_Obj pdftron::PDF::PowerPointOutputOptions::m_obj
protected

Definition at line 2019 of file Convert.h.

SDF::ObjSet pdftron::PDF::PowerPointOutputOptions::m_objset
protected

Definition at line 2021 of file Convert.h.


The documentation for this class was generated from the following file: