← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpfontselectbutton.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpfontselectbutton.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="GimpFontSelectButton">
 
6
<refmeta>
 
7
<refentrytitle role="top_of_page">GimpFontSelectButton</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpFontSelectButton</refname>
 
14
<refpurpose></refpurpose>
 
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
 
 
23
 
 
24
 
 
25
                    <link linkend="GimpFontSelectButton-struct">GimpFontSelectButton</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-font-select-button-new">gimp_font_select_button_new</link>         (const <link linkend="gchar">gchar</link> *title,
 
27
                                                         const <link linkend="gchar">gchar</link> *font_name);
 
28
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-font-select-button-get-font">gimp_font_select_button_get_font</link>    (<link linkend="GimpFontSelectButton">GimpFontSelectButton</link> *button);
 
29
<link linkend="void">void</link>                <link linkend="gimp-font-select-button-set-font">gimp_font_select_button_set_font</link>    (<link linkend="GimpFontSelectButton">GimpFontSelectButton</link> *button,
 
30
                                                         const <link linkend="gchar">gchar</link> *font_name);
 
31
 
 
32
</synopsis>
 
33
</refsynopsisdiv>
 
34
 
 
35
<refsect1 role="object_hierarchy">
 
36
<title role="object_hierarchy.title">Object Hierarchy</title>
 
37
<synopsis>
 
38
 
 
39
  <link linkend="GObject">GObject</link>
 
40
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
41
         +----<link linkend="GtkObject">GtkObject</link>
 
42
               +----<link linkend="GtkWidget">GtkWidget</link>
 
43
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
44
                           +----<link linkend="GtkBox">GtkBox</link>
 
45
                                 +----<link linkend="GtkHBox">GtkHBox</link>
 
46
                                       +----<link linkend="GimpSelectButton">GimpSelectButton</link>
 
47
                                             +----GimpFontSelectButton
 
48
</synopsis>
 
49
 
 
50
</refsect1>
 
51
 
 
52
 
 
53
 
 
54
<refsect1 role="impl_interfaces">
 
55
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
56
<para>
 
57
GimpFontSelectButton implements
 
58
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
59
 
 
60
</refsect1>
 
61
 
 
62
 
 
63
<refsect1 role="properties">
 
64
<title role="properties.title">Properties</title>
 
65
<synopsis>
 
66
 
 
67
  &quot;<link linkend="GimpFontSelectButton--font-name">font-name</link>&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write
 
68
  &quot;<link linkend="GimpFontSelectButton--title">title</link>&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
 
69
</synopsis>
 
70
</refsect1>
 
71
 
 
72
<refsect1 role="signal_proto">
 
73
<title role="signal_proto.title">Signals</title>
 
74
<synopsis>
 
75
 
 
76
  &quot;<link linkend="GimpFontSelectButton-font-set">font-set</link>&quot;                                       : Run First
 
77
</synopsis>
 
78
</refsect1>
 
79
 
 
80
 
 
81
<refsect1 role="desc">
 
82
<title role="desc.title">Description</title>
 
83
<para>
 
84
 
 
85
</para>
 
86
</refsect1>
 
87
 
 
88
<refsect1 role="details">
 
89
<title role="details.title">Details</title>
 
90
<refsect2>
 
91
<title><anchor id="GimpFontSelectButton-struct" role="struct"/>GimpFontSelectButton</title>
 
92
<indexterm><primary>GimpFontSelectButton</primary></indexterm><programlisting>typedef struct _GimpFontSelectButton GimpFontSelectButton;</programlisting>
 
93
<para>
 
94
 
 
95
</para></refsect2>
 
96
<refsect2>
 
97
<title><anchor id="gimp-font-select-button-new" role="function" condition="since:GIMP 2.4"/>gimp_font_select_button_new ()</title>
 
98
<indexterm role="GIMP 2.4"><primary>gimp_font_select_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_font_select_button_new         (const <link linkend="gchar">gchar</link> *title,
 
99
                                                         const <link linkend="gchar">gchar</link> *font_name);</programlisting>
 
100
<para>
 
101
Creates a new <link linkend="GtkWidget"><type>GtkWidget</type></link> that completely controls the selection of
 
102
a font.  This widget is suitable for placement in a table in a
 
103
plug-in dialog.</para>
 
104
<para>
 
105
 
 
106
</para><variablelist role="params">
 
107
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
108
<listitem><simpara>     Title of the dialog to use or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the default title.
 
109
</simpara></listitem></varlistentry>
 
110
<varlistentry><term><parameter>font_name</parameter>&nbsp;:</term>
 
111
<listitem><simpara> Initial font name.
 
112
</simpara></listitem></varlistentry>
 
113
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
 
114
 
 
115
</simpara></listitem></varlistentry>
 
116
</variablelist><para role="since">Since  GIMP 2.4
 
117
</para></refsect2>
 
118
<refsect2>
 
