Instance of the AOI engine. More...

Public Member Functions
	AOI_Instance ()

void	SetProgressCallBack (ProgressionCB, void *)

void	SetErrorCallBack (ErrorCB, void *)

bool	UseIGOR () const

void	SetIGOR (bool)

void	ResourceDirectory (const aur::ACPL::FileSpec &)

void	ResourceDirectory (const char16_t *)

const aur::ACPL::FileSpec	ResourceDirectory ()

ExceptionCode	GetDataDirectory (aur::ACPL::FileSpec &outDirectory)

ExceptionCode	GetApplicationDirectory (aur::ACPL::FileSpec &outDirectory)

float	GreekSize () const

void	SetGreekSize (float greekSize)

void	SetFontAntiAliasing (bool useFontAntiAliasing)

bool	UseFontAntiAliasing () const

Static Public Member Functions
static int	Version ()

static AOI_Instance *	Startup (const char uniqueID, const char licenseKey, const char *appSignature=NULL)

static void	Terminate ()

Detailed Description

Instance of the AOI engine.

The instance holds the general paths and resource manager. Every thread needs to have its own instance to be thread-safe.

The instance is also the holder of general settings and the license key.

Definition at line 17 of file AOI_Instance.h.

Constructor & Destructor Documentation

◆ AOI_Instance()

AOI_Instance::AOI_Instance ( )

Constructor of the AOI_Instance. Needed once for every thread.

Definition at line 24 of file AOI_Instance.cpp.

Member Function Documentation

◆ GetApplicationDirectory()

ExceptionCode AOI_Instance::GetApplicationDirectory ( aur::ACPL::FileSpec & outDirectory )

Retrieves the path to the application directory.

Parameters

outDirectory On returns contains the path to the directory. Is assumed to be 1024 wchar's big.

Returns: Error code when failed to retrieve the directory path.

Definition at line 192 of file AOI_Instance.cpp.

◆ GetDataDirectory()

ExceptionCode AOI_Instance::GetDataDirectory ( aur::ACPL::FileSpec & outDirectory )

Retrieves the path to the data directory. This is the directory with the name of the app-suite located in the Public User directory on Vista or the application directory on XP.

Parameters

outDirectory On returns contains the path to the directory. Is assumed to be 1024 wchar's big.

Returns: Error code when failed to retrieve the directory path.

Definition at line 181 of file AOI_Instance.cpp.

◆ GreekSize()

float AOI_Instance::GreekSize ( ) const

Sets the greek size value (the point size at which the text displayed on the screen is grayed out)

Definition at line 201 of file AOI_Instance.cpp.

◆ ResourceDirectory() [1/3]

const FileSpec AOI_Instance::ResourceDirectory ( )

Returns the full path to the currently set resource directory for this instance.

Returns: Pointer to Unicode full path to the resource directory.

Definition at line 168 of file AOI_Instance.cpp.

◆ ResourceDirectory() [2/3]

void AOI_Instance::ResourceDirectory ( const aur::ACPL::FileSpec & path )

Sets the path the directory that contains the resources needed by AOI. Default the resource path is set to ./bin

Parameters

path	File specifier of the resource directory.

Definition at line 146 of file AOI_Instance.cpp.

◆ ResourceDirectory() [3/3]

void AOI_Instance::ResourceDirectory ( const char16_t * path )

Sets the path the directory that contains the resources needed by AOI. Default the resource path is set to ./bin

Parameters

path	Unicode path to the resource directory.

Definition at line 157 of file AOI_Instance.cpp.

◆ SetErrorCallBack()

void AOI_Instance::SetErrorCallBack	(	ErrorCB	errorCallback,
		void *	ref )

Set the error handler routine. During loading of the document this routine is called to report any errors. The routine is called with the given ref pointer.

/param errorCallback Pointer to the error handling routine. /param ref Pointer to a private reference that will be passed to the error handling routine when called.

Definition at line 109 of file AOI_Instance.cpp.

◆ SetFontAntiAliasing()

void AOI_Instance::SetFontAntiAliasing ( bool useFontAntiAliasing )

Sets whether to use or not Font Antialiasing

Parameters

useFontAntiAliasing Set to true to render fonts below 144pt anti-aliased.

Definition at line 219 of file AOI_Instance.cpp.

◆ SetGreekSize()

void AOI_Instance::SetGreekSize ( float greekSize )

Gets the greek size value (the point size at which the text displayed on the screen is grayed out)

Definition at line 209 of file AOI_Instance.cpp.

◆ SetIGOR()

void AOI_Instance::SetIGOR ( bool on )

Sets if this instance will invoke IGOR (Intelligent Graphic Object Recognition) during loading. When set to false no translation of graphic elements to higher level objects will be done.

Parameters

on	True when IGOR must be invoked during loading, false when document is left untouched during loading.

See also: UseIGOR

Definition at line 135 of file AOI_Instance.cpp.

◆ SetProgressCallBack()

void AOI_Instance::SetProgressCallBack	(	ProgressionCB	progressionCallback,
		void *	ref )

Set the progress handler routine. During loading of the document this routine is called to report the progress. The routine is called with the given ref pointer.

/param progressionCallback Pointer to the progression handling routine. /param ref Pointer to a private reference that will be passed to the progress handling routine when called.

Definition at line 97 of file AOI_Instance.cpp.

◆ Startup()

AOI_Instance * AOI_Instance::Startup	(	const char *	instanceName,
		const char *	licenseKey,
		const char *	appSignature = NULL )

static

Creates the root instance at the beginning of the application. This instance is the main instance from which the instances for other threads are copied.

Parameters

instanceName	Unique name of the application creating the instance. To avoid conflicts with other application using AOI.
licenseKey	License key to allow the use of AOI and defines which options are available.
appSignature	Optional unique signature to identify the application to avoid conflicts in temporary files. When NULL is passed (default) then the default signature is used.

Returns: Instance object

Definition at line 58 of file AOI_Instance.cpp.

◆ Terminate()

void AOI_Instance::Terminate ( )

static

Destroys the root instance just before quitting the application.

Definition at line 68 of file AOI_Instance.cpp.

◆ UseFontAntiAliasing()

bool AOI_Instance::UseFontAntiAliasing ( ) const

Gets whether this instance uses or not FontAntiAliasing

Definition at line 227 of file AOI_Instance.cpp.

◆ UseIGOR()

bool AOI_Instance::UseIGOR ( ) const

Returns if this instance will invoke IGOR (Intelligent Graphic Object Recognition) during loading. When off no translation of graphic elements to higher level objects will be done.

Returns: True when IGOR is invoked during loading, false when document is untouched during loading.

See also: SetIGOR

Definition at line 122 of file AOI_Instance.cpp.

◆ Version()

int AOI_Instance::Version ( )

static

Returns the version of the AOI library. The format is encoded as:

Byte 0 : Major
Byte 1 : Minor
Byte 2-3 : Build

The build number is unique for each build. If Major or Minor differs then the API has changed.

Returns: Version number

Definition at line 84 of file AOI_Instance.cpp.

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

C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Instance.h
C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Instance.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AOI_Instance()

Member Function Documentation

◆ GetApplicationDirectory()

◆ GetDataDirectory()

◆ GreekSize()

◆ ResourceDirectory() [1/3]

◆ ResourceDirectory() [2/3]

◆ ResourceDirectory() [3/3]

◆ SetErrorCallBack()

◆ SetFontAntiAliasing()

◆ SetGreekSize()

◆ SetIGOR()

◆ SetProgressCallBack()

◆ Startup()

◆ Terminate()

◆ UseFontAntiAliasing()

◆ UseIGOR()

◆ Version()