← Back to branch summary

~ubuntu-branches/debian/jessie/glib2.0/jessie

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gicon.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gicon.xml
5
5
]>
6
6
<refentry id="GIcon">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GIcon</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GIcon.top_of_page">GIcon</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GIcon</refname>
15
15
<refpurpose>Interface for icons</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GIcon.synopsis" role="synopsis">
20
19
<title role="synopsis.title">Synopsis</title>
21
20
 
22
21
<synopsis>
23
22
 
24
23
#include &lt;gio/gio.h&gt;
25
24
 
26
 
 
27
25
                    <link linkend="GIcon-struct">GIcon</link>;
28
26
                    <link linkend="GIconIface">GIconIface</link>;
29
27
<link linkend="guint">guint</link>               <link linkend="g-icon-hash">g_icon_hash</link>                         (<link linkend="gconstpointer">gconstpointer</link> icon);
30
28
<link linkend="gboolean">gboolean</link>            <link linkend="g-icon-equal">g_icon_equal</link>                        (<link linkend="GIcon">GIcon</link> *icon1,
31
29
                                                         <link linkend="GIcon">GIcon</link> *icon2);
32
 
 
33
 
 
34
30
</synopsis>
35
31
</refsynopsisdiv>
36
32
 
37
 
<refsect1 role="object_hierarchy">
 
33
<refsect1 id="GIcon.object-hierarchy" role="object_hierarchy">
38
34
<title role="object_hierarchy.title">Object Hierarchy</title>
39
35
<synopsis>
40
 
 
41
36
  <link linkend="GInterface">GInterface</link>
42
37
   +----GIcon
43
38
</synopsis>
44
 
 
45
39
</refsect1>
46
40
 
47
 
<refsect1 role="prerequisites">
 
41
<refsect1 id="GIcon.prerequisites" role="prerequisites">
48
42
<title role="prerequisites.title">Prerequisites</title>
49
43
<para>
50
44
GIcon requires
51
45
 <link linkend="GObject">GObject</link>.</para>
52
 
 
53
46
</refsect1>
54
47
 
55
 
<refsect1 role="derived_interfaces">
 
48
<refsect1 id="GIcon.derived-interfaces" role="derived_interfaces">
56
49
<title role="derived_interfaces.title">Known Derived Interfaces</title>
57
50
<para>
58
51
GIcon is required by
59
52
 <link linkend="GLoadableIcon">GLoadableIcon</link>.</para>
60
 
 
61
53
</refsect1>
62
54
 
63
55
 
64
 
<refsect1 role="implementations">
 
56
<refsect1 id="GIcon.implementations" role="implementations">
65
57
<title role="implementations.title">Known Implementations</title>
66
58
<para>
67
59
GIcon is implemented by
68
 
 <link linkend="GThemedIcon">GThemedIcon</link> and  <link linkend="GFileIcon">GFileIcon</link>.</para>
69
 
 
 
60
 <link linkend="GThemedIcon">GThemedIcon</link>,  <link linkend="GFileIcon">GFileIcon</link>,  <link linkend="GEmblem">GEmblem</link> and  <link linkend="GEmblemedIcon">GEmblemedIcon</link>.</para>
70
61
</refsect1>
71
62
 
72
63
 
73
64
 
74
65
 
75
 
<refsect1 role="desc">
 
66
<refsect1 id="GIcon.description" role="desc">
76
67
<title role="desc.title">Description</title>
77
68
<para>
78
69
<link linkend="GIcon"><type>GIcon</type></link> is a very minimal interface for icons. It provides functions 
89
80
<para>
90
81
To check if two <link linkend="GIcons"><type>GIcons</type></link> are equal, see <link linkend="g-icon-equal"><function>g_icon_equal()</function></link>.</para>
91
82
<para>
92
 
 
93
83
</para>
94
84
</refsect1>
95
85
 
96
 
<refsect1 role="details">
 
86
<refsect1 id="GIcon.details" role="details">
97
87
<title role="details.title">Details</title>
98
 
<refsect2>
99
 
<title><anchor id="GIcon-struct" role="struct"/>GIcon</title>
100
 
<indexterm><primary>GIcon</primary></indexterm><programlisting>typedef struct _GIcon GIcon;</programlisting>
 
88
<refsect2 id="GIcon-struct" role="struct">
 
89
<title>GIcon</title>
 
90
<indexterm zone="GIcon-struct"><primary sortas="GIcon">GIcon</primary></indexterm><programlisting>typedef struct _GIcon GIcon;</programlisting>
101
91
<para>
102
92
An abstract type that specifies an icon.</para>
103
93
<para>
104
 
 
105
94
</para></refsect2>
106
 
<refsect2>
107
 
<title><anchor id="GIconIface" role="struct"/>GIconIface</title>
108
 