119
<title><anchor id="gimp-font-select-button-get-font" role="function" condition="since:GIMP 2.4"/>gimp_font_select_button_get_font ()</title>
 
120
<indexterm role="GIMP 2.4"><primary>gimp_font_select_button_get_font</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_font_select_button_get_font    (<link linkend="GimpFontSelectButton">GimpFontSelectButton</link> *button);</programlisting>
 
121
<para>
 
122
Retrieves the name of currently selected font.</para>
 
123
<para>
 
124
 
 
125
</para><variablelist role="params">
 
126
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
127
<listitem><simpara> A <link linkend="GimpFontSelectButton"><type>GimpFontSelectButton</type></link>
 
128
</simpara></listitem></varlistentry>
 
129
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an internal copy of the font name which must not be freed.
 
130
 
 
131
</simpara></listitem></varlistentry>
 
132
</variablelist><para role="since">Since  GIMP 2.4
 
133
</para></refsect2>
 
134
<refsect2>
 
135
<title><anchor id="gimp-font-select-button-set-font" role="function" condition="since:GIMP 2.4"/>gimp_font_select_button_set_font ()</title>
 
136
<indexterm role="GIMP 2.4"><primary>gimp_font_select_button_set_font</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_font_select_button_set_font    (<link linkend="GimpFontSelectButton">GimpFontSelectButton</link> *button,
 
137
                                                         const <link linkend="gchar">gchar</link> *font_name);</programlisting>
 
138
<para>
 
139
Sets the current font for the font select button.</para>
 
140
<para>
 
141
 
 
142
</para><variablelist role="params">
 
143
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
144
<listitem><simpara> A <link linkend="GimpFontSelectButton"><type>GimpFontSelectButton</type></link>
 
145
</simpara></listitem></varlistentry>
 
146
<varlistentry><term><parameter>font_name</parameter>&nbsp;:</term>
 
147
<listitem><simpara> Font name to set; <link linkend="NULL:CAPS"><literal>NULL</literal></link> means no change.
 
148
</simpara></listitem></varlistentry>
 
149
</variablelist><para role="since">Since  GIMP 2.4
 
150
</para></refsect2>
 
151
 
 
152
</refsect1>
 
153
<refsect1 role="property_details">
 
154
<title role="property_details.title">Property Details</title>
 
155
<refsect2><title><anchor id="GimpFontSelectButton--font-name"/>The &quot;<literal>font-name</literal>&quot; property</title>
 
156
<indexterm role="GIMP 2.4"><primary>GimpFontSelectButton:font-name</primary></indexterm><programlisting>  &quot;font-name&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
157
<para>
 
158
The name of the currently selected font.</para>
 
159
<para>
 
160
 
 
161
</para><para>Default value: "Sans"</para>
 
162
<para>Since  GIMP 2.4
 
163
</para>
 
164
</refsect2>
 
165
<refsect2><title><anchor id="GimpFontSelectButton--title"/>The &quot;<literal>title</literal>&quot; property</title>
 
166
<indexterm role="GIMP 2.4"><primary>GimpFontSelectButton:title</primary></indexterm><programlisting>  &quot;title&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
 
167
<para>
 
168
The title to be used for the font selection popup dialog.</para>
 
169
<para>
 
170
 
 
171
</para><para>Default value: "Font Selection"</para>
 
172
<para>Since  GIMP 2.4
 
173
</para>
 
174
</refsect2>
 
175
 
 
176
</refsect1>
 
177
 
 
178
<refsect1 role="signals">
 
179
<title role="signals.title">Signal Details</title>
 
180
<refsect2><title><anchor id="GimpFontSelectButton-font-set"/>The &quot;font-set&quot; signal</title>
 
181
<indexterm role="GIMP 2.4"><primary>GimpFontSelectButton::font-set</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpFontSelectButton">GimpFontSelectButton</link> *widget,
 
182
                                                        <link linkend="gchar">gchar</link>                *font_name,
 
183
                                                        <link linkend="gboolean">gboolean</link>              dialog_closing,
 
184
                                                        <link linkend="gpointer">gpointer</link>              user_data)           : Run First</programlisting>
 
185
<para>
 
186
The ::font-set signal is emitted when the user selects a font.</para>
 
187
<para>
 
188
 
 
189
</para><variablelist role="params">
 
190
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
191
<listitem><simpara> the object which received the signal.
 
192
</simpara></listitem></varlistentry>
 
193
<varlistentry><term><parameter>font_name</parameter>&nbsp;:</term>
 
194
<listitem><simpara> the name of the currently selected font.
 
195
</simpara></listitem></varlistentry>
 
196
<varlistentry><term><parameter>dialog_closing</parameter>&nbsp;:</term>
 
197
<listitem><simpara> whether the dialog was closed or not.
 
198
</simpara></listitem></varlistentry>
 
199
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
200
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
201
</variablelist><para>Since  GIMP 2.4
 
202
</para></refsect2>
 
203
</refsect1>
 
204
 
 
205
 
 
206
 
 
207
</refentry>