LayerAV_Layer
ObjectUNIX

The core API also includes UNIX-specific utility methods, which are only available for plug-ins. These methods allow a plug-in to:


Define Summary
 Define
 UnixAppAddModifierCallbackSEL (UNIX)
 UnixAppClipboardGetItemIdSEL (UNIX)
 UnixAppDispatchEventSEL (UNIX)
 UnixAppGetAppShellGtkWidgetSEL (UNIX)
 UnixAppGetAppShellWidgetSEL (UNIX)
 UnixAppGetPlugInFilenameSEL (UNIX)
 UnixAppLoadPlugInAppDefaultsSEL (UNIX)
 UnixAppProcessEventSEL (UNIX)
 UnixAppRemoveModifierCallbackSEL (UNIX)
 UnixAppWaitForWmSEL (UNIX)
 _UnixHFT_IS_BETA (UNIX)
 _UnixHFT_LATEST_VERSION (UNIX)
 UnixHFT_LATEST_VERSION (UNIX)
 UnixHFT_VERSION_4 (UNIX)
 UnixHFT_VERSION_5 (UNIX)
 UnixHFT_VERSION_8 (UNIX)
 UNIX_PLATFORM (UNIX)
(UNIX only) Defined if the client is being compiled for a UNIX platform, undefined otherwise. MAC_PLATFORM, WIN_PLATFORM, and UNIX_PLATFORM should be used by client developers to conditionally compile platform-dependent code.
 UnixSysGetConfigNameSEL (UNIX)
 UnixSysGetCursorSEL (UNIX)
 UnixSysGetCwdSEL (UNIX)
 UnixSysGetHomeDirectorySEL (UNIX)
 UnixSysGetHostnameSEL (UNIX)
 UnixSysGetIconSEL (UNIX)
 UnixSysGetInstallDirectorySEL (UNIX)
 UnixSysGetPixmapSEL (UNIX)
 UnixSysGetStringSEL (UNIX)
 UnixSysGetTempFileDirectorySEL (UNIX)
 UnixSysPrefInitSEL (UNIX)
 UnixSysPrefUpdateSEL (UNIX)
Typedef Summary
 Typedef
 UnixPort (UNIX)
 UnixPortRec (UNIX)
Structure Summary
 Structure
 _t_UnixPort (UNIX)
Callback Summary
 Callback
 UnixAppAddModifierCallbackSELPROTO (UNIX)
 UnixAppClipboardGetItemIdSELPROTO (UNIX)
Not supported. If you wanted this for the selection server Gtk is the preferred way.
 UnixAppDispatchEventSELPROTO (UNIX)
Not supported. Not required with Gtk. Try gtk_main, or better still, g_main_context_iteration(NULL, FALSE).
 UnixAppGetAppShellGtkWidgetSELPROTO (UNIX)
Gets the topmost widget of the application. The window is of the type GtkWindow.
 UnixAppGetAppShellWidgetSELPROTO (UNIX)
Not supported due to movement to Gtk. If you wanted this for a dialog, ADM is the preferred way now.
 UnixAppGetModalParentSELPROTO (UNIX)
Retrieves an appropriate top-level parent window, from which a modal dialog can be parented.
 UnixAppGetModelessParentSELPROTO (UNIX)
Returns an appropriate top-level parent window, from which a dialog can be parented.
 UnixAppGetPlugInFilenameSELPROTO (UNIX)
Gets the plug-in's file name. The directory can be used to find auxiliary files for that plug-in.
 UnixAppLoadPlugInAppDefaultsSELPROTO (UNIX)
Not Supported.
 UnixAppProcessEventSELPROTO (UNIX)
Not supported. Not required with Gtk. Try gtk_main, or better still, g_main_context_iteration(NULL, FALSE).
 UnixAppRemoveModifierCallbackSELPROTO (UNIX)
Not supported.
 UnixAppWaitForWmSELPROTO (UNIX)
Not supported.
 UnixSysGetConfigNameSELPROTO (UNIX)
Gets the Acrobat viewer's configuration name.
 UnixSysGetCursorSELPROTO (UNIX)
Not supported.
 UnixSysGetCwdSELPROTO (UNIX)
