API Guide Home (Online version only) |

# ImageLibCommon.h File Reference

## Detailed Description

Public 68k common header file for the Image Library API on Treo 600 devices.

Version:
  1.0

This file contains common defines and error codes to be used with Imaging Library API.

Definition in file ImageLibCommon.h.

Include dependency graph for ImageLibCommon.h:

Go to the source code of this file.

## Defines

- #define ImageLibCreatorID 'imgL'
- #define ImageLibTypeID 'libr'
- #define ImageLibName "ImageLibrary"
- #define kInvalidRecIndex ((UInt16)0xFFFF )
- #define kImageFilenameLength (dmDBNameLength)

Preview Image Dimensions
Preview height and width in standard pixels. On a double density device, the bitmap returned would be twice these dimensions.

- #define kPalmSizeImageWidth 160
- #define kPalmSizeImageHeight 120
- #define kFullSizeImageWidth 640
- #define kFullSizeImageHeight 480
- #define kThumbnailImageWidth 40
- #define kThumbnailImageHeight 30
- #define kPreviewBitmapWidth (kPalmSizeImageWidth)
- #define kPreviewBitmapHeight (kPalmSizeImageHeight)

Sort Orders

- #define kNoSortOrder (0)
- #define kSortByName (1)
- #define kSortByDate (2)
- #define kSortByNameDesc (3)
- #define kSortByDateDesc (4)

Image Operation Codes

- #define kResizeOperation (0)
- #define kJPEGOperation (1)
- #define kVFSOperation (2)

Error Codes

- #define imageLibErrorClass (appErrorClass | 0x1000)
- #define imageLibErrBadParam (imageLibErrorClass)
- #define imageLibErrNoCamera (imageLibErrorClass + 1)
- #define imageLibErrInternalFailure (imageLibErrorClass + 2)
- #define imageLibErrWriteFailure (imageLibErrorClass + 3)
- #define imageLibErrReadFailure (imageLibErrorClass + 4)
- #define imageLibErrBadData (imageLibErrorClass + 5)
- #define imageLibErrBadImageType (imageLibErrorClass + 6)
- #define imageLibErrBadImageDepth (imageLibErrorClass + 7)
- #define imageLibErrBadDimensions (imageLibErrorClass + 8)
- #define imageLibErrInitializationFailed (imageLibErrorClass + 9)
- #define imageLibErrBadColorspace (imageLibErrorClass + 10)
- #define imageLibErrBadThumbnailType (imageLibErrorClass + 11)
- #define imageLibErrThumnailExists (imageLibErrorClass + 12)
- #define imageLibErrBadScaleFactor (imageLibErrorClass + 13)
- #define imageLibErrBadBitmapType (imageLibErrorClass + 14)
- #define imageLibErrImageAlreadyDownsized (imageLibErrorClass + 15)
- #define imageLibErrImageLocked (imageLibErrorClass + 16)

## Typedefs

- typedef void * ImageIteratorHandle
- typedef void(*) ImageLibProgressCallbackType (Int32 progress, Int32 max, Int8 operation)

## Define Documentation

#define ImageLibCreatorID 'imgL'

Imaging library creator ID

Definition at line 56 of file ImageLibCommon.h.

#define imageLibErrBadBitmapType (imageLibErrorClass + 14)

Definition at line 125 of file ImageLibCommon.h.

#define imageLibErrBadColorspace (imageLibErrorClass + 10)

Definition at line 121 of file ImageLibCommon.h.

#define imageLibErrBadData (imageLibErrorClass + 5)

Definition at line 116 of file ImageLibCommon.h.

#define imageLibErrBadDimensions (imageLibErrorClass + 8)

Definition at line 119 of file ImageLibCommon.h.

#define imageLibErrBadImageDepth (imageLibErrorClass + 7)

Definition at line 118 of file ImageLibCommon.h.

#define imageLibErrBadImageType (imageLibErrorClass + 6)

Definition at line 117 of file ImageLibCommon.h.

#define imageLibErrBadParam (imageLibErrorClass)