<indexterm><primary>GIconIface</primary></indexterm><programlisting>typedef struct {
 
95
<refsect2 id="GIconIface" role="struct">
 
96
<title>GIconIface</title>
 
97
<indexterm zone="GIconIface"><primary sortas="GIconIface">GIconIface</primary></indexterm><programlisting>typedef struct {
109
98
  GTypeInterface g_iface;
110
99
 
111
100
  /* Virtual Table */
112
101
 
113
 
  guint               (*hash)               (GIcon                *icon);
114
 
  gboolean            (*equal)              (GIcon                *icon1,
115
 
                                             GIcon                *icon2);
 
102
  guint    (* hash)  (GIcon *icon);
 
103
  gboolean (* equal) (GIcon *icon1,
 
104
                      GIcon *icon2);
116
105
} GIconIface;
117
106
</programlisting>
118
107
<para>
120
109
different systems. See <link linkend="GThemedIcon"><type>GThemedIcon</type></link> and <link linkend="GLoadableIcon"><type>GLoadableIcon</type></link> for
121
110
examples of how to implement this interface.</para>
122
111
<para>
123
 
 
124
112
</para><variablelist role="struct">
125
113
<varlistentry>
126
 
<term><link linkend="GTypeInterface">GTypeInterface</link>&nbsp;<structfield>g_iface</structfield>;</term>
 
114
<term><link linkend="GTypeInterface">GTypeInterface</link>&#160;<structfield>g_iface</structfield>;</term>
127
115
<listitem><simpara> The parent interface.
128
116
</simpara></listitem>
129
117
</varlistentry>
130
118
<varlistentry>
131
 
<term><structfield>hash</structfield>&nbsp;()</term>
 
119
<term><structfield>hash</structfield>&#160;()</term>
132
120
<listitem><simpara> A hash for a given <link linkend="GIcon"><type>GIcon</type></link>.
133
121
</simpara></listitem>
134
122
</varlistentry>
135
123
<varlistentry>
136
 
<term><structfield>equal</structfield>&nbsp;()</term>
 
124
<term><structfield>equal</structfield>&#160;()</term>
137
125
<listitem><simpara> Checks if two <link linkend="GIcon"><type>GIcon</type></link><!-- -->s are equal.
138
126
</simpara></listitem>
139
127
</varlistentry>
140
128
</variablelist></refsect2>
141
 
<refsect2>
142
 
<title><anchor id="g-icon-hash" role="function"/>g_icon_hash ()</title>
143
 
<indexterm><primary>g_icon_hash</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_icon_hash                         (<link linkend="gconstpointer">gconstpointer</link> icon);</programlisting>
 
129
<refsect2 id="g-icon-hash" role="function">
 
130
<title>g_icon_hash ()</title>
 
131
<indexterm zone="g-icon-hash"><primary sortas="g_icon_hash">g_icon_hash</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_icon_hash                         (<link linkend="gconstpointer">gconstpointer</link> icon);</programlisting>
144
132
<para>
145
133
Gets a hash for an icon.</para>
146
134
<para>
147
 
 
148
135
</para><variablelist role="params">
149
 
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
136
<varlistentry><term><parameter>icon</parameter>&#160;:</term>
150
137
<listitem><simpara> <link linkend="gconstpointer"><type>gconstpointer</type></link> to an icon object.
151
138
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="guint"><type>guint</type></link> containing a hash for the <parameter>icon</parameter>, suitable for 
 
139
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="guint"><type>guint</type></link> containing a hash for the <parameter>icon</parameter>, suitable for 
153
140
use in a <link linkend="GHashTable"><type>GHashTable</type></link> or similar data structure.
154
141
</simpara></listitem></varlistentry>
155
142
</variablelist></refsect2>
156
 
<refsect2>
157
 
<title><anchor id="g-icon-equal" role="function"/>g_icon_equal ()</title>
158
 
<indexterm><primary>g_icon_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_icon_equal                        (<link linkend="GIcon">GIcon</link> *icon1,
 
143
<refsect2 id="g-icon-equal" role="function">
 
144
<title>g_icon_equal ()</title>
 
145
<indexterm zone="g-icon-equal"><primary sortas="g_icon_equal">g_icon_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_icon_equal                        (<link linkend="GIcon">GIcon</link> *icon1,
159
146
                                                         <link linkend="GIcon">GIcon</link> *icon2);</programlisting>
160
147
<para>
161
148
Checks if two icons are equal.</para>
162
149
<para>
163
 
 
164
150
</para><variablelist role="params">
165
 
<varlistentry><term><parameter>icon1</parameter>&nbsp;:</term>
 
151
<varlistentry><term><parameter>icon1</parameter>&#160;:</term>
166
152
<listitem><simpara> pointer to the first <link linkend="GIcon"><type>GIcon</type></link>.
167
153
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><parameter>icon2</parameter>&nbsp;:</term>
 
154
<varlistentry><term><parameter>icon2</parameter>&#160;:</term>
169
155
<listitem><simpara> pointer to the second <link linkend="GIcon"><type>GIcon</type></link>.
170
156
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>icon1</parameter> is equal to <parameter>icon2</parameter>. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
157
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>icon1</parameter> is equal to <parameter>icon2</parameter>. <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
172
158
</simpara></listitem></varlistentry>
173
159
</variablelist></refsect2>
174
160
 
177
163
 
178
164
 
179
165
 
180
 
 
181
 
<refsect1><refsect2 /><refsect2 /></refsect1>
182
166
</refentry>