Files
gimp/devel-docs/libgimp/html/GimpFontSelectButton.html
2010-08-11 01:23:08 -04:00

351 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpFontSelectButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="prev" href="GimpBrushSelectButton.html" title="GimpBrushSelectButton">
<link rel="next" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GimpBrushSelectButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-selectors.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="GimpGradientSelectButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2683217" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2718741" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2576747" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2718650" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2718676" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2718717" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpFontSelectButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2683217"></a><span class="refentrytitle">GimpFontSelectButton</span>
</h2>
<p>GimpFontSelectButton</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpFontSelectButton.html#GimpFontSelectButton-struct">GimpFontSelectButton</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* <a class="link" href="GimpFontSelectButton.html#gimp-font-select-button-new">gimp_font_select_button_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *font_name);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="GimpFontSelectButton.html#gimp-font-select-button-get-font">gimp_font_select_button_get_font</a> (<a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton">GimpFontSelectButton</a> *button);
void <a class="link" href="GimpFontSelectButton.html#gimp-font-select-button-set-font">gimp_font_select_button_set_font</a> (<a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton">GimpFontSelectButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *font_name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2576747"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="../gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="../gtk/GtkBox.html"
>GtkBox</a>
+----<a
href="../gtk/GtkHBox.html"
>GtkHBox</a>
+----<a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
+----GimpFontSelectButton
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2718650"></a><h2>Implemented Interfaces</h2>
<p>
GimpFontSelectButton implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2718676"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpFontSelectButton.html#GimpFontSelectButton--font-name">font-name</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a class="link" href="GimpFontSelectButton.html#GimpFontSelectButton--title">title</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2718717"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GimpFontSelectButton.html#GimpFontSelectButton-font-set">font-set</a>" : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2718741"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2718756"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2718767"></a><h3>
<a name="GimpFontSelectButton-struct"></a>GimpFontSelectButton</h3>
<a class="indexterm" name="id2718778"></a><pre class="programlisting">typedef struct _GimpFontSelectButton GimpFontSelectButton;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2718794"></a><h3>
<a name="gimp-font-select-button-new"></a>gimp_font_select_button_new ()</h3>
<a class="indexterm" name="id2718807"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* gimp_font_select_button_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *font_name);</pre>
<p>
Creates a new <a
href="../gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> that completely controls the selection of
a font. This widget is suitable for placement in a table in a
plug-in dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em>&#160;:</span></p></td>
<td> Title of the dialog to use or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to use the default title.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>font_name</code></em>&#160;:</span></p></td>
<td> Initial font name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A <a
href="../gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> that you can use in your UI.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2720126"></a><h3>
<a name="gimp-font-select-button-get-font"></a>gimp_font_select_button_get_font ()</h3>
<a class="indexterm" name="id2720139"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_font_select_button_get_font (<a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton">GimpFontSelectButton</a> *button);</pre>
<p>
Retrieves the name of currently selected font.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></p></td>
<td> A <a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton"><span class="type">GimpFontSelectButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> an internal copy of the font name which must not be freed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2720214"></a><h3>
<a name="gimp-font-select-button-set-font"></a>gimp_font_select_button_set_font ()</h3>
<a class="indexterm" name="id2720227"></a><pre class="programlisting">void gimp_font_select_button_set_font (<a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton">GimpFontSelectButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *font_name);</pre>
<p>
Sets the current font for the font select button.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></p></td>
<td> A <a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton"><span class="type">GimpFontSelectButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>font_name</code></em>&#160;:</span></p></td>
<td> Font name to set; <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> means no change.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2720321"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2720331"></a><h3>
<a name="GimpFontSelectButton--font-name"></a>The "<code class="literal">font-name</code>" property</h3>
<a class="indexterm" name="id2720345"></a><pre class="programlisting"> "font-name" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>
The name of the currently selected font.</p>
<p>
</p>
<p>Default value: "Sans"</p>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2720388"></a><h3>
<a name="GimpFontSelectButton--title"></a>The "<code class="literal">title</code>" property</h3>
<a class="indexterm" name="id2720402"></a><pre class="programlisting"> "title" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct Only</pre>
<p>
The title to be used for the font selection popup dialog.</p>
<p>
</p>
<p>Default value: "Font Selection"</p>
<p>Since GIMP 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2720438"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2720448"></a><h3>
<a name="GimpFontSelectButton-font-set"></a>The "font-set" signal</h3>
<a class="indexterm" name="id2720457"></a><pre class="programlisting">void user_function (<a class="link" href="GimpFontSelectButton.html" title="GimpFontSelectButton">GimpFontSelectButton</a> *widget,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *font_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> dialog_closing,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run First</pre>
<p>
The ::font-set signal is emitted when the user selects a font.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></p></td>
<td> the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>font_name</code></em>&#160;:</span></p></td>
<td> the name of the currently selected font.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog_closing</code></em>&#160;:</span></p></td>
<td> whether the dialog was closed or not.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>