PD Layer: PDThread

PDThread Typedefs

PDThread

Header: PDExpT.h:3207

Description

An article in the Acrobat viewer's user interface. It contains an ordered sequence of rectangles that bound the article. Each rectangle is called a bead. Threads can be created either interactively, by the user, or programmatically.

Related Methods

PDDocRemoveThread

Syntax

typedef OPAQUE_64_BITS PDThread;

Returned From

Used By

PDThread Functions

PDThreadDestroy: - Deletes an article thread from its document.
PDThreadFromCosObj: - Gets the thread object corresponding to the specified Cos object.
PDThreadGetCosObj: - Gets the Cos object corresponding to a thread.
PDThreadGetFirstBead: - Gets an article thread's first bead.
PDThreadGetInfo: - Gets the specified article thread's info.
PDThreadGetInfoASText: - Gets the specified article thread's info as an ASText object.
PDThreadIsValid: - Tests whether a thread is valid.
PDThreadNew: - Creates a new article thread.
PDThreadSetFirstBead: - Sets an article thread's first bead.
PDThreadSetInfo: - Sets the specified article thread's info.
PDThreadSetInfoASText: - Sets the specified article thread's info.

PDThreadDestroy

Header: PDProcs.h:4086

Description

Deletes an article thread from its document. You must call PDDocRemoveThread() to remove the thread from the document (if it was added to one using PDDocAddThread()) before calling PDThreadDestroy().

Syntax

void PDThreadDestroy(PDThread thread);

Parameters

thread

IN/OUT The thread to destroy.

PDThreadFromCosObj

Header: PDProcs.h:4189

Description

Gets the thread object corresponding to the specified Cos object. This method does not copy the object, but is instead the logical equivalent of a type cast.

Related Methods

PDThreadGetCosObj

Syntax

PDThread PDThreadFromCosObj(CosObj obj);

Parameters

obj

The dictionary Cos object for the thread.

Returns

The PDThread object for the thread.

Exceptions

pdErrBadThread

is raised if the thread is not valid as defined by PDThreadIsValid.

PDThreadGetCosObj

Header: PDProcs.h:4176

Description

Gets the Cos object corresponding to a thread. This method does not copy the object, but is instead the logical equivalent of a type cast.

Related Methods

CosObjEnum PDThreadFromCosObj

Syntax

CosObj PDThreadGetCosObj(PDThread thread);

Parameters

thread

IN/OUT The thread whose Cos object is to obtained.

Returns

The dictionary Cos object for the thread. The contents of the dictionary can be enumerated using CosObjEnum(). It returns a NULL Cos object if PDThreadIsValid(thread) returns false.

PDThreadGetFirstBead

Header: PDProcs.h:4100

Description

Gets an article thread's first bead.

Syntax

PDBead PDThreadGetFirstBead(PDThread thread);

Parameters

thread

IN/OUT The thread whose first bead is obtained.

Returns

The thread's first bead, or a NULL Cos object if the thread has no beads.

PDThreadGetInfo

Header: PDProcs.h:4132

Description

Gets the specified article thread's info.

Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.

Related Methods

PDThreadSetInfo

Syntax

ASInt32 PDThreadGetInfo(PDThread thread, const char *infoKey, char *buffer, ASInt32 bufSize);

Parameters

`thread`	IN/OUT The thread whose thread info is obtained.
`infoKey`	IN/OUT The key whose value is obtained.
`buffer`	IN/OUT (Filled by the method) The value associated with `infoKey`.
`bufSize`	IN/OUT The maximum number of characters that `buffer` can hold.

Returns

The number of characters written into buffer.

PDThreadGetInfoASText

Header: PDProcs.h:11735

Description

Gets the specified article thread's info as an ASText object.

Syntax

void PDThreadGetInfoASText(PDThread thread, const ASText infoKey, ASText value);

Parameters

`thread`	The thread whose thread info is being obtained.
`infoKey`	The key whose value is being obtained.
`value`	(Filled by the method) The text object containing the value associated with `infoKey` is set. The client must pass a valid ASText object value. The routine does not allocate it.

PDThreadIsValid

Header: PDProcs.h:4159

Description

Tests whether a thread is valid. This is intended only to ensure that the thread has not been deleted, not to ensure that all necessary information is present and valid.

Syntax

ASBool PDThreadIsValid(PDThread thread);

Parameters

thread

The thread whose validity is tested.

Returns

true if the thread is valid, false otherwise.

PDThreadNew

Header: PDProcs.h:4072

Description

Creates a new article thread. Use PDDocAddThread() to add the thread to a document.

Syntax

PDThread PDThreadNew(PDDoc aDocP);

Parameters

aDocP

The document in which the thread is created.

Returns

The newly created thread.

PDThreadSetFirstBead

Header: PDProcs.h:4112

Description

Sets an article thread's first bead.

Related Methods

PDBeadInsert PDThreadGetFirstBead

Syntax

void PDThreadSetFirstBead(PDThread thread, PDBead newFirstBead);

Parameters

`thread`	IN/OUT The thread whose first bead is set.
`newFirstBead`	IN/OUT The bead to use as the first in thread.

PDThreadSetInfo

Header: PDProcs.h:4149

Description

Sets the specified article thread's info.

Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.

Related Methods

PDThreadGetInfo

Syntax

void PDThreadSetInfo(PDThread thread, const char *infoKey, const char *buffer, ASInt32 bufSize);

Parameters

`thread`	IN/OUT The thread whose thread info is set.
`infoKey`	IN/OUT The key whose value is set.
`buffer`	IN/OUT The value to set.
`bufSize`	IN/OUT The number of characters in `buffer`.

PDThreadSetInfoASText

Header: PDProcs.h:11750

Description

Sets the specified article thread's info.

Syntax

void PDThreadSetInfoASText(PDThread thread, const ASText infoKey, const ASText value);

Parameters

`thread`	The thread whose thread info is being set.
`infoKey`	The key whose value is being set.
`value`	The text object containing the value to set.