DL Logo

PDBead Typedefs

PDBead

Header: PDExpT.h:3221

Description

A single rectangle in an article thread. (Article threads are known simply as articles in the Acrobat viewer's user interface). A bead remains valid as long as a thread is current and active.

Syntax

typedef OPAQUE_64_BITS PDBead;

Returned From

Used By

PDBead Functions

PDBeadAcquirePage

Header: PDProcs.h:4272

Description

Acquires the page on which a bead is located.

Related Methods

Syntax

PDPage PDBeadAcquirePage(PDBead bead, PDDoc pdDoc);

Parameters

bead
IN/OUT The bead whose page is acquired.
pdDoc
IN/OUT The document in which bead is located.

Returns

The page on which the bead resides. The acquired page must be freed using PDPageRelease() when it is no longer needed.

PDBeadDestroy

Header: PDProcs.h:4217

Description

Destroys a bead.

Related Methods

PDBeadFromCosObj PDBeadNew

Syntax

void PDBeadDestroy(PDBead bead);

Parameters

bead
IN/OUT The bead to destroy.

Exceptions

PDBeadEqual

Header: PDProcs.h:4357

Description

Tests two beads for equality. This method is useful to detect the end of a thread since the last bead in a thread points to the first.

Related Methods

Syntax

ASBool PDBeadEqual(PDBead bead, PDBead bead2);

Parameters

bead
The first bead to compare.
bead2
The second bead to compare.

Returns

true if the two beads are identical, false otherwise. Two beads are equal only if their Cos objects are equal (see CosObjEqual()).

PDBeadFromCosObj

Header: PDProcs.h:4384

Description

Gets the PDBead corresponding to a Cos object, after checking the bead's validity. This method does not copy the object, but is instead the logical equivalent of a type cast.

Related Methods

Syntax

PDBead PDBeadFromCosObj(CosObj obj);

Parameters

obj
The dictionary Cos object whose bead is obtained.

Returns

The PDBead object for the bead.

Exceptions

is raised if the bead is not valid, as determined by PDBeadIsValid().

PDBeadGetCosObj

Header: PDProcs.h:4371

Description

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

Related Methods

Syntax

CosObj PDBeadGetCosObj(PDBead bead);

Parameters

bead
IN/OUT The bead whose Cos object is obtained.

Returns

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

PDBeadGetIndex

Header: PDProcs.h:4343

Description

Gets the index of a bead in its thread.

Syntax

ASInt32 PDBeadGetIndex(PDBead bead);

Parameters

bead
IN/OUT The bead whose index is obtained.

Returns

The index of the bead in its thread. The first bead in a thread has an index of zero.

PDBeadGetNext

Header: PDProcs.h:4232

Description

Gets the next bead in a thread.

Related Methods

PDBeadEqual PDBeadGetPrev PDThreadGetFirstBead

Syntax

PDBead PDBeadGetNext(PDBead bead);

Parameters

bead
IN/OUT The bead for which the next bead is obtained.

Returns

The next bead, or a NULL Cos object (cast to a PDBead using PDBeadFromCosObj()). On the last bead, PDBeadGetNext() returns the first bead.

PDBeadGetPrev

Header: PDProcs.h:4247

Description

Gets the previous bead in a thread.

Related Methods

PDBeadEqual PDBeadGetNext PDThreadGetFirstBead

Syntax

PDBead PDBeadGetPrev(PDBead bead);

Parameters

bead
IN/OUT The bead for which the previous bead is obtained.

Returns

The previous bead, or a NULL Cos object (cast to a PDBead using PDBeadFromCosObj()) if this is the first bead in the thread.

PDBeadGetRect

Header: PDProcs.h:4295

Description

Gets a bead's bounding rectangle.

Syntax

void PDBeadGetRect(PDBead bead, ASFixedRectP rectP);

Parameters

bead
IN/OUT The bead whose bounding rectangle is obtained.
rectP
IN/OUT (Filled by the method) A pointer to a ASFixedRect specifying the bead's bounding rectangle, specified in user space coordinates.

PDBeadGetThread

Header: PDProcs.h:4333

Description

Gets the thread containing the specified bead.

Related Methods

PDBeadGetIndex PDBeadGetNext PDBeadGetPrev PDBeadGetRect

Syntax

PDThread PDBeadGetThread(PDBead bead);

Parameters

bead
IN/OUT The bead whose thread is obtained.

Returns

The bead's thread, or a NULL Cos object if the bead does not belong to a thread.

PDBeadInsert

Header: PDProcs.h:4259

Description

Inserts a bead after the specified bead.

Related Methods

PDBeadNew PDThreadSetFirstBead

Syntax

void PDBeadInsert(PDBead bead, PDBead newNext);

Parameters

bead
IN/OUT The bead after which newNext will be inserted.
newNext
IN/OUT The bead to insert.

PDBeadIsValid

Header: PDProcs.h:4319

Description

Tests a bead's validity. This is intended only to ensure that the bead has not been deleted, not to ensure that all necessary information is present and valid.

Related Methods

Syntax

ASBool PDBeadIsValid(PDBead bead);

Parameters

bead
The bead whose validity is tested.

Returns

true if the bead is valid, false otherwise.

PDBeadNew

Header: PDProcs.h:4206

Description

Creates a new bead on the specified page. The newly created bead is not linked to a thread or another bead. Use PDThreadSetFirstBead() to make the bead the first bead in a thread. Use PDBeadInsert() to link it to another bead.

Related Methods

PDBeadDestroy PDBeadFromCosObj PDBeadInsert PDThreadSetFirstBead

Syntax

PDBead PDBeadNew(PDPage page, const ASFixedRectP destRect);

Parameters

page
The page on which the bead is created.
destRect
A pointer to a ASFixedRect specifying the bead's bounding rectangle, specified in user space coordinates.

Returns

The newly created bead.

PDBeadSetPage

Header: PDProcs.h:4283

Description

Sets the page for a bead.

Related Methods

Syntax

void PDBeadSetPage(PDBead bead, PDPage newPage);

Parameters

bead
IN/OUT The bead whose page is set.
newPage
IN/OUT The page on which bead is located.

Exceptions

PDBeadSetRect

Header: PDProcs.h:4308

Description

Sets a bead's bounding rectangle.

Related Methods

PDBeadGetRect PDBeadSetPage

Syntax

void PDBeadSetRect(PDBead bead, const ASFixedRectP newDestRect);

Parameters

bead
IN/OUT The bead whose bounding rectangle is set.
newDestRect
IN/OUT A pointer to a ASFixedRect specifying the bead's bounding rectangle, specified in user space coordinates.