doc/fcvalue.sgml

   1 <!--
   2    fontconfig/doc/func.sgml
   3
   4    Copyright © 2003 Keith Packard
   5
   6    Permission to use, copy, modify, distribute, and sell this software and its
   7    documentation for any purpose is hereby granted without fee, provided that
   8    the above copyright notice appear in all copies and that both that
   9    copyright notice and this permission notice appear in supporting
  10    documentation, and that the name of the author(s) not be used in
  11    advertising or publicity pertaining to distribution of the software without
  12    specific, written prior permission.  The authors make no
  13    representations about the suitability of this software for any purpose.  It
  14    is provided "as is" without express or implied warranty.
  15
  16    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22    PERFORMANCE OF THIS SOFTWARE.
  23  -->
  24     <refentry id="FcValueDestroy">
  25         <refmeta>
  26             <refentrytitle>FcValueDestroy</refentrytitle>
  27             <manvolnum>3</manvolnum>
  28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  29         </refmeta>
  30         <refnamediv>
  31             <refname>FcValueDestroy</refname>
  32             <refpurpose>Free a value</refpurpose>
  33         </refnamediv>
  34         <refsynopsisdiv>
  35         <funcsynopsis>
  36         <funcsynopsisinfo>
  37 #include &lt;fontconfig/fontconfig.h&gt;
  38         </funcsynopsisinfo>
  39         <funcprototype>
  40             <funcdef>void <function>FcValueDestroy</function></funcdef>
  41                 <paramdef>FcValue <parameter>v</parameter></paramdef>
  42         </funcprototype>
  43         </funcsynopsis>
  44         </refsynopsisdiv>
  45         <refsect1><title>Description</title>
  46             <para>
  47 Frees any memory referenced by <parameter>v</parameter>.  Values of type FcTypeString,
  48 FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
  49             </para>
  50         </refsect1>
  51     </refentry>
  52 <!--
  53    fontconfig/doc/func.sgml
  54
  55    Copyright © 2003 Keith Packard
  56
  57    Permission to use, copy, modify, distribute, and sell this software and its
  58    documentation for any purpose is hereby granted without fee, provided that
  59    the above copyright notice appear in all copies and that both that
  60    copyright notice and this permission notice appear in supporting
  61    documentation, and that the name of the author(s) not be used in
  62    advertising or publicity pertaining to distribution of the software without
  63    specific, written prior permission.  The authors make no
  64    representations about the suitability of this software for any purpose.  It
  65    is provided "as is" without express or implied warranty.
  66
  67    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  68    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  69    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  70    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  71    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  72    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  73    PERFORMANCE OF THIS SOFTWARE.
  74  -->
  75     <refentry id="FcValueSave">
  76         <refmeta>
  77             <refentrytitle>FcValueSave</refentrytitle>
  78             <manvolnum>3</manvolnum>
  79             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  80         </refmeta>
  81         <refnamediv>
  82             <refname>FcValueSave</refname>
  83             <refpurpose>Copy a value</refpurpose>
  84         </refnamediv>
  85         <refsynopsisdiv>
  86         <funcsynopsis>
  87         <funcsynopsisinfo>
  88 #include &lt;fontconfig/fontconfig.h&gt;
  89         </funcsynopsisinfo>
  90         <funcprototype>
  91             <funcdef>FcValue <function>FcValueSave</function></funcdef>
  92                 <paramdef>FcValue <parameter>v</parameter></paramdef>
  93         </funcprototype>
  94         </funcsynopsis>
  95         </refsynopsisdiv>
  96         <refsect1><title>Description</title>
  97             <para>
  98 Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
  99 may be safely destroyed without harming the new value.
 100             </para>
 101         </refsect1>
 102     </refentry>
 103 <!--
 104    fontconfig/doc/func.sgml
 105
 106    Copyright © 2003 Keith Packard
 107
 108    Permission to use, copy, modify, distribute, and sell this software and its
 109    documentation for any purpose is hereby granted without fee, provided that
 110    the above copyright notice appear in all copies and that both that
 111    copyright notice and this permission notice appear in supporting
 112    documentation, and that the name of the author(s) not be used in
 113    advertising or publicity pertaining to distribution of the software without
 114    specific, written prior permission.  The authors make no
 115    representations about the suitability of this software for any purpose.  It
 116    is provided "as is" without express or implied warranty.
 117
 118    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 119    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 120    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 121    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 122    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 123    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 124    PERFORMANCE OF THIS SOFTWARE.
 125  -->
 126     <refentry id="FcValuePrint">
 127         <refmeta>
 128             <refentrytitle>FcValuePrint</refentrytitle>
 129             <manvolnum>3</manvolnum>
 130             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 131         </refmeta>
 132         <refnamediv>
 133             <refname>FcValuePrint</refname>
 134             <refpurpose>Print a value to stdout</refpurpose>
 135         </refnamediv>
 136         <refsynopsisdiv>
 137         <funcsynopsis>
 138         <funcsynopsisinfo>
 139 #include &lt;fontconfig/fontconfig.h&gt;
 140         </funcsynopsisinfo>
 141         <funcprototype>
 142             <funcdef>void <function>FcValuePrint</function></funcdef>
 143                 <paramdef>FcValue <parameter>v</parameter></paramdef>
 144         </funcprototype>
 145         </funcsynopsis>
 146         </refsynopsisdiv>
 147         <refsect1><title>Description</title>
 148             <para>
 149 Prints a human-readable representation of <parameter>v</parameter> to
 150 stdout. The format should not be considered part of the library
 151 specification as it may change in the future.
 152             </para>
 153         </refsect1>
 154     </refentry>
 155 <!--
 156    fontconfig/doc/func.sgml
 157
 158    Copyright © 2003 Keith Packard
 159
 160    Permission to use, copy, modify, distribute, and sell this software and its
 161    documentation for any purpose is hereby granted without fee, provided that
 162    the above copyright notice appear in all copies and that both that
 163    copyright notice and this permission notice appear in supporting
 164    documentation, and that the name of the author(s) not be used in
 165    advertising or publicity pertaining to distribution of the software without
 166    specific, written prior permission.  The authors make no
 167    representations about the suitability of this software for any purpose.  It
 168    is provided "as is" without express or implied warranty.
 169
 170    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 171    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 172    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 173    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 174    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 175    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 176    PERFORMANCE OF THIS SOFTWARE.
 177  -->
 178     <refentry id="FcValueEqual">
 179         <refmeta>
 180             <refentrytitle>FcValueEqual</refentrytitle>
 181             <manvolnum>3</manvolnum>
 182             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 183         </refmeta>
 184         <refnamediv>
 185             <refname>FcValueEqual</refname>
 186             <refpurpose>Test two values for equality</refpurpose>
 187         </refnamediv>
 188         <refsynopsisdiv>
 189         <funcsynopsis>
 190         <funcsynopsisinfo>
 191 #include &lt;fontconfig/fontconfig.h&gt;
 192         </funcsynopsisinfo>
 193         <funcprototype>
 194             <funcdef>FcBool <function>FcValueEqual</function></funcdef>
 195                 <paramdef>FcValue <parameter>v_a</parameter></paramdef>
 196                 <paramdef>FcValue <parameter>v_b</parameter></paramdef>
 197         </funcprototype>
 198         </funcsynopsis>
 199         </refsynopsisdiv>
 200         <refsect1><title>Description</title>
 201             <para>
 202 Compares two values. Integers and Doubles are compared as numbers; otherwise
 203 the two values have to be the same type to be considered equal. Strings are
 204 compared ignoring case.
 205             </para>
 206         </refsect1>
 207     </refentry>