Gets the current working directory. This method tries to eliminate automounter tmp directories and symbol links. Using stat, it checks if the environment variable PWD specifies the same directory returned by getcwd.
 UnixSysGetHomeDirectorySELPROTO (UNIX)
Gets the home directory of the user running the Acrobat viewer. If the HOME environment variable is set, its value is returned. Otherwise the method looks in the passwd database.
 UnixSysGetHostnameSELPROTO (UNIX)
Gets the host name.
 UnixSysGetIconSELPROTO (UNIX)
Not supported. The Icons should be bundled as a resource.
 UnixSysGetInstallDirectorySELPROTO (UNIX)
Gets the directory in which the Acrobat viewer is installed. The launch shell script sets the installation directory in the environment variable ACRO_INSTALL_DIR.
 UnixSysGetPixmapSELPROTO (UNIX)
Not supported.
 UnixSysGetStringSELPROTO (UNIX)
Not supported. The strings can be handled as resources.
 UnixSysGetTempFileDirectorySELPROTO (UNIX)
Gets the temporary file directory specified by the user. The default is "/tmp".
 UnixSysPrefInitSELPROTO (UNIX)
Not supported
 UnixSysPrefUpdateSELPROTO (UNIX)
Not supported.
Defines Detail
_UnixHFT_IS_BETA 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define _UnixHFT_IS_BETA 0
File: UnixCalls.h
Line: 88
_UnixHFT_LATEST_VERSION 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define _UnixHFT_LATEST_VERSION 0x00080000
File: UnixCalls.h
Line: 87
UNIX_PLATFORM 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UNIX_PLATFORM 1
Description

(UNIX only) Defined if the client is being compiled for a UNIX platform, undefined otherwise. MAC_PLATFORM, WIN_PLATFORM, and UNIX_PLATFORM should be used by client developers to conditionally compile platform-dependent code.

UNIX_PLATFORM must be defined in the arguments to the C compiler. The make files for the sample clients in the Acrobat SDK do this automatically.

See Also

MAC_PLATFORM
WIN_PLATFORM

File: UnixPlatform.h
Line: 139
UnixAppAddModifierCallbackSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppAddModifierCallbackSEL 18
File: UnixCalls.h
Line: 357
UnixAppClipboardGetItemIdSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppClipboardGetItemIdSEL 3
File: UnixCalls.h
Line: 136
UnixAppDispatchEventSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppDispatchEventSEL 4
File: UnixCalls.h
Line: 147
UnixAppGetAppShellGtkWidgetSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppGetAppShellGtkWidgetSEL 22
File: UnixCalls.h
Line: 400
UnixAppGetAppShellWidgetSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppGetAppShellWidgetSEL 1
File: UnixCalls.h
Line: 114
UnixAppGetPlugInFilenameSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppGetPlugInFilenameSEL 7
File: UnixCalls.h
Line: 180
UnixAppLoadPlugInAppDefaultsSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppLoadPlugInAppDefaultsSEL 2
File: UnixCalls.h
Line: 125
UnixAppProcessEventSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppProcessEventSEL 5
File: UnixCalls.h
Line: 158
UnixAppRemoveModifierCallbackSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppRemoveModifierCallbackSEL 19
File: UnixCalls.h
Line: 367
UnixAppWaitForWmSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixAppWaitForWmSEL 6
File: UnixCalls.h
Line: 169
UnixHFT_LATEST_VERSION 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixHFT_LATEST_VERSION _UnixHFT_LATEST_VERSION)
File: UnixCalls.h
Line: 91
UnixHFT_VERSION_4 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixHFT_VERSION_4 0x00040000
File: UnixCalls.h
Line: 93
UnixHFT_VERSION_5 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixHFT_VERSION_5 0x00040001
File: UnixCalls.h
Line: 94
UnixHFT_VERSION_8 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixHFT_VERSION_8 0x00080000
File: UnixCalls.h
Line: 95
UnixSysGetConfigNameSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetConfigNameSEL 10
File: UnixCalls.h
Line: 240
UnixSysGetCursorSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetCursorSEL 15
File: UnixCalls.h
Line: 324
UnixSysGetCwdSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetCwdSEL 13
File: UnixCalls.h
Line: 296
UnixSysGetHomeDirectorySEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetHomeDirectorySEL 8
File: UnixCalls.h
Line: 201
UnixSysGetHostnameSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetHostnameSEL 11
File: UnixCalls.h
Line: 269
UnixSysGetIconSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetIconSEL 16
File: UnixCalls.h
Line: 335
UnixSysGetInstallDirectorySEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetInstallDirectorySEL 9
File: UnixCalls.h
Line: 219
UnixSysGetPixmapSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetPixmapSEL 17
File: UnixCalls.h
Line: 346
UnixSysGetStringSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetStringSEL 14
File: UnixCalls.h
Line: 313
UnixSysGetTempFileDirectorySEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysGetTempFileDirectorySEL 12
File: UnixCalls.h
Line: 282
UnixSysPrefInitSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysPrefInitSEL 20
File: UnixCalls.h
Line: 378
UnixSysPrefUpdateSEL 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

