← 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/gemblemedicon.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/gemblemedicon.xml
 
1
<?xml version="1.0"?>
 
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
<!ENTITY version SYSTEM "version.xml">
 
5
]>
 
6
<refentry id="GEmblemedIcon">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page" id="GEmblemedIcon.top_of_page">GEmblemedIcon</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>GIO Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>GEmblemedIcon</refname>
 
15
<refpurpose>Icon with emblems</refpurpose>
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv id="GEmblemedIcon.synopsis" role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
 
 
23
#include &lt;gio/gio.h&gt;
 
24
 
 
25
                    <link linkend="GEmblemedIcon-struct">GEmblemedIcon</link>;
 
26
<link linkend="GIcon">GIcon</link> *             <link linkend="g-emblemed-icon-new">g_emblemed_icon_new</link>                 (<link linkend="GIcon">GIcon</link> *icon,
 
27
                                                         <link linkend="GEmblem">GEmblem</link> *emblem);
 
28
<link linkend="GIcon">GIcon</link> *             <link linkend="g-emblemed-icon-get-icon">g_emblemed_icon_get_icon</link>            (<link linkend="GEmblemedIcon">GEmblemedIcon</link> *emblemed);
 
29
<link linkend="GList">GList</link> *             <link linkend="g-emblemed-icon-get-emblems">g_emblemed_icon_get_emblems</link>         (<link linkend="GEmblemedIcon">GEmblemedIcon</link> *emblemed);
 
30
<link linkend="void">void</link>                <link linkend="g-emblemed-icon-add-emblem">g_emblemed_icon_add_emblem</link>          (<link linkend="GEmblemedIcon">GEmblemedIcon</link> *emblemed,
 
31
                                                         <link linkend="GEmblem">GEmblem</link> *emblem);
 
32
</synopsis>
 
33
</refsynopsisdiv>
 
34
 
 
35
<refsect1 id="GEmblemedIcon.object-hierarchy" role="object_hierarchy">
 
36
<title role="object_hierarchy.title">Object Hierarchy</title>
 
37
<synopsis>
 
38
  <link linkend="GObject">GObject</link>
 
39
   +----GEmblemedIcon
 
40
</synopsis>
 
41
</refsect1>
 
42
 
 
43
 
 
44
 
 
45
<refsect1 id="GEmblemedIcon.implemented-interfaces" role="impl_interfaces">
 
46
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
47
<para>
 
48
GEmblemedIcon implements
 
49
 <link linkend="GIcon">GIcon</link>.</para>
 
50
</refsect1>
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
<refsect1 id="GEmblemedIcon.description" role="desc">
 
57
<title role="desc.title">Description</title>
 
58
<para>
 
59
<link linkend="GEmblemedIcon"><type>GEmblemedIcon</type></link> is an implementation of <link linkend="GIcon"><type>GIcon</type></link> that supports
 
60
adding an emblem to an icon. Adding multiple emblems to an
 
61
icon is ensured via <link linkend="g-emblemed-icon-add-emblem"><function>g_emblemed_icon_add_emblem()</function></link>. 
 
62
</para>
 
63
<para>
 
64
Note that <link linkend="GEmblemedIcon"><type>GEmblemedIcon</type></link> allows no control over the position
 
65
of the emblems. See also <link linkend="GEmblem"><type>GEmblem</type></link> for more information.</para>
 
66
<para>
 
67
</para>
 
68
</refsect1>
 
69
 
 
70
<refsect1 id="GEmblemedIcon.details" role="details">
 
71
<title role="details.title">Details</title>
 
72
<refsect2 id="GEmblemedIcon-struct" role="struct">
 
73
<title>GEmblemedIcon</title>
 
74
<indexterm zone="GEmblemedIcon-struct"><primary sortas="GEmblemedIcon">GEmblemedIcon</primary></indexterm><programlisting>typedef struct _GEmblemedIcon GEmblemedIcon;</programlisting>
 
75
<para>
 
76
An implementation of <link linkend="GIcon"><type>GIcon</type></link> for icons with emblems.</para>
 
77
<para>
 
78
</para></refsect2>
 
79
<refsect2 id="g-emblemed-icon-new" role="function" condition="since:2.18">
 
80
<title>g_emblemed_icon_new ()</title>
 
81
<indexterm zone="g-emblemed-icon-new" role="2.18"><primary sortas="g_emblemed_icon_new">g_emblemed_icon_new</primary></indexterm><programlisting><link linkend="GIcon">GIcon</link> *             g_emblemed_icon_new                 (<link linkend="GIcon">GIcon</link> *icon,
 
82
                                                         <link linkend="GEmblem">GEmblem</link> *emblem);</programlisting>
 
83
<para>
 
84
Creates a new emblemed icon for <parameter>icon</parameter> with the emblem <parameter>emblem</parameter>.</para>
 
85
<para>
 
86
</para><variablelist role="params">
 
87
<varlistentry><term><parameter>icon</parameter>&#160;:</term>
 
