git.sur5r.net Git - glabels/blob - docs/libglabels/xml/enums.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="libglabels-enums">
   6 <refmeta>
   7 <refentrytitle role="top_of_page" id="libglabels-enums.top_of_page">Enumerations</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>Enumerations</refname>
  14 <refpurpose>Common enumerations used by libglabels</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv id="libglabels-enums.synopsis" role="synopsis">
  18 <title role="synopsis.title">Synopsis</title>
  19
  20 <synopsis>
  21
  22 #include &lt;libglabels/enums.h&gt;
  23
  24 enum                <link linkend="lglUnitsType">lglUnitsType</link>;
  25 </synopsis>
  26 </refsynopsisdiv>
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36 <refsect1 id="libglabels-enums.description" role="desc">
  37 <title role="desc.title">Description</title>
  38 <para>
  39 This section defines enumerations used to interact with libglabels.
  40 </para>
  41 </refsect1>
  42
  43 <refsect1 id="libglabels-enums.details" role="details">
  44 <title role="details.title">Details</title>
  45 <refsect2 id="lglUnitsType" role="enum">
  46 <title>enum lglUnitsType</title>
  47 <indexterm zone="lglUnitsType"><primary sortas="lglUnitsType">lglUnitsType</primary></indexterm><programlisting>typedef enum {
  48         LGL_UNITS_POINT, /* encoded as "pt" */
  49         LGL_UNITS_INCH,  /* encoded as "in" */
  50         LGL_UNITS_MM,    /* encoded as "mm" */
  51         LGL_UNITS_CM,    /* encoded as "cm" */
  52         LGL_UNITS_PICA,  /* encoded as "pc" */
  53
  54         LGL_UNITS_FIRST = LGL_UNITS_POINT,
  55         LGL_UNITS_LAST  = LGL_UNITS_PICA,
  56 } lglUnitsType;
  57 </programlisting>
  58 <para>
  59 This enumeration defines a set of units of distance supported by the libglabels XML distance
  60 attributes.
  61 </para><variablelist role="enum">
  62 <varlistentry id="LGL-UNITS-POINT--CAPS" role="constant">
  63 <term><literal>LGL_UNITS_POINT</literal></term>
  64 <listitem><simpara>Points.  Encoded as "pt" in XML distance attributes.
  65 </simpara></listitem>
  66 </varlistentry>
  67 <varlistentry id="LGL-UNITS-INCH--CAPS" role="constant">
  68 <term><literal>LGL_UNITS_INCH</literal></term>
  69 <listitem><simpara>Inches.  Encoded as "in" in XML distance attributes.
  70 </simpara></listitem>
  71 </varlistentry>
  72 <varlistentry id="LGL-UNITS-MM--CAPS" role="constant">
  73 <term><literal>LGL_UNITS_MM</literal></term>
  74 <listitem><simpara>Millmeters.  Encoded as "mm" in XML distance attributes.
  75 </simpara></listitem>
  76 </varlistentry>
  77 <varlistentry id="LGL-UNITS-CM--CAPS" role="constant">
  78 <term><literal>LGL_UNITS_CM</literal></term>
  79 <listitem><simpara>Centimeters.  Encoded as "cm" in XML distance attributes.
  80 </simpara></listitem>
  81 </varlistentry>
  82 <varlistentry id="LGL-UNITS-PICA--CAPS" role="constant">
  83 <term><literal>LGL_UNITS_PICA</literal></term>
  84 <listitem><simpara>Picas.  Encoded as "pc" in XML distance attributes.
  85 </simpara></listitem>
  86 </varlistentry>
  87 <varlistentry id="LGL-UNITS-FIRST--CAPS" role="constant">
  88 <term><literal>LGL_UNITS_FIRST</literal></term>
  89 <listitem><simpara>First enumeration.  Used for generic iteration through supported units..
  90 </simpara></listitem>
  91 </varlistentry>
  92 <varlistentry id="LGL-UNITS-LAST--CAPS" role="constant">
  93 <term><literal>LGL_UNITS_LAST</literal></term>
  94 <listitem><simpara>Last enumeration.  Used for generic iteration through supported units.
  95 </simpara></listitem>
  96 </varlistentry>
  97 </variablelist></refsect2>
  98
  99 </refsect1>
 100
 101
 102
 103
 104 </refentry>