Files
gimp/devel-docs/libgimp/xml/gimpfontselect.xml
2010-08-11 01:13:56 -04:00

184 lines
8.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<!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="libgimp-gimpfontselect">
<refmeta>
<refentrytitle>gimpfontselect</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpfontselect</refname><refpurpose>Functions providing a font selection dialog.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="void">void</link> (<link linkend="GimpRunFontCallback">*GimpRunFontCallback</link>) (const <link linkend="gchar">gchar</link> *font_name,
<link linkend="gboolean">gboolean</link> dialog_closing,
<link linkend="gpointer">gpointer</link> user_data);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-font-select-new">gimp_font_select_new</link> (const <link linkend="gchar">gchar</link> *title,
const <link linkend="gchar">gchar</link> *font_name,
<link linkend="GimpRunFontCallback">GimpRunFontCallback</link> callback,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="gimp-font-select-destroy">gimp_font_select_destroy</link> (const <link linkend="gchar">gchar</link> *font_callback);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-fonts-popup">gimp_fonts_popup</link> (const <link linkend="gchar">gchar</link> *font_callback,
const <link linkend="gchar">gchar</link> *popup_title,
const <link linkend="gchar">gchar</link> *initial_font);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-fonts-close-popup">gimp_fonts_close_popup</link> (const <link linkend="gchar">gchar</link> *font_callback);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-fonts-set-popup">gimp_fonts_set_popup</link> (const <link linkend="gchar">gchar</link> *font_callback,
const <link linkend="gchar">gchar</link> *font_name);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Functions providing a font selection dialog.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpRunFontCallback"/>GimpRunFontCallback ()</title>
<indexterm><primary>GimpRunFontCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRunFontCallback) (const <link linkend="gchar">gchar</link> *font_name,
<link linkend="gboolean">gboolean</link> dialog_closing,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>font_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dialog_closing</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-font-select-new"/>gimp_font_select_new ()</title>
<indexterm><primary>gimp_font_select_new</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_font_select_new (const <link linkend="gchar">gchar</link> *title,
const <link linkend="gchar">gchar</link> *font_name,
<link linkend="GimpRunFontCallback">GimpRunFontCallback</link> callback,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-font-select-destroy"/>gimp_font_select_destroy ()</title>
<indexterm><primary>gimp_font_select_destroy</primary></indexterm><programlisting><link linkend="void">void</link> gimp_font_select_destroy (const <link linkend="gchar">gchar</link> *font_callback);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>font_callback</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-fonts-popup"/>gimp_fonts_popup ()</title>
<indexterm><primary>gimp_fonts_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_fonts_popup (const <link linkend="gchar">gchar</link> *font_callback,
const <link linkend="gchar">gchar</link> *popup_title,
const <link linkend="gchar">gchar</link> *initial_font);</programlisting>
<para>
Invokes the Gimp font selection.
</para>
<para>
This procedure popups the font selection dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>font_callback</parameter>&nbsp;:</term>
<listitem><simpara> The callback PDB proc to call when font selection is made.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>popup_title</parameter>&nbsp;:</term>
<listitem><simpara> Title to give the font popup window.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>initial_font</parameter>&nbsp;:</term>
<listitem><simpara> The name of the font to set as the first selected.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-fonts-close-popup"/>gimp_fonts_close_popup ()</title>
<indexterm><primary>gimp_fonts_close_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_fonts_close_popup (const <link linkend="gchar">gchar</link> *font_callback);</programlisting>
<para>
Popdown the Gimp font selection.
</para>
<para>
This procedure closes an opened font selection dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>font_callback</parameter>&nbsp;:</term>
<listitem><simpara> The name of the callback registered for this popup.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-fonts-set-popup"/>gimp_fonts_set_popup ()</title>
<indexterm><primary>gimp_fonts_set_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_fonts_set_popup (const <link linkend="gchar">gchar</link> *font_callback,
const <link linkend="gchar">gchar</link> *font_name);</programlisting>
<para>
Sets the current font selection in a popup.
</para>
<para>
Sets the current font selection in a popup.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>font_callback</parameter>&nbsp;:</term>
<listitem><simpara> The name of the callback registered for this popup.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter>&nbsp;:</term>
<listitem><simpara> The name of the font to set as selected.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>