#define UnixSysPrefUpdateSEL 21
File: UnixCalls.h
Line: 389

Typedefs Detail
UnixPort 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

typedef _t_UnixPort UnixPort;

File: AVExpT.h
Line: 917
UnixPortRec 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

typedef _t_UnixPort UnixPortRec;

File: AVExpT.h
Line: 917


Structure Detail
_t_UnixPort
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

struct _t_UnixPort {
 Window drawable; 
 
 Display* display; 
 
 Screen* screen; 
 
 GC gc; 
 
 ASInt32 originX; 
 
 ASInt32 originY; 
}

File: AVExpT.h
Line: 910

Callbacks Detail
UnixAppAddModifierCallbackSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixAppAddModifierCallbackSELPROTO)(XtCallbackProc callback, XtPointer closure)

File: UnixCalls.h
Line: 363
UnixAppClipboardGetItemIdSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

long (*UnixAppClipboardGetItemIdSELPROTO)(Display **displayPtr, Window *windowPtr)

Not supported. If you wanted this for the selection server Gtk is the preferred way.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 143
UnixAppDispatchEventSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

Boolean (*UnixAppDispatchEventSELPROTO)(XEvent *eventPtr)

Not supported. Not required with Gtk. Try gtk_main, or better still, g_main_context_iteration(NULL, FALSE).

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 154
UnixAppGetAppShellGtkWidgetSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

GtkWidget * (*UnixAppGetAppShellGtkWidgetSELPROTO)(void)

Gets the topmost widget of the application. The window is of the type GtkWindow.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 408
UnixAppGetAppShellWidgetSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

Widget (*UnixAppGetAppShellWidgetSELPROTO)(void)

Not supported due to movement to Gtk. If you wanted this for a dialog, ADM is the preferred way now.

See Also

UnixAppGetAppShellGtkWidget

File: UnixCalls.h
Line: 121
UnixAppGetModalParentSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

GtkWidget * (*UnixAppGetModalParentSELPROTO)(AVDoc avdoc)

Retrieves an appropriate top-level parent window, from which a modal dialog can be parented.


File: UnixCalls.h
Line: 416
UnixAppGetModelessParentSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

GtkWidget * (*UnixAppGetModelessParentSELPROTO)(void)

Returns an appropriate top-level parent window, from which a dialog can be parented.


File: UnixCalls.h
Line: 423
UnixAppGetPlugInFilenameSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixAppGetPlugInFilenameSELPROTO)(ExtensionID thePI)

Gets the plug-in's file name. The directory can be used to find auxiliary files for that plug-in.

The Acrobat viewer searches all the directories specified in the systemPlugInPath and userPlugInPath resources to find plug-ins.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 197
UnixAppLoadPlugInAppDefaultsSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixAppLoadPlugInAppDefaultsSELPROTO)(String className, String *fallbackResources)

Not Supported.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 132
UnixAppProcessEventSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixAppProcessEventSELPROTO)(XtAppContext appContext, XtInputMask mask)