88
<listitem><simpara> a <link linkend="GIcon"><type>GIcon</type></link>
 
89
</simpara></listitem></varlistentry>
 
90
<varlistentry><term><parameter>emblem</parameter>&#160;:</term>
 
91
<listitem><simpara> a <link linkend="GEmblem"><type>GEmblem</type></link>
 
92
</simpara></listitem></varlistentry>
 
93
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GIcon"><type>GIcon</type></link>
 
94
 
 
95
</simpara></listitem></varlistentry>
 
96
</variablelist><para role="since">Since 2.18</para></refsect2>
 
97
<refsect2 id="g-emblemed-icon-get-icon" role="function" condition="since:2.18">
 
98
<title>g_emblemed_icon_get_icon ()</title>
 
99
<indexterm zone="g-emblemed-icon-get-icon" role="2.18"><primary sortas="g_emblemed_icon_get_icon">g_emblemed_icon_get_icon</primary></indexterm><programlisting><link linkend="GIcon">GIcon</link> *             g_emblemed_icon_get_icon            (<link linkend="GEmblemedIcon">GEmblemedIcon</link> *emblemed);</programlisting>
 
100
<para>
 
101
Gets the main icon for <parameter>emblemed</parameter>.</para>
 
102
<para>
 
103
</para><variablelist role="params">
 
104
<varlistentry><term><parameter>emblemed</parameter>&#160;:</term>
 
105
<listitem><simpara> a <link linkend="GEmblemedIcon"><type>GEmblemedIcon</type></link>
 
106
</simpara></listitem></varlistentry>
 
107
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GIcon"><type>GIcon</type></link> that is owned by <parameter>emblemed</parameter>
 
108
 
 
109
</simpara></listitem></varlistentry>
 
110
</variablelist><para role="since">Since 2.18</para></refsect2>
 
111
<refsect2 id="g-emblemed-icon-get-emblems" role="function" condition="since:2.18">
 
112
<title>g_emblemed_icon_get_emblems ()</title>
 
113
<indexterm zone="g-emblemed-icon-get-emblems" role="2.18"><primary sortas="g_emblemed_icon_get_emblems">g_emblemed_icon_get_emblems</primary></indexterm><programlisting><link linkend="GList">GList</link> *             g_emblemed_icon_get_emblems         (<link linkend="GEmblemedIcon">GEmblemedIcon</link> *emblemed);</programlisting>
 
114
<para>
 
115
Gets the list of emblems for the <parameter>icon</parameter>.</para>
 
116
<para>
 
117
</para><variablelist role="params">
 
118
<varlistentry><term><parameter>emblemed</parameter>&#160;:</term>
 
119
<listitem><simpara> a <link linkend="GEmblemedIcon"><type>GEmblemedIcon</type></link>
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of <link linkend="GEmblem"><type>GEmblem</type></link> <!-- -->s that is owned by <parameter>emblemed</parameter>
 
122
 
 
123
</simpara></listitem></varlistentry>
 
124
</variablelist><para role="since">Since 2.18</para></refsect2>
 
125
<refsect2 id="g-emblemed-icon-add-emblem" role="function" condition="since:2.18">
 
126
<title>g_emblemed_icon_add_emblem ()</title>
 
127
<indexterm zone="g-emblemed-icon-add-emblem" role="2.18"><primary sortas="g_emblemed_icon_add_emblem">g_emblemed_icon_add_emblem</primary></indexterm><programlisting><link linkend="void">void</link>                g_emblemed_icon_add_emblem          (<link linkend="GEmblemedIcon">GEmblemedIcon</link> *emblemed,
 
128
                                                         <link linkend="GEmblem">GEmblem</link> *emblem);</programlisting>
 
129
<para>
 
130
Adds <parameter>emblem</parameter> to the <link linkend="GList"><type>GList</type></link> of <link linkend="GEmblem"><type>GEmblem</type></link> <!-- -->s.</para>
 
131
<para>
 
132
</para><variablelist role="params">
 
133
<varlistentry><term><parameter>emblemed</parameter>&#160;:</term>
 
134
<listitem><simpara> a <link linkend="GEmblemedIcon"><type>GEmblemedIcon</type></link>
 
135
</simpara></listitem></varlistentry>
 
136
<varlistentry><term><parameter>emblem</parameter>&#160;:</term>
 
137
<listitem><simpara> a <link linkend="GEmblem"><type>GEmblem</type></link>
 
138
</simpara></listitem></varlistentry>
 
139
</variablelist><para role="since">Since 2.18</para></refsect2>
 
140
 
 
141
</refsect1>
 
142
 
 
143
 
 
144
 
 
145
<refsect1 id="GEmblemedIcon.see-also">
 
146
<title>See Also</title>
 
147
#GIcon, <link linkend="GLoadableIcon"><type>GLoadableIcon</type></link>, <link linkend="GThemedIcon"><type>GThemedIcon</type></link>, <link linkend="GEmblem"><type>GEmblem</type></link>
 
148
</refsect1>
 
149
 
 
150
</refentry>