Definition at line 111 of file ImageLibCommon.h.

#define imageLibErrBadScaleFactor (imageLibErrorClass + 13)

Definition at line 124 of file ImageLibCommon.h.

#define imageLibErrBadThumbnailType (imageLibErrorClass + 11)

Definition at line 122 of file ImageLibCommon.h.

#define imageLibErrImageAlreadyDownsized (imageLibErrorClass + 15)

Definition at line 126 of file ImageLibCommon.h.

#define imageLibErrImageLocked (imageLibErrorClass + 16)

Definition at line 127 of file ImageLibCommon.h.

#define imageLibErrInitializationFailed (imageLibErrorClass + 9)

Definition at line 120 of file ImageLibCommon.h.

#define imageLibErrInternalFailure (imageLibErrorClass + 2)

Definition at line 113 of file ImageLibCommon.h.

#define imageLibErrNoCamera (imageLibErrorClass + 1)

Definition at line 112 of file ImageLibCommon.h.

#define imageLibErrorClass (appErrorClass | 0x1000)

Definition at line 110 of file ImageLibCommon.h.

#define imageLibErrReadFailure (imageLibErrorClass + 4)

Definition at line 115 of file ImageLibCommon.h.

#define imageLibErrThumnailExists (imageLibErrorClass + 12)

Definition at line 123 of file ImageLibCommon.h.

#define imageLibErrWriteFailure (imageLibErrorClass + 3)

Definition at line 114 of file ImageLibCommon.h.

#define ImageLibName "ImageLibrary"

Imaging library database name

Definition at line 58 of file ImageLibCommon.h.

#define ImageLibTypeID 'libr'

Standard library type

Definition at line 57 of file ImageLibCommon.h.

#define kFullSizeImageHeight 480

Definition at line 69 of file ImageLibCommon.h.

#define kFullSizeImageWidth 640

Definition at line 68 of file ImageLibCommon.h.

#define kImageFilenameLength (dmDBNameLength)

max filename length

Definition at line 78 of file ImageLibCommon.h.

#define kInvalidRecIndex ((UInt16)0xFFFF )

define for invalid record index

Definition at line 76 of file ImageLibCommon.h.

#define kJPEGOperation (1)

Definition at line 96 of file ImageLibCommon.h.

#define kNoSortOrder (0)

Definition at line 84 of file ImageLibCommon.h.

#define kPalmSizeImageHeight 120

Definition at line 67 of file ImageLibCommon.h.

#define kPalmSizeImageWidth 160

Definition at line 66 of file ImageLibCommon.h.

#define kPreviewBitmapHeight (kPalmSizeImageHeight)

Definition at line 73 of file ImageLibCommon.h.

#define kPreviewBitmapWidth (kPalmSizeImageWidth)

Definition at line 72 of file ImageLibCommon.h.

#define kResizeOperation (0)

Definition at line 95 of file ImageLibCommon.h.

#define kSortByDate (2)

Definition at line 86 of file ImageLibCommon.h.

#define kSortByDateDesc (4)

Definition at line 88 of file ImageLibCommon.h.

#define kSortByName (1)

Definition at line 85 of file ImageLibCommon.h.

#define kSortByNameDesc (3)

Definition at line 87 of file ImageLibCommon.h.

#define kThumbnailImageHeight 30

Definition at line 71 of file ImageLibCommon.h.

#define kThumbnailImageWidth 40

Definition at line 70 of file ImageLibCommon.h.

#define kVFSOperation (2)

Definition at line 97 of file ImageLibCommon.h.

## Typedef Documentation

typedef void* ImageIteratorHandle

Handle returned by ImageLibIterateImages or ImageLibIterateVFSImages.

Definition at line 101 of file ImageLibCommon.h.

typedef void(*) ImageLibProgressCallbackType(Int32 progress, Int32 max, Int8 operation)

Passed in when calling ImageLibSetProgressCallback

Definition at line 104 of file ImageLibCommon.h.

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:35 2008 for Palm API Guide