~ubuntu-branches/ubuntu/maverick/libdbusmenu/maverick

« back to all changes in this revision

Viewing changes to docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html

  • Committer: Bazaar Package Importer
  • Author(s): Ken VanDine
  • Date: 2010-07-22 21:17:13 UTC
  • mfrom: (1.1.24 upstream)
  • Revision ID: james.westby@ubuntu.com-20100722211713-i4s3p7cyn0m2o3c4
Tags: 0.3.7-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch01.html" title="API">
9
9
<link rel="prev" href="Genericmenuitem.html" title="Genericmenuitem">
10
10
<link rel="next" href="object-tree.html" title="Object Hierarchy">
11
 
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
40
40
<pre class="synopsis"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-image" title="dbusmenu_menuitem_property_set_image ()">dbusmenu_menuitem_property_set_image</a>
41
41
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
42
42
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
43
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *data</code></em>);
44
 
<a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image" title="dbusmenu_menuitem_property_get_image ()">dbusmenu_menuitem_property_get_image</a>
 
43
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *data</code></em>);
 
44
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image" title="dbusmenu_menuitem_property_get_image ()">dbusmenu_menuitem_property_get_image</a>
45
45
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
46
46
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>);
 
47
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut" title="dbusmenu_menuitem_property_set_shortcut ()">dbusmenu_menuitem_property_set_shortcut</a>
 
48
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
49
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> key</code></em>,
 
50
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifier</code></em>);
 
51
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-string" title="dbusmenu_menuitem_property_set_shortcut_string ()">dbusmenu_menuitem_property_set_shortcut_string</a>
 
52
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
53
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *shortcut</code></em>);
 
54
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-menuitem" title="dbusmenu_menuitem_property_set_shortcut_menuitem ()">dbusmenu_menuitem_property_set_shortcut_menuitem</a>
 
55
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
56
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *gmi</code></em>);
 
57
<span class="returnvalue">void</span>                <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-shortcut" title="dbusmenu_menuitem_property_get_shortcut ()">dbusmenu_menuitem_property_get_shortcut</a>
 
58
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
59
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *key</code></em>,
 
60
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *modifiers</code></em>);
47
61
</pre>
48
62
</div>
49
63
<div class="refsect1" title="Description">
58
72
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            dbusmenu_menuitem_property_set_image
59
73
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
60
74
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
61
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *data</code></em>);</pre>
 
75
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *data</code></em>);</pre>
62
76
<p>
63
77
This function takes the pixbuf that is stored in <em class="parameter"><code>data</code></em> and
64
78
        turns it into a base64 encoded PNG so that it can be placed
94
108
<hr>
95
109
<div class="refsect2" title="dbusmenu_menuitem_property_get_image ()">
96
110
<a name="dbusmenu-menuitem-property-get-image"></a><h3>dbusmenu_menuitem_property_get_image ()</h3>
97
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         dbusmenu_menuitem_property_get_image
 
111
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         dbusmenu_menuitem_property_get_image
98
112
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
99
113
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>);</pre>
100
114
<p>
101
115
This function looks on the menu item for a property by the
102
116
        name of <em class="parameter"><code>property</code></em>.  If one exists it tries to turn it into
103
 
        a <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>.  It assumes that the property is a base64 encoded
 
117
        a <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>.  It assumes that the property is a base64 encoded
104
118
        PNG file like the one created by <span class="type">dbusmenu_menuite_property_set_image</span>.
105
119
</p>
106
120
<div class="variablelist"><table border="0">
124
138
</tbody>
125
139
</table></div>
126
140
</div>
 
141
<hr>
 
142
<div class="refsect2" title="dbusmenu_menuitem_property_set_shortcut ()">
 
143
<a name="dbusmenu-menuitem-property-set-shortcut"></a><h3>dbusmenu_menuitem_property_set_shortcut ()</h3>
 
144
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            dbusmenu_menuitem_property_set_shortcut
 
145
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
146
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> key</code></em>,
 
147
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifier</code></em>);</pre>
 
148
<p>
 
149
Takes the modifer described by <em class="parameter"><code>key</code></em> and <em class="parameter"><code>modifier</code></em> and places that into
 
150
        the format sending across Dbus for shortcuts.
 
151
</p>
 
152
<div class="variablelist"><table border="0">
 
153
<col align="left" valign="top">
 
154
<tbody>
 
155
<tr>
 
156
<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td>
 
157
<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the shortcut on
 
158
</td>
 
159
</tr>
 
160
<tr>
 
161
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
162
<td>The keycode of the key to send
 
163
</td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><span class="term"><em class="parameter"><code>modifier</code></em> :</span></p></td>
 