Not supported. Not required with Gtk. Try gtk_main, or better still, g_main_context_iteration(NULL, FALSE).

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 165
UnixAppRemoveModifierCallbackSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixAppRemoveModifierCallbackSELPROTO)(XtCallbackProc callback, XtPointer closure)

Not supported.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 374
UnixAppWaitForWmSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixAppWaitForWmSELPROTO)(Widget shellWidget)

Not supported.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 176
UnixSysGetConfigNameSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetConfigNameSELPROTO)(void)

Gets the Acrobat viewer's configuration name.

The name will be one of the following:

Operating system

Configuration name

SunOS

sparcsun

Solaris

sparcsolaris

HP-UX

hppahpux

Linux

intellinux

IBM AIX

rs6000aix

Auxiliary files can be found by concatenating the installation directory with the configuration name sub-directory:

"< installation_dir>/< config_name>"

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 265
UnixSysGetCursorSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

Cursor (*UnixSysGetCursorSELPROTO)(Widget widget, char *resourceName, char *defaultName, char *defaultBits, char *defaultMaskBits, unsigned int defaultWidth, unsigned int defaultHeight, int defaultHotX, int defaultHotY)

Not supported.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 331
UnixSysGetCwdSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetCwdSELPROTO)(void)

Gets the current working directory. This method tries to eliminate automounter tmp directories and symbol links. Using stat, it checks if the environment variable PWD specifies the same directory returned by getcwd.

See Also

UnixSysGetHomeDirectory

Exceptions

genErrNoMemory

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 309
UnixSysGetHomeDirectorySELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetHomeDirectorySELPROTO)(void)

Gets the home directory of the user running the Acrobat viewer. If the HOME environment variable is set, its value is returned. Otherwise the method looks in the passwd database.

See Also

UnixSysGetCwd
UnixSysGetHostname

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 215
UnixSysGetHostnameSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetHostnameSELPROTO)(void)

Gets the host name.

See Also

UnixSysGetHomeDirectory

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 278
UnixSysGetIconSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

Pixmap (*UnixSysGetIconSELPROTO)(Widget widget, char *resourceName, char *defaultName, char *defaultBits, unsigned int defaultWidth, unsigned int defaultHeight)

Not supported. The Icons should be bundled as a resource.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 342
UnixSysGetInstallDirectorySELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetInstallDirectorySELPROTO)(void)

Gets the directory in which the Acrobat viewer is installed. The launch shell script sets the installation directory in the environment variable ACRO_INSTALL_DIR.

Auxiliary files can be found by concatenating the installation directory with the configuration name sub-directory:

"< installation_dir>/< config_name>"

See Also

UnixSysGetHomeDirectory

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 236
UnixSysGetPixmapSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

Pixmap (*UnixSysGetPixmapSELPROTO)(Widget widget, char *resourceName, char *defaultFilename, char **defaultXpmData, int defaultXpmDataCount, unsigned int *widthPtr, unsigned int *heightPtr)

Not supported.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 353
UnixSysGetStringSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetStringSELPROTO)(Widget widget, char *resourceName, char *defaultString)

Not supported. The strings can be handled as resources.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 320
UnixSysGetTempFileDirectorySELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

char * (*UnixSysGetTempFileDirectorySELPROTO)(void)

Gets the temporary file directory specified by the user. The default is "/tmp".

See Also

UnixSysGetHomeDirectory

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 292
UnixSysPrefInitSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixSysPrefInitSELPROTO)(Widget widget, String name, String Xclass, char *prefFilename, XtResourceList resources, Cardinal numResources, XtPointer base, XrmDatabase *dbPtr, void **resourceDataPtr)

Not supported

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 385
UnixSysPrefUpdateSELPROTO 
Product availability: Acrobat, Reader
Platform availability: UNIX

Syntax

void (*UnixSysPrefUpdateSELPROTO)(Widget widget, char *prefFilename, XtPointer base, XtResourceList resources, Cardinal numResources, void *resourceData)

Not supported.

Since

PI_UNIX_VERSION >= 0x00020000

File: UnixCalls.h
Line: 396




© 2004-2013 Adobe Systems Incorporated. All rights reserved.
Thu Jan 21 2016, 11:19 AM IST