git.sur5r.net Git - glabels/blob - docs/libglabels/tmpl/units.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Units
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Type to represent units of distance supported by libglabels
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This section defines a type to represent the various units of distance
  10 supported by libglabels.  It also defines a set of related functions.
  11
  12 </para>
  13
  14 <!-- ##### SECTION See_Also ##### -->
  15 <para>
  16
  17 </para>
  18
  19 <!-- ##### SECTION Stability_Level ##### -->
  20
  21
  22 <!-- ##### SECTION Image ##### -->
  23
  24
  25 <!-- ##### ENUM lglUnits ##### -->
  26 <para>
  27 This enumeration defines supported units of distance.
  28 </para>
  29
  30 @LGL_UNITS_POINT: Points.
  31 @LGL_UNITS_INCH: Inches.
  32 @LGL_UNITS_MM: Millimeters
  33 @LGL_UNITS_CM: Centimeters
  34 @LGL_UNITS_PICA: Picas
  35 @LGL_UNITS_FIRST: First supported unit.  (Used for bounds checking and iteration through supported units.)
  36 @LGL_UNITS_LAST: Last supported unit.  (Used for bounds checking and iteration through supported units.)
  37 @LGL_UNITS_INVALID: Invalid unit.  (Returned by libglabels units functions when a supported unit cannot be determined.)
  38
  39 <!-- ##### FUNCTION lgl_units_get_id ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @units:
  45 @Returns:
  46
  47
  48 <!-- ##### FUNCTION lgl_units_from_id ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @id:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION lgl_units_get_name ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @units:
  63 @Returns:
  64
  65
  66 <!-- ##### FUNCTION lgl_units_from_name ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @name:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION lgl_units_get_points_per_unit ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @units:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION lgl_units_get_units_per_point ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @units:
  90 @Returns:
  91
  92