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
<refentry id="GeditMessageArea">
6
<refentrytitle role="top_of_page" id="GeditMessageArea.top_of_page">GeditMessageArea</refentrytitle>
7
<manvolnum>3</manvolnum>
8
<refmiscinfo>GEDIT Library</refmiscinfo>
12
<refname>GeditMessageArea</refname>
13
<refpurpose></refpurpose>
16
<refsynopsisdiv id="GeditMessageArea.synopsis" role="synopsis">
17
<title role="synopsis.title">Synopsis</title>
20
<link linkend="GeditMessageAreaPrivate">GeditMessageAreaPrivate</link>;
21
<link linkend="GeditMessageArea-struct">GeditMessageArea</link>;
22
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gedit-message-area-new">gedit_message_area_new</link> (void);
23
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gedit-message-area-new-with-buttons">gedit_message_area_new_with_buttons</link> (const <link linkend="gchar">gchar</link> *first_button_text,
25
<link linkend="void">void</link> <link linkend="gedit-message-area-set-contents">gedit_message_area_set_contents</link> (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
26
<link linkend="GtkWidget">GtkWidget</link> *contents);
27
<link linkend="void">void</link> <link linkend="gedit-message-area-add-action-widget">gedit_message_area_add_action_widget</link>
28
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
29
<link linkend="GtkWidget">GtkWidget</link> *child,
30
<link linkend="gint">gint</link> response_id);
31
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gedit-message-area-add-button">gedit_message_area_add_button</link> (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
32
const <link linkend="gchar">gchar</link> *button_text,
33
<link linkend="gint">gint</link> response_id);
34
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gedit-message-area-add-stock-button-with-text">gedit_message_area_add_stock_button_with_text</link>
35
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
36
const <link linkend="gchar">gchar</link> *text,
37
const <link linkend="gchar">gchar</link> *stock_id,
38
<link linkend="gint">gint</link> response_id);
39
<link linkend="void">void</link> <link linkend="gedit-message-area-add-buttons">gedit_message_area_add_buttons</link> (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
40
const <link linkend="gchar">gchar</link> *first_button_text,
42
<link linkend="void">void</link> <link linkend="gedit-message-area-set-response-sensitive">gedit_message_area_set_response_sensitive</link>
43
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
44
<link linkend="gint">gint</link> response_id,
45
<link linkend="gboolean">gboolean</link> setting);
46
<link linkend="void">void</link> <link linkend="gedit-message-area-set-default-response">gedit_message_area_set_default_response</link>
47
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
48
<link linkend="gint">gint</link> response_id);
49
<link linkend="void">void</link> <link linkend="gedit-message-area-response">gedit_message_area_response</link> (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
50
<link linkend="gint">gint</link> response_id);
54
<refsect1 id="GeditMessageArea.object-hierarchy" role="object_hierarchy">
55
<title role="object_hierarchy.title">Object Hierarchy</title>
57
<link linkend="GObject">GObject</link>
58
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
59
+----<link linkend="GtkObject">GtkObject</link>
60
+----<link linkend="GtkWidget">GtkWidget</link>
61
+----<link linkend="GtkContainer">GtkContainer</link>
62
+----<link linkend="GtkBox">GtkBox</link>
63
+----<link linkend="GtkHBox">GtkHBox</link>
65
+----<link linkend="GeditProgressMessageArea">GeditProgressMessageArea</link>
71
<refsect1 id="GeditMessageArea.implemented-interfaces" role="impl_interfaces">
72
<title role="impl_interfaces.title">Implemented Interfaces</title>
74
GeditMessageArea implements
75
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkBuildable">GtkBuildable</link> and <link linkend="GtkOrientable">GtkOrientable</link>.</para>
80
<refsect1 id="GeditMessageArea.signals" role="signal_proto">
81
<title role="signal_proto.title">Signals</title>
83
"<link linkend="GeditMessageArea-close">close</link>" : Run Last / Action
84
"<link linkend="GeditMessageArea-response">response</link>" : Run Last
89
<refsect1 id="GeditMessageArea.description" role="desc">
90
<title role="desc.title">Description</title>
96
<refsect1 id="GeditMessageArea.details" role="details">
97
<title role="details.title">Details</title>
98
<refsect2 id="GeditMessageAreaPrivate" role="struct">
99
<title>GeditMessageAreaPrivate</title>
100
<indexterm zone="GeditMessageAreaPrivate"><primary>GeditMessageAreaPrivate</primary></indexterm>
101
<programlisting>typedef struct _GeditMessageAreaPrivate GeditMessageAreaPrivate;</programlisting>
104
<refsect2 id="GeditMessageArea-struct" role="struct">
105
<title>GeditMessageArea</title>
106
<indexterm zone="GeditMessageArea-struct"><primary>GeditMessageArea</primary></indexterm>
107
<programlisting>typedef struct _GeditMessageArea GeditMessageArea;</programlisting>
110
<refsect2 id="gedit-message-area-new" role="function">
111
<title>gedit_message_area_new ()</title>
112
<indexterm zone="gedit-message-area-new"><primary>gedit_message_area_new</primary></indexterm>
113
<programlisting><link linkend="GtkWidget">GtkWidget</link> * gedit_message_area_new (void);</programlisting>
115
Creates a new <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link> object.</para>
117
</para><variablelist role="params">
118
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link> object
119
</simpara></listitem></varlistentry>
120
</variablelist></refsect2>
121
<refsect2 id="gedit-message-area-new-with-buttons" role="function">
122
<title>gedit_message_area_new_with_buttons ()</title>
123
<indexterm zone="gedit-message-area-new-with-buttons"><primary>gedit_message_area_new_with_buttons</primary></indexterm>
124
<programlisting><link linkend="GtkWidget">GtkWidget</link> * gedit_message_area_new_with_buttons (const <link linkend="gchar">gchar</link> *first_button_text,
125
...);</programlisting>
127
Creates a new <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link> with buttons. Button text/response ID pairs
128
should be listed, with a NULL pointer ending the list. Button text can be either
129
a stock ID such as GTK_STOCK_OK, or some arbitrary text. A response ID can be any
130
positive number, or one of the values in the GtkResponseType enumeration. If
131
the user clicks one of these dialog buttons, GeditMessageArea will emit the "response"
132
signal with the corresponding response ID.</para>
134
</para><variablelist role="params">
135
<varlistentry><term><parameter>first_button_text</parameter> :</term>
136
<listitem><simpara> stock ID or text to go in first button, or NULL
137
</simpara></listitem></varlistentry>
138
<varlistentry><term><parameter>...</parameter> :</term>
139
<listitem><simpara> response ID for first button, then additional buttons, ending with NULL
140
</simpara></listitem></varlistentry>
141
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
142
</simpara></listitem></varlistentry>
143
</variablelist></refsect2>
144
<refsect2 id="gedit-message-area-set-contents" role="function">
145
<title>gedit_message_area_set_contents ()</title>
146
<indexterm zone="gedit-message-area-set-contents"><primary>gedit_message_area_set_contents</primary></indexterm>
147
<programlisting><link linkend="void">void</link> gedit_message_area_set_contents (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
148
<link linkend="GtkWidget">GtkWidget</link> *contents);</programlisting>
150
Adds the <parameter>contents</parameter> widget to the contents area of <link linkend="GeditMessageArea."><type>GeditMessageArea.</type></link></para>
152
</para><variablelist role="params">
153
<varlistentry><term><parameter>message_area</parameter> :</term>
154
<listitem><simpara> a <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
155
</simpara></listitem></varlistentry>
156
<varlistentry><term><parameter>contents</parameter> :</term>
157
<listitem><simpara> widget you want to add to the contents area
158
</simpara></listitem></varlistentry>
159
</variablelist></refsect2>
160
<refsect2 id="gedit-message-area-add-action-widget" role="function">
161
<title>gedit_message_area_add_action_widget ()</title>
162
<indexterm zone="gedit-message-area-add-action-widget"><primary>gedit_message_area_add_action_widget</primary></indexterm>
163
<programlisting><link linkend="void">void</link> gedit_message_area_add_action_widget
164
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
165
<link linkend="GtkWidget">GtkWidget</link> *child,
166
<link linkend="gint">gint</link> response_id);</programlisting>
168
</para><variablelist role="params">
169
<varlistentry><term><parameter>message_area</parameter> :</term>
171
</simpara></listitem></varlistentry>
172
<varlistentry><term><parameter>child</parameter> :</term>
174
</simpara></listitem></varlistentry>
175
<varlistentry><term><parameter>response_id</parameter> :</term>
177
</simpara></listitem></varlistentry>
178
</variablelist></refsect2>
179
<refsect2 id="gedit-message-area-add-button" role="function">
180
<title>gedit_message_area_add_button ()</title>
181
<indexterm zone="gedit-message-area-add-button"><primary>gedit_message_area_add_button</primary></indexterm>
182
<programlisting><link linkend="GtkWidget">GtkWidget</link> * gedit_message_area_add_button (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
183
const <link linkend="gchar">gchar</link> *button_text,
184
<link linkend="gint">gint</link> response_id);</programlisting>
186
Adds a button with the given text (or a stock button, if button_text is a stock ID)
187
and sets things up so that clicking the button will emit the "response" signal
188
with the given response_id. The button is appended to the end of the message area's
189
action area. The button widget is returned, but usually you don't need it.</para>
191
</para><variablelist role="params">
192
<varlistentry><term><parameter>message_area</parameter> :</term>
193
<listitem><simpara> a <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
194
</simpara></listitem></varlistentry>
195
<varlistentry><term><parameter>button_text</parameter> :</term>
196
<listitem><simpara> text of button, or stock ID
197
</simpara></listitem></varlistentry>
198
<varlistentry><term><parameter>response_id</parameter> :</term>
199
<listitem><simpara> response ID for the button
200
</simpara></listitem></varlistentry>
201
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the button widget that was added
202
</simpara></listitem></varlistentry>
203
</variablelist></refsect2>
204
<refsect2 id="gedit-message-area-add-stock-button-with-text" role="function">
205
<title>gedit_message_area_add_stock_button_with_text ()</title>
206
<indexterm zone="gedit-message-area-add-stock-button-with-text"><primary>gedit_message_area_add_stock_button_with_text</primary></indexterm>
207
<programlisting><link linkend="GtkWidget">GtkWidget</link> * gedit_message_area_add_stock_button_with_text
208
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
209
const <link linkend="gchar">gchar</link> *text,
210
const <link linkend="gchar">gchar</link> *stock_id,
211
<link linkend="gint">gint</link> response_id);</programlisting>
213
Same as <link linkend="gedit-message-area-add-button"><function>gedit_message_area_add_button()</function></link> but with a specific text.</para>
215
</para><variablelist role="params">
216
<varlistentry><term><parameter>message_area</parameter> :</term>
217
<listitem><simpara> a <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
218
</simpara></listitem></varlistentry>
219
<varlistentry><term><parameter>text</parameter> :</term>
220
<listitem><simpara> the text to visualize in the button
221
</simpara></listitem></varlistentry>
222
<varlistentry><term><parameter>stock_id</parameter> :</term>
223
<listitem><simpara> the stock ID of the button
224
</simpara></listitem></varlistentry>
225
<varlistentry><term><parameter>response_id</parameter> :</term>
226
<listitem><simpara> a response ID
227
</simpara></listitem></varlistentry>
228
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
229
</simpara></listitem></varlistentry>
230
</variablelist></refsect2>
231
<refsect2 id="gedit-message-area-add-buttons" role="function">
232
<title>gedit_message_area_add_buttons ()</title>
233
<indexterm zone="gedit-message-area-add-buttons"><primary>gedit_message_area_add_buttons</primary></indexterm>
234
<programlisting><link linkend="void">void</link> gedit_message_area_add_buttons (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
235
const <link linkend="gchar">gchar</link> *first_button_text,
236
...);</programlisting>
238
Adds more buttons, same as calling <link linkend="gedit-message-area-add-button"><function>gedit_message_area_add_button()</function></link> repeatedly.
239
The variable argument list should be NULL-terminated as with
240
<link linkend="gedit-message-area-new-with-buttons"><function>gedit_message_area_new_with_buttons()</function></link>. Each button must have both text and response ID.</para>
242
</para><variablelist role="params">
243
<varlistentry><term><parameter>message_area</parameter> :</term>
244
<listitem><simpara> a <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
245
</simpara></listitem></varlistentry>
246
<varlistentry><term><parameter>first_button_text</parameter> :</term>
247
<listitem><simpara> button text or stock ID
248
</simpara></listitem></varlistentry>
249
<varlistentry><term><parameter>...</parameter> :</term>
250
<listitem><simpara> response ID for first button, then more text-response_id pairs
251
</simpara></listitem></varlistentry>
252
</variablelist></refsect2>
253
<refsect2 id="gedit-message-area-set-response-sensitive" role="function">
254
<title>gedit_message_area_set_response_sensitive ()</title>
255
<indexterm zone="gedit-message-area-set-response-sensitive"><primary>gedit_message_area_set_response_sensitive</primary></indexterm>
256
<programlisting><link linkend="void">void</link> gedit_message_area_set_response_sensitive
257
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
258
<link linkend="gint">gint</link> response_id,
259
<link linkend="gboolean">gboolean</link> setting);</programlisting>
261
Calls gtk_widget_set_sensitive (widget, setting) for each widget in the dialog's
262
action area with the given response_id. A convenient way to sensitize/desensitize
263
dialog buttons.</para>
265
</para><variablelist role="params">
266
<varlistentry><term><parameter>message_area</parameter> :</term>
267
<listitem><simpara> a <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
268
</simpara></listitem></varlistentry>
269
<varlistentry><term><parameter>response_id</parameter> :</term>
270
<listitem><simpara> a response ID
271
</simpara></listitem></varlistentry>
272
<varlistentry><term><parameter>setting</parameter> :</term>
273
<listitem><simpara> TRUE for sensitive
274
</simpara></listitem></varlistentry>
275
</variablelist></refsect2>
276
<refsect2 id="gedit-message-area-set-default-response" role="function">
277
<title>gedit_message_area_set_default_response ()</title>
278
<indexterm zone="gedit-message-area-set-default-response"><primary>gedit_message_area_set_default_response</primary></indexterm>
279
<programlisting><link linkend="void">void</link> gedit_message_area_set_default_response
280
(<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
281
<link linkend="gint">gint</link> response_id);</programlisting>
283
Emits the 'response' signal with the given <parameter>response_id</parameter>.</para>
285
</para><variablelist role="params">
286
<varlistentry><term><parameter>message_area</parameter> :</term>
287
<listitem><simpara> a <link linkend="GeditMessageArea"><type>GeditMessageArea</type></link>
288
</simpara></listitem></varlistentry>
289
<varlistentry><term><parameter>response_id</parameter> :</term>
290
<listitem><simpara> a response ID
291
</simpara></listitem></varlistentry>
292
</variablelist></refsect2>
293
<refsect2 id="gedit-message-area-response" role="function">
294
<title>gedit_message_area_response ()</title>
295
<indexterm zone="gedit-message-area-response"><primary>gedit_message_area_response</primary></indexterm>
296
<programlisting><link linkend="void">void</link> gedit_message_area_response (<link linkend="GeditMessageArea">GeditMessageArea</link> *message_area,
297
<link linkend="gint">gint</link> response_id);</programlisting>
299
</para><variablelist role="params">
300
<varlistentry><term><parameter>message_area</parameter> :</term>
302
</simpara></listitem></varlistentry>
303
<varlistentry><term><parameter>response_id</parameter> :</term>
305
</simpara></listitem></varlistentry>
306
</variablelist></refsect2>
310
<refsect1 id="GeditMessageArea.signal-details" role="signals">
311
<title role="signals.title">Signal Details</title>
312
<refsect2 id="GeditMessageArea-close" role="signal"><title>The <literal>"close"</literal> signal</title>
313
<indexterm zone="GeditMessageArea-close"><primary>GeditMessageArea::close</primary></indexterm>
314
<programlisting><link linkend="void">void</link> user_function (<link linkend="GeditMessageArea">GeditMessageArea</link> *geditmessagearea,
315
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
317
</para><variablelist role="params">
318
<varlistentry><term><parameter>geditmessagearea</parameter> :</term>
319
<listitem><simpara>the object which received the signal.
320
</simpara></listitem></varlistentry>
321
<varlistentry><term><parameter>user_data</parameter> :</term>
322
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
323
</variablelist></refsect2><refsect2 id="GeditMessageArea-response" role="signal"><title>The <literal>"response"</literal> signal</title>
324
<indexterm zone="GeditMessageArea-response"><primary>GeditMessageArea::response</primary></indexterm>
325
<programlisting><link linkend="void">void</link> user_function (<link linkend="GeditMessageArea">GeditMessageArea</link> *geditmessagearea,
326
<link linkend="gint">gint</link> arg1,
327
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
329
</para><variablelist role="params">
330
<varlistentry><term><parameter>geditmessagearea</parameter> :</term>
331
<listitem><simpara>the object which received the signal.
332
</simpara></listitem></varlistentry>
333
<varlistentry><term><parameter>arg1</parameter> :</term>
335
</simpara></listitem></varlistentry>
336
<varlistentry><term><parameter>user_data</parameter> :</term>
337
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
338
</variablelist></refsect2>