1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<refentry id="GnomeHRef">
<refmeta>
<refentrytitle role="top_of_page">GnomeHRef</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeHRef</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
<link linkend="GnomeHRef-struct">GnomeHRef</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-href-new">gnome_href_new</link> (const <link linkend="gchar">gchar</link> *url,
const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link> <link linkend="gnome-href-set-url">gnome_href_set_url</link> (<link linkend="GnomeHRef">GnomeHRef</link> *href,
const <link linkend="gchar">gchar</link> *url);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-href-get-url">gnome_href_get_url</link> (<link linkend="GnomeHRef">GnomeHRef</link> *href);
<link linkend="void">void</link> <link linkend="gnome-href-set-text">gnome_href_set_text</link> (<link linkend="GnomeHRef">GnomeHRef</link> *href,
const <link linkend="gchar">gchar</link> *text);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-href-get-text">gnome_href_get_text</link> (<link linkend="GnomeHRef">GnomeHRef</link> *href);
<link linkend="void">void</link> <link linkend="gnome-href-set-label">gnome_href_set_label</link> (<link linkend="GnomeHRef">GnomeHRef</link> *href,
const <link linkend="gchar">gchar</link> *label);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-href-get-label">gnome_href_get_label</link> (<link linkend="GnomeHRef">GnomeHRef</link> *href);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkButton">GtkButton</link>
+----GnomeHRef
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeHRef implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GnomeHRef--text">text</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GnomeHRef--url">url</link>" <link linkend="gchararray">gchararray</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="style_properties">
<title role="style_properties.title">Style Properties</title>
<synopsis>
"<link linkend="GnomeHRef--link-color">link-color</link>" <link linkend="GdkColor">GdkColor</link> : Read
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomeHRef-struct" role="struct"/>GnomeHRef</title>
<indexterm role="deprecated"><primary>GnomeHRef</primary></indexterm><programlisting>typedef struct _GnomeHRef GnomeHRef;</programlisting>
<warning><para><literal>GnomeHRef</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gnome-href-new" role="function" condition="deprecated:"/>gnome_href_new ()</title>
<indexterm role="deprecated"><primary>gnome_href_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_href_new (const <link linkend="gchar">gchar</link> *url,
const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gnome_href_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Created a GNOME href object, a label widget with a clickable action
and an associated URL. If <parameter>text</parameter> is set to <link linkend="NULL:CAPS"><literal>NULL</literal></link>, <parameter>url</parameter> is used as
the text for the label.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter> :</term>
<listitem><simpara> URL assigned to this object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> Text associated with the URL.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to new GNOME href widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-href-set-url" role="function" condition="deprecated:"/>gnome_href_set_url ()</title>
<indexterm role="deprecated"><primary>gnome_href_set_url</primary></indexterm><programlisting><link linkend="void">void</link> gnome_href_set_url (<link linkend="GnomeHRef">GnomeHRef</link> *href,
const <link linkend="gchar">gchar</link> *url);</programlisting>
<warning><para><literal>gnome_href_set_url</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the internal URL value within <parameter>href</parameter> to the value of <parameter>url</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter> :</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url</parameter> :</term>
<listitem><simpara> String containing the URL to be stored within <parameter>href</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-href-get-url" role="function" condition="deprecated:"/>gnome_href_get_url ()</title>
<indexterm role="deprecated"><primary>gnome_href_get_url</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_href_get_url (<link linkend="GnomeHRef">GnomeHRef</link> *href);</programlisting>
<warning><para><literal>gnome_href_get_url</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the pointer to the URL associated with the <parameter>href</parameter> href object. Note
that the string should not be freed as it is internal memory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter> :</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to an internal URL string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-href-set-text" role="function" condition="deprecated:"/>gnome_href_set_text ()</title>
<indexterm role="deprecated"><primary>gnome_href_set_text</primary></indexterm><programlisting><link linkend="void">void</link> gnome_href_set_text (<link linkend="GnomeHRef">GnomeHRef</link> *href,
const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gnome_href_set_text</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the internal label widget text (used to display a URL's link
text) to the value given in <parameter>label</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter> :</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> New link text for the href object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-href-get-text" role="function" condition="deprecated:"/>gnome_href_get_text ()</title>
<indexterm role="deprecated"><primary>gnome_href_get_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_href_get_text (<link linkend="GnomeHRef">GnomeHRef</link> *href);</programlisting>
<warning><para><literal>gnome_href_get_text</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the contents of the label widget used to display the link text.
Note that the string should not be freed as it points to internal memory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter> :</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to text contained in the label widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-href-set-label" role="function" condition="deprecated:"/>gnome_href_set_label ()</title>
<indexterm role="deprecated"><primary>gnome_href_set_label</primary></indexterm><programlisting><link linkend="void">void</link> gnome_href_set_label (<link linkend="GnomeHRef">GnomeHRef</link> *href,
const <link linkend="gchar">gchar</link> *label);</programlisting>
<warning><para><literal>gnome_href_set_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
deprecated, use <link linkend="gnome-href-set-text"><type>gnome_href_set_text</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter> :</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> New link text for the href object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-href-get-label" role="function" condition="deprecated:"/>gnome_href_get_label ()</title>
<indexterm role="deprecated"><primary>gnome_href_get_label</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_href_get_label (<link linkend="GnomeHRef">GnomeHRef</link> *href);</programlisting>
<warning><para><literal>gnome_href_get_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated, use <link linkend="gnome-href-get-text"><type>gnome_href_get_text</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter> :</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomeHRef--text"/>The <literal>"text"</literal> property</title>
<indexterm><primary>GnomeHRef:text</primary></indexterm><programlisting> "text" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>The text on the button.</para><para>Default value: "End World Hunger"</para>
</refsect2>
<refsect2><title><anchor id="GnomeHRef--url"/>The <literal>"url"</literal> property</title>
<indexterm><primary>GnomeHRef:url</primary></indexterm><programlisting> "url" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>The URL that GnomeHRef activates.</para><para>Default value: "http://www.wfp.org"</para>
</refsect2>
</refsect1>
<refsect1 role="style_properties_details">
<title role="style_properties_details.title">Style Property Details</title>
<refsect2><title><anchor id="GnomeHRef--link-color"/>The <literal>"link-color"</literal> style property</title>
<indexterm><primary>GnomeHRef:link-color</primary></indexterm><programlisting> "link-color" <link linkend="GdkColor">GdkColor</link> : Read</programlisting>
<para>Color used to draw the link.</para></refsect2>
</refsect1>
</refentry>
|
