xenocara/lib/fontconfig/doc/FcPatternBuild.3

52 lines
1.7 KiB
Groff
Raw Normal View History

2006-11-25 11:41:30 -07:00
.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "FcPatternBuild" "3" "31 May 2008" "" ""
2006-11-25 11:41:30 -07:00
.SH NAME
FcPatternBuild, FcPatternVaBuild, FcPatternVapBuild \- Create patterns from arguments
2006-11-25 11:41:30 -07:00
.SH SYNOPSIS
.sp
\fB#include <fontconfig.h>
.sp
FcPattern * FcPatternBuild (FcPattern *\fIorig\fB, \&...\fI\fB);
.sp
2006-12-31 07:57:18 -07:00
FcPattern * FcPatternVaBuild (FcPattern *\fIorig\fB, va_list \fIva\fB);
.sp
void FcPatternVapBuild (FcPattern *\fIresult\fB, FcPattern *\fIorig\fB, va_list \fIva\fB);
2006-11-25 11:41:30 -07:00
\fR
.SH "DESCRIPTION"
.PP
Builds a pattern using a list of objects, types and values. Each
value to be entered in the pattern is specified with three arguments:
.TP 3
1.
Object name, a string describing the property to be added.
.TP 3
2.
Object type, one of the FcType enumerated values
.TP 3
3.
Value, not an FcValue, but the raw type as passed to any of the
FcPatternAdd<type> functions. Must match the type of the second
argument.
.PP
The argument list is terminated by a null object name, no object type nor
value need be passed for this. The values are added to `pattern', if
`pattern' is null, a new pattern is created. In either case, the pattern is
returned. Example
.nf
pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);
.fi
.PP
FcPatternVaBuild is used when the arguments are already in the form of a
varargs value. FcPatternVapBuild is a macro version of FcPatternVaBuild
which returns its result directly in the \fIresult\fR
variable.
2006-11-25 11:41:30 -07:00
.SH "VERSION"
.PP
Fontconfig version 2.6.0