diff options
Diffstat (limited to 'docs/reference/pygtk-pangoattribute.xml')
| -rw-r--r-- | docs/reference/pygtk-pangoattribute.xml | 1797 |
1 files changed, 0 insertions, 1797 deletions
diff --git a/docs/reference/pygtk-pangoattribute.xml b/docs/reference/pygtk-pangoattribute.xml deleted file mode 100644 index f99edb50..00000000 --- a/docs/reference/pygtk-pangoattribute.xml +++ /dev/null @@ -1,1797 +0,0 @@ -<?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="class-pangoattribute"> - <refnamediv> - <refname>pango.Attribute</refname> - <refpurpose>an attribute that applies to a section of text</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>pango.Attribute</classname></ooclass> - <methodsynopsis language="python"> - <methodname><link -linkend="method-pangoattribute--copy">copy</link></methodname> - <methodparam></methodparam> </methodsynopsis> - - </classsynopsis> - - <programlisting> -<emphasis role="bold">Functions</emphasis> - -<methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attr-type-register">pango.attr_type_register</link></methodname> - <methodparam><parameter - role="keyword">name</parameter></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrlanguage">pango.AttrLanguage</link></methodname> - <methodparam><parameter - role="keyword">language</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrfamily">pango.AttrFamily</link></methodname> - <methodparam><parameter - role="keyword">family</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrforeground">pango.AttrForeground</link></methodname> - <methodparam><parameter role="keyword">red</parameter></methodparam> - <methodparam><parameter - role="keyword">green</parameter></methodparam> - <methodparam><parameter - role="keyword">blue</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrbackground">pango.AttrBackground</link></methodname> - <methodparam><parameter role="keyword">red</parameter></methodparam> - <methodparam><parameter - role="keyword">green</parameter></methodparam> - <methodparam><parameter - role="keyword">blue</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrsize">pango.AttrSize</link></methodname> - <methodparam><parameter - role="keyword">size</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrstyle">pango.AttrStyle</link></methodname> - <methodparam><parameter - role="keyword">style</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrweight">pango.AttrWeight</link></methodname> - <methodparam><parameter - role="keyword">weight</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrvariant">pango.AttrVariant</link></methodname> - <methodparam><parameter - role="keyword">variant</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrstretch">pango.AttrStretch</link></methodname> - <methodparam><parameter - role="keyword">stretch</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrfontdesc">pango.AttrFontDesc</link></methodname> - <methodparam><parameter - role="keyword">desc</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrunderline">pango.AttrUnderline</link></methodname> - <methodparam><parameter - role="keyword">underline</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrstrikethrough">pango.AttrStrikethrough</link></methodname> - <methodparam><parameter - role="keyword">strikethrough</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrrise">pango.AttrRise</link></methodname> - <methodparam><parameter - role="keyword">rise</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrshape">pango.AttrShape</link></methodname> - <methodparam><parameter - role="keyword">ink_rect</parameter></methodparam> - <methodparam><parameter - role="keyword">logical_rect</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrscale">pango.AttrScale</link></methodname> - <methodparam><parameter - role="keyword">scale</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrfallback">pango.AttrFallback</link></methodname> - <methodparam><parameter - role="keyword">fallback</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrsize">pango.AttrSizeAbsolute</link></methodname> - <methodparam><parameter - role="keyword">size</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrforeground">pango.AttrUnderlineColor</link></methodname> - <methodparam><parameter role="keyword">red</parameter></methodparam> - <methodparam><parameter - role="keyword">green</parameter></methodparam> - <methodparam><parameter - role="keyword">blue</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrforeground">pango.AttrStrikethroughColor</link></methodname> - <methodparam><parameter role="keyword">red</parameter></methodparam> - <methodparam><parameter - role="keyword">green</parameter></methodparam> - <methodparam><parameter - role="keyword">blue</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link -linkend="function-pango--attrsize">pango.AttrLetterSpacing</link></methodname> - <methodparam><parameter - role="keyword">letter_spacing</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - - </refsect1> - - <refsect1> - <title>Attributes</title> - - <para>All <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -objects support the following three attributes.</para> - - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <?dbhtml cellpadding="5"?> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4in"/> - <tbody> - - <row valign="top"> - <entry>"end_index"</entry> - <entry>Read-Write</entry> - <entry>The index of the end of the application of the -attribute in the associated text.</entry> - </row> - - <row valign="top"> - <entry>"start_index"</entry> - <entry>Read-Write</entry> - <entry>The index of the start of the application of the -attribute in the associated text.</entry> - </row> - - <row valign="top"> - <entry>"type"</entry> - <entry>Read</entry> - <entry>The attribute type.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - <para>In addition each <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -type supports one or more additional attributes that are specific to the -type:</para> - - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <?dbhtml cellpadding="5"?> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="1in"/> - <colspec column="4" colwidth="3in"/> - <tbody> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read </entry> - <entry><literal>ATTR_LANGUAGE</literal></entry> - <entry>The <link -linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_FAMILY</literal></entry> - <entry>The string containing the font family name list (e.g. -"normal,sans,serif,monospace")</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_STYLE</literal></entry> - <entry>The font slant style. See the <link -linkend="function-pango--attrstyle"><function>pango.AttrStyle</function>()</link> -function for more details.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_WEIGHT</literal></entry> - <entry>The font weight. See the <link -linkend="function-pango--attrweight"><function>pango.AttrWeight</function>()</link> -function for more detail.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_VARIANT</literal></entry> - <entry>The font variant. See the <link -linkend="function-pango--attrvariant"><function>pango.AttrVariant</function>()</link> -function for more detail.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_STRETCH</literal></entry> - <entry>The font stretch. See the <link -linkend="function-pango--attrstretch"><function>pango.AttrStretch</function>()</link> -function for more details.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_SIZE</literal></entry> - <entry>The font size in thousandths of a point.</entry> - </row> - - <row valign="top"> - <entry>"desc"</entry> - <entry>Read</entry> - <entry><literal>ATTR_FONT_DESC</literal></entry> - <entry>The <link -linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link> -object.</entry> - </row> - - <row valign="top"> - <entry>"color"</entry> - <entry>Read</entry> - <entry><literal>ATTR_FOREGROUND</literal></entry> - <entry>The foreground <link -linkend="class-pangocolor"><classname>pango.Color</classname></link> -object.</entry> - </row> - - <row valign="top"> - <entry>"color"</entry> - <entry>Read</entry> - <entry><literal>ATTR_BACKGROUND</literal></entry> - <entry>The background <link -linkend="class-pangocolor"><classname>pango.Color</classname></link> -object.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_UNDERLINE</literal></entry> - <entry>The underline style. See the <link -linkend="function-pango--attrunderline"><function>pango.AttrUnderline</function>()</link> -function for more details.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_STRIKETHROUGH</literal></entry> - <entry><literal>True</literal> if the text is struck -through.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_RISE</literal></entry> - <entry>The displacement of the text from the baseline.</entry> - </row> - - <row valign="top"> - <entry>"ink_rect"</entry> - <entry>Read</entry> - <entry><literal>ATTR_SHAPE</literal></entry> - <entry>The 4-tuple specifying the ink rectangle. See the <link -linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link> -function for more details.</entry> - </row> - - <row valign="top"> - <entry>"logical_rect"</entry> - <entry>Read</entry> - <entry><literal>ATTR_SHAPE</literal></entry> - <entry>The 4-tuple specifying the logical rectangle. See the -<link -linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link> -function for more details.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_SCALE</literal></entry> - <entry>The font size scale factor as a float.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> <entry>Read</entry> - <entry><literal>ATTR_FALLBACK</literal></entry> - <entry><literal>True</literal> if font fallback is - enabled.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_LETTER_SPACING</literal></entry> - <entry>The extra space between graphemes.</entry> - </row> - - <row valign="top"> - <entry>"color"</entry> - <entry>Read</entry> - <entry><literal>ATTR_UNDERLINE_COLOR</literal></entry> - <entry>The <link - linkend="class-pangocolor"><classname>pango.Color</classname></link> - object used for the color of the underline.</entry> - </row> - - <row valign="top"> - <entry>"color"</entry> - <entry>Read</entry> - <entry><literal>ATTR_STRIKETHROUGH_COLOR</literal></entry> - <entry>The <link - linkend="class-pangocolor"><classname>pango.Color</classname></link> - object used for the color of the strikethrough.</entry> - </row> - - <row valign="top"> - <entry>"value"</entry> - <entry>Read</entry> - <entry><literal>ATTR_ABSOLUTE_SIZE</literal></entry> - <entry>The font size in device units.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1> - <title>Description</title> - - <para>The <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object contains an attribute that applies to a section of text. The -predefined attribute types are:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.ATTR_LANGUAGE</literal></term> - <listitem> - <simpara>Specifies a <link -linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_FAMILY</literal></term> - <listitem> - <simpara>Specifies a font family name list as a string.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_STYLE</literal></term> - <listitem> - <simpara>Specifies a font slant style. See the <link -linkend="function-pango--attrstyle"><function>pango.AttrStyle</function>()</link> -function for more details.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_WEIGHT</literal></term> - <listitem> - <simpara>Specifies a font weight. See the <link -linkend="function-pango--attrweight"><function>pango.AttrWeight</function>()</link> -function for more detail.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_VARIANT</literal></term> - <listitem> - <simpara>Specifies a font variant (normal or small caps). See the -<link -linkend="function-pango--attrvariant"><function>pango.AttrVariant</function>()</link> -function for more detail.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_STRETCH</literal></term> - <listitem> - <simpara>Specifies a font stretch. See the <link -linkend="function-pango--attrstretch"><function>pango.AttrStretch</function>()</link> -function for more details.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_SIZE</literal></term> - <listitem> - <simpara>Specifies a font size in thousandths of a point.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_FONT_DESC</literal></term> - <listitem> - <simpara>Specifies a <link -linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_FOREGROUND</literal></term> - <listitem> - <simpara>Specifies a foreground <link -linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_BACKGROUND</literal></term> - <listitem> - <simpara>Specifies a background <link -linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_UNDERLINE</literal></term> - <listitem> - <simpara>Specifies an underline style. See the <link -linkend="function-pango--attrunderline"><function>pango.AttrUnderline</function>()</link> -function for more details.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_STRIKETHROUGH</literal></term> - <listitem> - <simpara>If <literal>True</literal> the text is struck -through.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_RISE</literal></term> - <listitem> - <simpara>Specifies the displacement of the text from the -baseline.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_SHAPE</literal></term> - <listitem> - <simpara>Specifies a shape. See the <link -linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link> -function for more details.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_SCALE</literal></term> - <listitem> - <simpara>Specifies a font size scale factor.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_FALLBACK</literal></term> - <listitem> - <simpara>if <literal>True</literal>, fallback to other fonts is - enabled.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_LETTER_SPACING</literal></term> - <listitem> - <simpara>Specifies the extra space between graphemes.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_UNDERLINE_COLOR</literal></term> - <listitem> - <simpara>Specifies the color of the underline.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_STRIKETHROUGH_COLOR</literal></term> - <listitem> - <simpara>Specifies the color of the strikethrough.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.ATTR_ABSOLUTE_SIZE</literal></term> - <listitem> - <simpara>Specifies the font size in device units.</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para>Additional attribute types can be registered with the <link -linkend="function-pango--attr-type-register"><function>pango.attr_type_register</function>()</link> -function.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-pangoattribute--copy"> - <title>pango.Attribute.copy</title> - - <programlisting><methodsynopsis language="python"> - <methodname>copy</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>copy</methodname>() method returns a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object that is a copy of this attribute.</para> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Functions</title> - - <refsect2 id="function-pango--attr-type-register"> - <title>pango.attr_type_register</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.attr_type_register</methodname> - <methodparam><parameter - role="keyword">name</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">name</parameter> :</term> - <listitem><simpara>a name for the type. (Currently not -used.)</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the new attribute type ID -integer.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>attr_type_register</function>() function returns a -new attribute type ID integer value.</para> - - </refsect2> - - <refsect2 id="function-pango--attrlanguage"> - <title>pango.AttrLanguage</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrLanguage</methodname> - <methodparam><parameter - role="keyword">language</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">language</parameter> :</term> - <listitem><simpara>a <link -linkend="class-pangolanguage"><classname>pango.Language</classname></link> -object.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrLanguage</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_LANGUAGE</literal> with the <link -linkend="class-pangolanguage"><classname>pango.Language</classname></link> -specified by <parameter>language</parameter> and the text range specified by -<parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrfamily"> - <title>pango.AttrFamily</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrFamily</methodname> - <methodparam><parameter - role="keyword">family</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">family</parameter> :</term> - <listitem><simpara>the string containing a font family name -list.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrFamily</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_FAMILY</literal> with the font family -name list specified by the string <parameter>family</parameter> and the text -range specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrforeground"> - <title>pango.AttrForeground</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrForeground</methodname> - <methodparam><parameter - role="keyword">red</parameter></methodparam> - <methodparam><parameter - role="keyword">green</parameter></methodparam> - <methodparam><parameter - role="keyword">blue</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">red</parameter> :</term> - <listitem><simpara>the red component of the color in the range 0 -to 65535.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">green</parameter> :</term> - <listitem><simpara>the green component of the color in the range 0 -to 65535.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">blue</parameter> :</term> - <listitem><simpara>the blue component of the color in the range 0 -to 65535.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrForeground</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -of the type <literal>pango.ATTR_FOREGROUND</literal> with the RGB color -specified by <parameter>red</parameter>, <parameter>green</parameter> and -<parameter>blue</parameter> and the text range specified by -<parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrbackground"> - <title>pango.AttrBackground</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrBackground</methodname> - <methodparam><parameter - role="keyword">red</parameter></methodparam> - <methodparam><parameter - role="keyword">green</parameter></methodparam> - <methodparam><parameter - role="keyword">blue</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">red</parameter> :</term> - <listitem><simpara>the red component of the color in the range 0 -to 65535.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">green</parameter> :</term> - <listitem><simpara>the green component of the color in the range 0 -to 65535.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">blue</parameter> :</term> - <listitem><simpara>the blue component of the color in the range 0 -to 65535.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrBackground</function>() function creates a new -pangoAttribute of the type <literal>pango.ATTR_BACKGROUND</literal> with the -RGB color specified by <parameter>red</parameter>, -<parameter>green</parameter> and <parameter>blue</parameter> and the text -range specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrsize"> - <title>pango.AttrSize</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrSize</methodname> - <methodparam><parameter - role="keyword">size</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">size</parameter> :</term> - <listitem><simpara>the font size in thousandths of a -point.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrSize</function>() function creates a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_SIZE</literal> with the font size -specified by <parameter>size</parameter> and the text range specified by -<parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrstyle"> - <title>pango.AttrStyle</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrStyle</methodname> - <methodparam><parameter - role="keyword">style</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">style</parameter> :</term> - <listitem><simpara>the font slant style.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrStyle</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_STYLE</literal> with the font slant -style specified by <parameter>style</parameter> and the text range specified -by <parameter>start_index</parameter> and <parameter>end_index</parameter>. -The value of <parameter>style</parameter> must be one of:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.STYLE_NORMAL</literal></term> - <listitem> - <simpara>The font is upright.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STYLE_OBLIQUE</literal></term> - <listitem> - <simpara>The font is slanted in a roman style.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STYLE_ITALIC</literal></term> - <listitem> - <simpara>The font is slanted in an italic style.</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="function-pango--attrweight"> - <title>pango.AttrWeight</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrWeight</methodname> - <methodparam><parameter - role="keyword">weight</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">weight</parameter> :</term> - <listitem><simpara>the font weight.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrWeight</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_WEIGHT</literal> with the font weight -specified by <parameter>weight</parameter> and the text range specified by -<parameter>start_index</parameter> and <parameter>end_index</parameter>. The -value of <parameter>style</parameter> must be one of:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.WEIGHT_ULTRALIGHT</literal></term> - <listitem> - <simpara>The ultralight weight (= 200).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.WEIGHT_LIGHT</literal></term> - <listitem> - <simpara>The light weight (=300).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.WEIGHT_NORMAL</literal></term> - <listitem> - <simpara>The default weight (= 400).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.WEIGHT_BOLD</literal></term> - <listitem> - <simpara>The bold weight (= 700).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.WEIGHT_ULTRABOLD</literal></term> - <listitem> - <simpara>The ultrabold weight (= 800).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.WEIGHT_HEAVY</literal></term> - <listitem> - <simpara>The heavy weight (= 900).</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="function-pango--attrvariant"> - <title>pango.AttrVariant</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrVariant</methodname> - <methodparam><parameter - role="keyword">variant</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">variant</parameter> :</term> - <listitem><simpara>the font variant.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrVariant</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_VARIANT</literal> with the font -variant specified by <parameter>variant</parameter> and the text range -specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>. The value of -<parameter>variant</parameter> must be one of:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.VARIANT_NORMAL</literal></term> - <listitem> - <simpara>A normal font.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.VARIANT_SMALL_CAPS</literal></term> - <listitem> - <simpara>A font with the lower case characters replaced by -smaller variants of the capital characters.</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="function-pango--attrstretch"> - <title>pango.AttrStretch</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrStretch</methodname> - <methodparam><parameter - role="keyword">stretch</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">stretch</parameter> :</term> - <listitem><simpara>the font stretch style.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrStretch</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_STRETCH</literal> with the font -stretch style specified by <parameter>stretch</parameter> and the text range -specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>. The value of -<parameter>stretch</parameter> must be one of:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.STRETCH_ULTRA_CONDENSED</literal></term> - <listitem> - <simpara>The most narrow width</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_EXTRA_CONDENSED</literal></term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_CONDENSED</literal></term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_SEMI_CONDENSED</literal></term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_NORMAL</literal></term> - <listitem> - <simpara>The normal width.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_SEMI_EXPANDED</literal></term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_EXPANDED</literal></term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_EXTRA_EXPANDED</literal></term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.STRETCH_ULTRA_EXPANDED</literal></term> - <listitem> - <simpara>The most expanded width</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="function-pango--attrfontdesc"> - <title>pango.AttrFontDesc</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrFontDesc</methodname> - <methodparam><parameter - role="keyword">desc</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">desc</parameter> :</term> - <listitem><simpara>a <link -linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link> -object.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrFontDesc</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_FONT_DESC</literal> with the <link -linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link> -specified by <parameter>desc</parameter> and the text range specified by -<parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrunderline"> - <title>pango.AttrUnderline</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrUnderline</methodname> - <methodparam><parameter - role="keyword">underline</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter -role="keyword">underline</parameter> :</term> - <listitem><simpara>the underline style.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrUnderline</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_UNDERLINE</literal> with the -underline style specified by <parameter>underline</parameter> and the text -range specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>. The value of -<parameter>underline</parameter> must be one of:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.UNDERLINE_NONE</literal></term> - <listitem> - <simpara>No underline should be drawn.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.UNDERLINE_SINGLE</literal></term> - <listitem> - <simpara>A single underline should be drawn.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.UNDERLINE_DOUBLE</literal></term> - <listitem> - <simpara>A double underline should be drawn.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.UNDERLINE_LOW</literal></term> - <listitem> - <simpara>A single underline should be drawn at a position -beneath the ink extents of the text being underlined. This should be used -only for underlining single characters, such as for keyboard accelerators. -<literal>pango.UNDERLINE_SINGLE</literal> should be used for extended -portions of text.</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="function-pango--attrstrikethrough"> - <title>pango.AttrStrikethrough</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrStrikethrough</methodname> - <methodparam><parameter - role="keyword">strikethrough</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter -role="keyword">strikethrough</parameter> :</term> - <listitem><simpara>if <literal>True</literal> the text should be -struck through.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrStrikethrough</function>() function creates a -new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_STRIKETHROUGH</literal> with the -value specified by <parameter>strikethrough</parameter> and the text range -specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>. If strikethough is <literal>True</literal> -the text should be struck through.</para> - - </refsect2> - - <refsect2 id="function-pango--attrrise"> - <title>pango.AttrRise</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrRise</methodname> - <methodparam><parameter - role="keyword">rise</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">rise</parameter> :</term> - <listitem><simpara>the displacement of the text from the -baseline.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrRise</function>() function creates a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_RISE</literal> with the text -displacement from the baseline specified by <parameter>rise</parameter> and -the text range specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrshape"> - <title>pango.AttrShape</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrShape</methodname> - <methodparam><parameter - role="keyword">ink_rect</parameter></methodparam> - <methodparam><parameter - role="keyword">logical_rect</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">ink_rect</parameter> :</term> - <listitem><simpara>the ink rectangle of the -shape.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">logical_rect</parameter> :</term> - <listitem><simpara>the logical rectangle of the -shape.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrShape</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_SHAPE</literal> with the shape -rectangles specified by <parameter>ink_rect</parameter> and -<parameter>logical_rect</parameter> and the text range specified by -<parameter>start_index</parameter> and <parameter>end_index</parameter>. A -shape is used to impose a particular ink and logical rect on the result of -shaping a particular glyph. This might be used, for instance, for embedding -a picture or a widget inside a <link -linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</para> - - </refsect2> - - <refsect2 id="function-pango--attrscale"> - <title>pango.AttrScale</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrScale</methodname> - <methodparam><parameter - role="keyword">scale</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">scale</parameter> :</term> - <listitem><simpara>the font size scale factor as a -float.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>AttrScale</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_SCALE</literal> with the font size -scale factor specified by <parameter>scale</parameter> and the text range -specified by <parameter>start_index</parameter> and -<parameter>end_index</parameter>. The value of <parameter>scale</parameter> -can also be one of the following pre-defined values:</para> - - <variablelist> - <varlistentry> - <term><literal>pango.SCALE_XX_SMALL</literal></term> - <listitem> - <simpara>0.5787037037037 - the scale factor for three shrinking -steps (1 / (1.2 * 1.2 * 1.2)).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.SCALE_X_SMALL</literal></term> - <listitem> - <simpara>0.6444444444444 - the scale factor for two shrinking -steps (1 / (1.2 * 1.2)).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.SCALE_SMALL</literal></term> - <listitem> - <simpara>0.8333333333333 - the scale factor for one shrinking -step (1 / 1.2).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.SCALE_MEDIUM</literal></term> - <listitem> - <simpara>1.0 - The scale factor for normal size.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.SCALE_LARGE</literal></term> - <listitem> - <simpara>1.2 - the scale factor for one magnification -step.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.SCALE_X_LARGE</literal></term> - <listitem> - <simpara>1.4399999999999 - the scale factor for two -magnification steps (1.2 * 1.2).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pango.SCALE_XX_LARGE</literal></term> - <listitem> - <simpara>1.728 - the scale factor for three magnification steps -(1.2 * 1.2 * 1.2).</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="function-pango--attrfallback"> - <title>pango.AttrFallback</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.AttrFallback</methodname> - <methodparam><parameter - role="keyword">fallback</parameter></methodparam> - <methodparam><parameter - role="keyword">start_index</parameter> - <initializer>0</initializer></methodparam> - <methodparam><parameter - role="keyword">end_index</parameter> - <initializer>1</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">fallback</parameter> :</term> - <listitem><simpara>if <literal>True</literal>, we should fall back - on other fonts for characters the active font is - missing.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">start_index</parameter> :</term> - <listitem><simpara>the index of the start of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">end_index</parameter> :</term> - <listitem><simpara>the index of the end of the attribute -application in the text.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This function is available in PyGTK 2.4 and above.</para> - </note> - - <para>The <function>AttrFallback</function>() function creates a new -<link -linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> -object of the type <literal>pango.ATTR_FALLBACK</literal>. If fallback is -<literal>True</literal> other fonts on the system can be used to provide -characters missing from the current font. Otherwise, only characters from -the closest matching font can be used.</para> - - </refsect2> - - </refsect1> - -</refentry> |