API Guide Home (Online version only) |

# VMFontLibCommon.h File Reference

## Detailed Description

Public common header file for the Versamail Font Library.

Version:
  1.0

This file contains the constants and structures for the palmOne VersaMail Font Picker / Font Manager Service.

Definition in file VMFontLibCommon.h.

Include dependency graph for VMFontLibCommon.h:

Go to the source code of this file.

## Data Structures

- struct VMFontUIRules
    Font UI rules structure used for the font picker setting. More...
- struct VMFontType
    Font characteristics structure used to describe a font. More...

## Defines

- #define fontPickerLibName "PalmSGFontLib.Lib"
- #define fontPickerType 'appl'
- #define fontPickerCreatorID 'MA10'
- #define VMFontErrParam (appErrorClass | 1)
- #define VMFontErrNotOpen (appErrorClass | 2)
- #define VMFontErrStillOpen (appErrorClass | 3)

Function Traps

- #define flTrapAPIVersion (sysLibTrapCustom + 0)
- #define flTrapAPIGetFont (sysLibTrapCustom + 1)
- #define flTrapAPIGetFontByID (sysLibTrapCustom + 2)
- #define flTrapAPIFontExists (sysLibTrapCustom + 3)
- #define flTrapAPIFontToString (sysLibTrapCustom + 4)
- #define flTrapAPIFontCountStyleAndSize (sysLibTrapCustom + 5)
- #define flTrapAPISetFontUIRules (sysLibTrapCustom + 6)
- #define flTrapAPIInitFontUI (sysLibTrapCustom + 7)
- #define flTrapAPIDoFontDialog (sysLibTrapCustom + 8)
- #define flTrapAPIClearCache (sysLibTrapCustom + 9)

## Typedefs

- typedef UInt8 VMFontFace
- typedef UInt8 VMFontSize
- typedef UInt8 VMFontStyle
- typedef UInt8 VMFontSizeRule
- typedef UInt8 VMFontStyleRule
- typedef VMFontUIRules * VMFontUIRulesPtr
- typedef VMFontType * VMFontPtr

## Enumerations

- enum _VMFontFace {
  gillSans = 0,
  sabon,
  palm
  }
- enum _VMFontSize {
  size6 = 0,
  size9 = 1,
  size12 = 2
  }
- enum _VMFontStyle {
  normal = 0,
  bold = 1,
  italic = 2
  }
- enum _VMFontSizeRule {
  allSize,
  smallFonts,
  largeFonts
  }
- enum _VMFontStyleRule {
  allStyle,
  plainOnly
  }

## Define Documentation

#define flTrapAPIClearCache (sysLibTrapCustom + 9)

Definition at line 55 of file VMFontLibCommon.h.

#define flTrapAPIDoFontDialog (sysLibTrapCustom + 8)

Definition at line 54 of file VMFontLibCommon.h.

#define flTrapAPIFontCountStyleAndSize (sysLibTrapCustom + 5)

Definition at line 51 of file VMFontLibCommon.h.

#define flTrapAPIFontExists (sysLibTrapCustom + 3)

Definition at line 49 of file VMFontLibCommon.h.

#define flTrapAPIFontToString (sysLibTrapCustom + 4)

Definition at line 50 of file VMFontLibCommon.h.

#define flTrapAPIGetFont (sysLibTrapCustom + 1)

Definition at line 47 of file VMFontLibCommon.h.

#define flTrapAPIGetFontByID (sysLibTrapCustom + 2)

Definition at line 48 of file VMFontLibCommon.h.

#define flTrapAPIInitFontUI (sysLibTrapCustom + 7)

Definition at line 53 of file VMFontLibCommon.h.

#define flTrapAPISetFontUIRules (sysLibTrapCustom + 6)

Definition at line 52 of file VMFontLibCommon.h.

#define flTrapAPIVersion (sysLibTrapCustom + 0)

Definition at line 46 of file VMFontLibCommon.h.

