summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-pangocairo-functions.xml
blob: 3e387c99d84a75562dbf6a7ca54d03ae76faf410 (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?xml version="1.0" standalone="no"?>
<!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="pangocairo-functions">
  <refnamediv>
    <refname>pangocairo Functions</refname>
    <refpurpose>a list of all the pangocairo functions</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <refsect2>
      <title><link linkend="class-pangocairocairofontmap"><classname>pangocairo.CairoFontMap</classname></link> Functions</title>

      <programlisting><methodsynopsis language="python">
	  <methodname><link
linkend="function-pangocairo--cairo-font-map-get-default">pangocairo.cairo_font_map_get_default</link></methodname>
	</methodsynopsis></programlisting>

    </refsect2>



    <refsect2>
      <title>Miscellaneous Functions</title>

      <programlisting><methodsynopsis language="python">
          <methodname><link linkend="function-pangocairo--context-get-font-options">context_get_font_options</link></methodname>
          <methodparam><parameter
			 role="keyword">context</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-pangocairo--context-set-font-options">context_set_font_options</link></methodname>
	  <methodparam><parameter
			 role="keyword">context</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">font_options</parameter></methodparam>
          </methodsynopsis></programlisting>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-pangocairo--context-get-font-options">
      <title>pangocairo.context_get_font_options</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pangocairo.context_get_font_options</methodname>
	  <methodparam><parameter
			 role="keyword">context</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">context</parameter>&nbsp;:</term>
	  <listitem><simpara>a
          <link linkend="class-pangocontext"><classname>pango.Context</classname></link>
          created by the
          <link linkend="method-pangocairocairofontmap--create-context"><methodname>pango.FontMap.create_context</methodname>()</link>
          method.</simpara></listitem>
	</varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a cairo.FontOptions object or
          <literal>None</literal> </simpara></listitem>
        </varlistentry>
       </variablelist>

      <note>
        <para>This function is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <function>pangocairo.context_get_font_options</function>()
      method returns the cairo.FontOptions object associated with the <link
      linkend="class-pangocontext"><classname>pango.Context</classname></link>
      specified by <parameter>context</parameter>.</para>

    </refsect2>

    <refsect2 id="function-pangocairo--context-set-font-options">
      <title>pangocairo.context_set_font_options</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pangocairo.context_set_font_options</methodname>
	  <methodparam><parameter
			 role="keyword">context</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">font_options</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">context</parameter>&nbsp;:</term>
	  <listitem><simpara>a
          <link linkend="class-pangocontext"><classname>pango.Context</classname></link>
          created by the
          <link linkend="method-pangocairocairofontmap--create-context"><methodname>pango.FontMap.create_context</methodname>()</link>
          method.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">font_options</parameter>&nbsp;:</term>
	  <listitem><simpara>a cairo.FontOptions object or
          <literal>None</literal></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This function is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <function>pangocairo.context_set_font_options</function>()
      function sets the font options specified by
      <parameter>font_options</parameter> used when rendering text with the
      <link
      linkend="class-pangocontext"><classname>pango.Context</classname></link>
      specified by <parameter>context</parameter>. These options override
      any options that <link
      linkend="method-pangocairocairocontext--update-context"><methodname>pangocairo.CairoContext.update_context</methodname>()</link>
      derives from the target surface. If
      <parameter>font_options</parameter> is <literal>None</literal> any
      previously set options are unset.</para>

    </refsect2>

  </refsect1>

</refentry>