167
<td>A bitmask of modifiers used to activate the item
 
168
</td>
 
169
</tr>
 
170
<tr>
 
171
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
172
<td> Whether it was successful at setting the property.
 
173
</td>
 
174
</tr>
 
175
</tbody>
 
176
</table></div>
 
177
</div>
 
178
<hr>
 
179
<div class="refsect2" title="dbusmenu_menuitem_property_set_shortcut_string ()">
 
180
<a name="dbusmenu-menuitem-property-set-shortcut-string"></a><h3>dbusmenu_menuitem_property_set_shortcut_string ()</h3>
 
181
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            dbusmenu_menuitem_property_set_shortcut_string
 
182
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
183
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *shortcut</code></em>);</pre>
 
184
<p>
 
185
This function takes a GTK shortcut string as defined in
 
186
        <a href="http://library.gnome.org/devel/gtk/unstable/gtk-Keyboard-Accelerators.html#gtk-accelerator-parse"><span class="type">gtk_accelerator_parse</span></a> and turns that into the information
 
187
        required to send it over DBusmenu.
 
188
</p>
 
189
<div class="variablelist"><table border="0">
 
190
<col align="left" valign="top">
 
191
<tbody>
 
192
<tr>
 
193
<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td>
 
194
<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the shortcut on
 
195
</td>
 
196
</tr>
 
197
<tr>
 
198
<td><p><span class="term"><em class="parameter"><code>shortcut</code></em> :</span></p></td>
 
199
<td>String describing the shortcut
 
200
</td>
 
201
</tr>
 
202
<tr>
 
203
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
204
<td> Whether it was successful at setting the property.
 
205
</td>
 
206
</tr>
 
207
</tbody>
 
208
</table></div>
 
209
</div>
 
210
<hr>
 
211
<div class="refsect2" title="dbusmenu_menuitem_property_set_shortcut_menuitem ()">
 
212
<a name="dbusmenu-menuitem-property-set-shortcut-menuitem"></a><h3>dbusmenu_menuitem_property_set_shortcut_menuitem ()</h3>
 
213
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            dbusmenu_menuitem_property_set_shortcut_menuitem
 
214
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
215
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *gmi</code></em>);</pre>
 
216
<p>
 
217
Takes the shortcut that is installed on a menu item and calls
 
218
        <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut" title="dbusmenu_menuitem_property_set_shortcut ()"><span class="type">dbusmenu_menuitem_property_set_shortcut</span></a> with it.  It also sets
 
219
        up listeners to watch it change.
 
220
</p>
 
221
<div class="variablelist"><table border="0">
 
222
<col align="left" valign="top">
 
223
<tbody>
 
224
<tr>
 
225
<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td>
 
226
<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the shortcut on
 
227
</td>
 
228
</tr>
 
229
<tr>
 
230
<td><p><span class="term"><em class="parameter"><code>gmi</code></em> :</span></p></td>
 
231
<td>A menu item to steal the shortcut off of
 
232
</td>
 
233
</tr>
 
234
<tr>
 
235
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
236
<td> Whether it was successful at setting the property.
 
237
</td>
 
238
</tr>
 
239
</tbody>
 
240
</table></div>
 
241
</div>
 
242
<hr>
 
243
<div class="refsect2" title="dbusmenu_menuitem_property_get_shortcut ()">
 
244
<a name="dbusmenu-menuitem-property-get-shortcut"></a><h3>dbusmenu_menuitem_property_get_shortcut ()</h3>
 
245
<pre class="programlisting"><span class="returnvalue">void</span>                dbusmenu_menuitem_property_get_shortcut
 
246
                                                        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>,
 
247
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *key</code></em>,
 
248
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *modifiers</code></em>);</pre>
 
249
<p>
 
250
This function gets a GTK shortcut as a key and a mask
 
251
        for use to set the accelerators.
 
252
</p>
 
253
<div class="variablelist"><table border="0">
 
254
<col align="left" valign="top">
 
255
<tbody>
 
256
<tr>
 
257
<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td>
 
258
<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to get the shortcut off
 
259
</td>
 
260
</tr>
 
261
<tr>
 
262
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
263
<td>Location to put the key value
 
264
</td>
 
265
</tr>
 
266
<tr>
 
267
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
268
<td>
 
269
</td>
 
270
</tr>
 
271
</tbody>
 
272
</table></div>
 
273
</div>
127
274
</div>
128
275
</div>
129
276
<div class="footer">
130
277
<hr>
131
 
          Generated by GTK-Doc V1.14</div>
 
278
          Generated by GTK-Doc V1.15</div>
132
279
</body>
133
280
</html>
 
 
b'\\ No newline at end of file'