summaryrefslogtreecommitdiffstats
path: root/abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/text.xml
blob: 777d78b5b5a965a43f62be2af5e02d0a65e2b0fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="ghosd-Text">
<refmeta>
<refentrytitle>Text</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GHOSD Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Text</refname><refpurpose>Rendering text.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>

#include &lt;ghosd/ghosd-text.h&gt;


<link linkend="void">void</link>        <link linkend="ghosd-text-set-position">ghosd_text_set_position</link>         (<link linkend="Ghosd">Ghosd</link> *ghosd,
                                             <link linkend="int">int</link> x,
                                             <link linkend="int">int</link> y,
                                             <link linkend="PangoLayout">PangoLayout</link> *layout);
</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>
I expect to flesh out this API, so this is mostly a placeholder for now.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="ghosd-text-set-position"/>ghosd_text_set_position ()</title>
<indexterm><primary>ghosd_text_set_position</primary></indexterm><programlisting><link linkend="void">void</link>        ghosd_text_set_position         (<link linkend="Ghosd">Ghosd</link> *ghosd,
                                             <link linkend="int">int</link> x,
                                             <link linkend="int">int</link> y,
                                             <link linkend="PangoLayout">PangoLayout</link> *layout);</programlisting>
<para>
Set ghosd dimensions based on a <link linkend="PangoLayout"><type>PangoLayout</type></link>.
See <link linkend="ghosd-set-position"><function>ghosd_set_position()</function></link> for interpretation of the x and y coordinates.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="Ghosd"><type>Ghosd</type></link> object;
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> x coordinate in screen pixels.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate in screen pixels.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="PangoLayout"><type>PangoLayout</type></link> to draw.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>