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