#define fontPickerCreatorID 'MA10'

Font library Creator ID.

Definition at line 64 of file VMFontLibCommon.h.

#define fontPickerLibName "PalmSGFontLib.Lib"

Font library name.

Definition at line 62 of file VMFontLibCommon.h.

#define fontPickerType 'appl'

Font library Type.

Definition at line 63 of file VMFontLibCommon.h.

#define VMFontErrNotOpen (appErrorClass | 2)

Error meaning that the library is not open

Definition at line 75 of file VMFontLibCommon.h.

#define VMFontErrParam (appErrorClass | 1)

A parameter passed was Invalid

Definition at line 72 of file VMFontLibCommon.h.

#define VMFontErrStillOpen (appErrorClass | 3)

Error returned from VMFontClose() if the library is still open

Definition at line 78 of file VMFontLibCommon.h.

## Typedef Documentation

typedef UInt8 VMFontFace

Used with _VMFontFace

Definition at line 92 of file VMFontLibCommon.h.

typedef VMFontType* VMFontPtr

Definition at line 163 of file VMFontLibCommon.h.

typedef UInt8 VMFontSize

Used with _VMFontSize

Definition at line 104 of file VMFontLibCommon.h.

typedef UInt8 VMFontSizeRule

Used with _VMFontSizeRule

Definition at line 128 of file VMFontLibCommon.h.

typedef UInt8 VMFontStyle

Used with _VMFontStyle

Definition at line 116 of file VMFontLibCommon.h.

typedef UInt8 VMFontStyleRule

Used with _VMFontStyleRule

Definition at line 139 of file VMFontLibCommon.h.

typedef VMFontUIRules* VMFontUIRulesPtr

Definition at line 152 of file VMFontLibCommon.h.

## Enumeration Type Documentation

enum _VMFontFace

Font Face

Enumerator:

  gillSans | Gill Sans MT Font
  sabon | Sabon MT Font
  palm | Palm

Definition at line 84 of file VMFontLibCommon.h.

    00084                  {
    00085     gillSans  = 0,          /**< Gill Sans MT Font  */
    00086     sabon,                  /**< Sabon MT Font  */
    00087     //segoe,                /**< Segoe MT Font  */
    00088     //thorndale,            /**< ThornDale MT Font  */
    00089     palm                    /**< Palm  */
    00090 };

enum _VMFontSize

Font Size

Enumerator:

  size6 | Size = 6
  size9 | Size = 9
  size12 | Size = 12

Definition at line 98 of file VMFontLibCommon.h.

    00098                  {
    00099     size6  = 0,         /**< Size = 6  */
    00100     size9  = 1,         /**< Size = 9  */
    00101     size12 = 2          /**< Size = 12  */
    00102 };

enum _VMFontSizeRule

Font Size Rule

Enumerator:

  allSize | Both small and large fonts
  smallFonts | Only Small fonts
  largeFonts | Only large fonts

Definition at line 122 of file VMFontLibCommon.h.

    00122                      {
    00123     allSize,            /**< Both small and large fonts  */
    00124     smallFonts,         /**< Only Small fonts  */
    00125     largeFonts          /**< Only large fonts  */
    00126 };

enum _VMFontStyle

Font Style

Enumerator:

  normal | Normal Fonts
  bold | Bold Fonts
  italic | Italic Fonts

Definition at line 110 of file VMFontLibCommon.h.

    00110                   {
    00111     normal = 0,         /**< Normal Fonts */
    00112     bold   = 1,         /**< Bold Fonts */
    00113     italic = 2          /**< Italic Fonts */
    00114 };

enum _VMFontStyleRule

Font Style Rule

Enumerator:

  allStyle | All font Styles supported
  plainOnly | Only Normal Fonts

Definition at line 134 of file VMFontLibCommon.h.

    00134                       {
    00135     allStyle,           /**< All font Styles supported */
    00136     plainOnly           /**< Only Normal Fonts */
    00137 };

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