doc/fcobjectset.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="FcObjectSetCreate">
  25         <refmeta>
  26             <refentrytitle>FcObjectSetCreate</refentrytitle>
  27             <manvolnum>3</manvolnum>
  28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  29         </refmeta>
  30         <refnamediv>
  31             <refname>FcObjectSetCreate</refname>
  32             <refpurpose>Create an object set</refpurpose>
  33         </refnamediv>
  34         <refsynopsisdiv>
  35         <funcsynopsis>
  36         <funcsynopsisinfo>
  37 #include &lt;fontconfig/fontconfig.h&gt;
  38         </funcsynopsisinfo>
  39         <funcprototype>
  40             <funcdef>FcObjectSet * <function>FcObjectSetCreate</function></funcdef>
  41                 <paramdef>void<parameter></parameter></paramdef>
  42         </funcprototype>
  43         </funcsynopsis>
  44         </refsynopsisdiv>
  45         <refsect1><title>Description</title>
  46             <para>
  47 Creates an empty set.
  48             </para>
  49         </refsect1>
  50     </refentry>
  51 <!--
  52    fontconfig/doc/func.sgml
  53
  54    Copyright © 2003 Keith Packard
  55
  56    Permission to use, copy, modify, distribute, and sell this software and its
  57    documentation for any purpose is hereby granted without fee, provided that
  58    the above copyright notice appear in all copies and that both that
  59    copyright notice and this permission notice appear in supporting
  60    documentation, and that the name of the author(s) not be used in
  61    advertising or publicity pertaining to distribution of the software without
  62    specific, written prior permission.  The authors make no
  63    representations about the suitability of this software for any purpose.  It
  64    is provided "as is" without express or implied warranty.
  65
  66    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  67    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  68    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  69    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  70    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  71    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  72    PERFORMANCE OF THIS SOFTWARE.
  73  -->
  74     <refentry id="FcObjectSetAdd">
  75         <refmeta>
  76             <refentrytitle>FcObjectSetAdd</refentrytitle>
  77             <manvolnum>3</manvolnum>
  78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  79         </refmeta>
  80         <refnamediv>
  81             <refname>FcObjectSetAdd</refname>
  82             <refpurpose>Add to an object set</refpurpose>
  83         </refnamediv>
  84         <refsynopsisdiv>
  85         <funcsynopsis>
  86         <funcsynopsisinfo>
  87 #include &lt;fontconfig/fontconfig.h&gt;
  88         </funcsynopsisinfo>
  89         <funcprototype>
  90             <funcdef>FcBool <function>FcObjectSetAdd</function></funcdef>
  91                 <paramdef>FcObjectSet *<parameter>os</parameter></paramdef>
  92                 <paramdef>const char *<parameter>object</parameter></paramdef>
  93         </funcprototype>
  94         </funcsynopsis>
  95         </refsynopsisdiv>
  96         <refsect1><title>Description</title>
  97             <para>
  98 Adds a property name to the set. Returns FcFalse if the property name cannot be
  99 inserted into the set (due to allocation failure). Otherwise returns FcTrue.
 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="FcObjectSetDestroy">
 127         <refmeta>
 128             <refentrytitle>FcObjectSetDestroy</refentrytitle>
 129             <manvolnum>3</manvolnum>
 130             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 131         </refmeta>
 132         <refnamediv>
 133             <refname>FcObjectSetDestroy</refname>
 134             <refpurpose>Destroy an object set</refpurpose>
 135         </refnamediv>
 136         <refsynopsisdiv>
 137         <funcsynopsis>
 138         <funcsynopsisinfo>
 139 #include &lt;fontconfig/fontconfig.h&gt;
 140         </funcsynopsisinfo>
 141         <funcprototype>
 142             <funcdef>void <function>FcObjectSetDestroy</function></funcdef>
 143                 <paramdef>FcObjectSet *<parameter>os</parameter></paramdef>
 144         </funcprototype>
 145         </funcsynopsis>
 146         </refsynopsisdiv>
 147         <refsect1><title>Description</title>
 148             <para>
 149 Destroys an object set.
 150             </para>
 151         </refsect1>
 152     </refentry>
 153 <!--
 154    fontconfig/doc/func.sgml
 155
 156    Copyright © 2003 Keith Packard
 157
 158    Permission to use, copy, modify, distribute, and sell this software and its
 159    documentation for any purpose is hereby granted without fee, provided that
 160    the above copyright notice appear in all copies and that both that
 161    copyright notice and this permission notice appear in supporting
 162    documentation, and that the name of the author(s) not be used in
 163    advertising or publicity pertaining to distribution of the software without
 164    specific, written prior permission.  The authors make no
 165    representations about the suitability of this software for any purpose.  It
 166    is provided "as is" without express or implied warranty.
 167
 168    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 169    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 170    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 171    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 172    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 173    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 174    PERFORMANCE OF THIS SOFTWARE.
 175  -->
 176     <refentry id="FcObjectSetBuild">
 177         <refmeta>
 178             <refentrytitle>FcObjectSetBuild</refentrytitle>
 179             <manvolnum>3</manvolnum>
 180             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 181         </refmeta>
 182         <refnamediv>
 183             <refname>FcObjectSetBuild</refname>
 184             <refname>FcObjectSetVaBuild</refname>
 185             <refname>FcObjectSetVapBuild</refname>
 186             <refpurpose>Build object set from args</refpurpose>
 187         </refnamediv>
 188         <refsynopsisdiv>
 189         <funcsynopsis>
 190         <funcsynopsisinfo>
 191 #include &lt;fontconfig/fontconfig.h&gt;
 192         </funcsynopsisinfo>
 193         <funcprototype>
 194             <funcdef>FcObjectSet * <function>FcObjectSetBuild</function></funcdef>
 195                 <paramdef>const char *<parameter>first</parameter></paramdef>
 196                 <paramdef>...<parameter></parameter></paramdef>
 197         </funcprototype>
 198         <funcprototype>
 199             <funcdef>FcObjectSet * <function>FcObjectSetVaBuild</function></funcdef>
 200                 <paramdef>const char *<parameter>first</parameter></paramdef>
 201                 <paramdef>va_list <parameter>va</parameter></paramdef>
 202         </funcprototype>
 203         <funcprototype>
 204             <funcdef>void <function>FcObjectSetVapBuild</function></funcdef>
 205                 <paramdef>FcObjectSet *<parameter>result</parameter></paramdef>
 206                 <paramdef>const char *<parameter>first</parameter></paramdef>
 207                 <paramdef>va_list <parameter>va</parameter></paramdef>
 208         </funcprototype>
 209         </funcsynopsis>
 210         </refsynopsisdiv>
 211         <refsect1><title>Description</title>
 212             <para>
 213 These build an object set from a null-terminated list of property names.
 214 FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns
 215 the result in the <parameter>result</parameter> variable directly.
 216             </para>
 217         </refsect1>
 218     </refentry>