LayerPD_Layer
ObjectPDThumb

A PDThumb is a thumbnail preview image of a page.



Typedef Summary
 Typedef
 PDThumb
A thumbnail preview image of a page.
 PDThumbCreationServer
 PDThumbCreationServerRec
Structure Summary
 Structure
 _t_PDThumbCreationServer
A data structure containing callbacks that implement a creation server. The callbacks implement the creation server functions.
Callback Summary
 Callback
 PDThumbCreationDrawThumbProc
(Optional) A callback for PDThumbCreationServer. It is called after PDThumbCreationGetThumbDataProc() and after a PDThumb has been created. It gives the server a chance to draw the thumbnail image in a status window. It may be NULL.
 PDThumbCreationGetThumbDataProc
(Optional) A callback for PDThumbCreationServer. It is called for each page that does not currently contain a thumbnail image. It may be NULL. If it is NULL, the thumbnail data is generated by the default thumbnail generator.
 PDThumbCreationNotifyPageProc
(Optional) A callback for PDThumbCreationServer. It is called before processing each page. It may be NULL.
Method Summary
 Method
 
ASStm PDThumbGetImageData(PDThumb thumb, ASInt32* height, ASInt32* width, ASInt32* bpc, ASAtom* csName)
Gets an ASStm from a thumbnail data.
 
ASStm PDThumbGetIndexedColorSpace(PDThumb thumb, ASInt32* hival, ASAtom* baseColorSpaceName)
Gets an ASStm from a thumbnail's indexed color space table.

Typedefs Detail
PDThumb 
Product availability: All
Platform availability: All

Syntax

typedef struct _t_PDThumb* PDThumb;

A thumbnail preview image of a page.

See Also


File: PDBasicExpT.h
Line: 113
PDThumbCreationServer 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDThumbCreationServer PDThumbCreationServer;

File: PDExpT.h
Line: 3229
PDThumbCreationServerRec 
Product availability: All
Platform availability: All

Syntax

typedef _t_PDThumbCreationServer PDThumbCreationServerRec;

File: PDExpT.h
Line: 3244


Structure Detail
_t_PDThumbCreationServer
Product availability: All
Platform availability: All

Syntax

struct _t_PDThumbCreationServer {
 ASSize_t size; 
 
 PDThumbCreationNotifyPageProc NotifyPage; 
 
 PDThumbCreationGetThumbDataProc GetThumbData; 
 
 PDThumbCreationDrawThumbProc DrawThumb; 
}

A data structure containing callbacks that implement a creation server. The callbacks implement the creation server functions.

See Also


File: PDExpT.h
Line: 3235

Elements
size  

Set this field to sizeof(PDThumbCreationServerRec).

 
Callbacks Detail
PDThumbCreationDrawThumbProc 
Product availability: All
Platform availability: All

Syntax

void (*PDThumbCreationDrawThumbProc)(PDThumb thumb, void *clientData)

(Optional) A callback for PDThumbCreationServer. It is called after PDThumbCreationGetThumbDataProc() and after a PDThumb has been created. It gives the server a chance to draw the thumbnail image in a status window. It may be NULL.

See Also


File: PDExpT.h
Line: 3227
PDThumbCreationGetThumbDataProc 
Product availability: All
Platform availability: All

Syntax

ASBool (*PDThumbCreationGetThumbDataProc)(PDPage page, ASFixed thumbScale, ASInt32 width, ASInt32 height, void *thumbData, void *clientData)

(Optional) A callback for PDThumbCreationServer. It is called for each page that does not currently contain a thumbnail image. It may be NULL. If it is NULL, the thumbnail data is generated by the default thumbnail generator.

See Also


File: PDExpT.h
Line: 3213
PDThumbCreationNotifyPageProc 
Product availability: All
Platform availability: All

Syntax

ASBool (*PDThumbCreationNotifyPageProc)(ASInt32 pageNum, void *clientData)

(Optional) A callback for PDThumbCreationServer. It is called before processing each page. It may be NULL.

See Also


File: PDExpT.h
Line: 3178

Method Detail
PDThumbGetImageData()
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASStm PDThumbGetImageData(PDThumb thumb, ASInt32* height, ASInt32* width, ASInt32* bpc, ASAtom* csName)

Gets an ASStm from a thumbnail data.

Parameters

thumb — 

The thumb for which image data is to be retrieved.

 
height — 

(Filled by the method) The height of the thumbnail.

 
width — 

(Filled by the method) The width of the thumbnail.

 
bpc — 

(Filled by the method) The number of bits per component in the thumbnail image's data.

 
csName — 

(Filled by the method) The color space in which thumnail data is represented.

Returns

An ASStm for the thumbnail data.

See Also


File: PDProcs.h
Line: 11686
PDThumbGetIndexedColorSpace() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASStm PDThumbGetIndexedColorSpace(PDThumb thumb, ASInt32* hival, ASAtom* baseColorSpaceName)

Gets an ASStm from a thumbnail's indexed color space table.

Parameters

thumb — 

The thumb for which image data is to be retrieved.

 
hival — 

(Filled by the method) The highest valid index in the lookup table for the Indexed color space.

 
baseColorSpaceName — 

(Filled by the method) The base color space in which the values in the color table are to be interpreted.

Returns

An ASStm from the thumbnail's indexed color space table.

See Also


File: PDProcs.h
Line: 11700