| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>Gtk Extensions: libxfce4ui Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="libxfce4ui Reference Manual"> |
| 8 |
<link rel="up" href="ch01.html" title="[Insert title here]"> |
| 9 |
<link rel="prev" href="libxfce4ui-Gdk-Extensions.html" title="Gdk Extensions"> |
| 10 |
<link rel="next" href="libxfce4ui-XfceDialogs.html" title="XfceDialogs"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#libxfce4ui-Gtk-Extensions.description" class="shortcut">Description</a></span> |
| 19 |
</td> |
| 20 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 21 |
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 22 |
<td><a accesskey="p" href="libxfce4ui-Gdk-Extensions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 23 |
<td><a accesskey="n" href="libxfce4ui-XfceDialogs.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 24 |
</tr></table> |
| 25 |
<div class="refentry"> |
| 26 |
<a name="libxfce4ui-Gtk-Extensions"></a><div class="titlepage"></div> |
| 27 |
<div class="refnamediv"><table width="100%"><tr> |
| 28 |
<td valign="top"> |
| 29 |
<h2><span class="refentrytitle"><a name="libxfce4ui-Gtk-Extensions.top_of_page"></a>Gtk Extensions</span></h2> |
| 30 |
<p>Gtk Extensions — various extensions to Gtk+</p> |
| 31 |
</td> |
| 32 |
<td class="gallery_image" valign="top" align="right"></td> |
| 33 |
</tr></table></div> |
| 34 |
<div class="refsect1"> |
| 35 |
<a name="libxfce4ui-Gtk-Extensions.stability-level"></a><h2>Stability Level</h2> |
| 36 |
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to |
| 37 |
develop applications to these interfaces, release them, and have confidence that |
| 38 |
they will run on all minor releases of the product (after the one in which the |
| 39 |
interface was introduced, and within the same major release). Even at a major |
| 40 |
release, incompatible changes are expected to be rare, and to have strong |
| 41 |
justifications. |
| 42 |
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated |
| 43 |
</div> |
| 44 |
<div class="refsect1"> |
| 45 |
<a name="libxfce4ui-Gtk-Extensions.functions"></a><h2>Functions</h2> |
| 46 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 47 |
<colgroup> |
| 48 |
<col width="150px" class="functions_proto_type"> |
| 49 |
<col class="functions_proto_name"> |
| 50 |
</colgroup> |
| 51 |
<tbody> |
| 52 |
<tr> |
| 53 |
<td class="function_type"> |
| 54 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 55 |
</td> |
| 56 |
<td class="function_name"> |
| 57 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-menu-item-new" title="xfce_gtk_menu_item_new ()">xfce_gtk_menu_item_new</a> <span class="c_punctuation">()</span> |
| 58 |
</td> |
| 59 |
</tr> |
| 60 |
<tr> |
| 61 |
<td class="function_type"> |
| 62 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 63 |
</td> |
| 64 |
<td class="function_name"> |
| 65 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-image-menu-item-new" title="xfce_gtk_image_menu_item_new ()">xfce_gtk_image_menu_item_new</a> <span class="c_punctuation">()</span> |
| 66 |
</td> |
| 67 |
</tr> |
| 68 |
<tr> |
| 69 |
<td class="function_type"> |
| 70 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 71 |
</td> |
| 72 |
<td class="function_name"> |
| 73 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-image-menu-item-new-from-icon-name" title="xfce_gtk_image_menu_item_new_from_icon_name ()">xfce_gtk_image_menu_item_new_from_icon_name</a> <span class="c_punctuation">()</span> |
| 74 |
</td> |
| 75 |
</tr> |
| 76 |
<tr> |
| 77 |
<td class="function_type"> |
| 78 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 79 |
</td> |
| 80 |
<td class="function_name"> |
| 81 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-check-menu-item-new" title="xfce_gtk_check_menu_item_new ()">xfce_gtk_check_menu_item_new</a> <span class="c_punctuation">()</span> |
| 82 |
</td> |
| 83 |
</tr> |
| 84 |
<tr> |
| 85 |
<td class="function_type"> |
| 86 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 87 |
</td> |
| 88 |
<td class="function_name"> |
| 89 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-radio-menu-item-new" title="xfce_gtk_radio_menu_item_new ()">xfce_gtk_radio_menu_item_new</a> <span class="c_punctuation">()</span> |
| 90 |
</td> |
| 91 |
</tr> |
| 92 |
<tr> |
| 93 |
<td class="function_type"> |
| 94 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 95 |
</td> |
| 96 |
<td class="function_name"> |
| 97 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-menu-item-new-from-action-entry" title="xfce_gtk_menu_item_new_from_action_entry ()">xfce_gtk_menu_item_new_from_action_entry</a> <span class="c_punctuation">()</span> |
| 98 |
</td> |
| 99 |
</tr> |
| 100 |
<tr> |
| 101 |
<td class="function_type"> |
| 102 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 103 |
</td> |
| 104 |
<td class="function_name"> |
| 105 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-toggle-menu-item-new-from-action-entry" title="xfce_gtk_toggle_menu_item_new_from_action_entry ()">xfce_gtk_toggle_menu_item_new_from_action_entry</a> <span class="c_punctuation">()</span> |
| 106 |
</td> |
| 107 |
</tr> |
| 108 |
<tr> |
| 109 |
<td class="function_type"> |
| 110 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 111 |
</td> |
| 112 |
<td class="function_name"> |
| 113 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-tool-button-new-from-action-entry" title="xfce_gtk_tool_button_new_from_action_entry ()">xfce_gtk_tool_button_new_from_action_entry</a> <span class="c_punctuation">()</span> |
| 114 |
</td> |
| 115 |
</tr> |
| 116 |
<tr> |
| 117 |
<td class="function_type"> |
| 118 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 119 |
</td> |
| 120 |
<td class="function_name"> |
| 121 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-toggle-tool-button-new-from-action-entry" title="xfce_gtk_toggle_tool_button_new_from_action_entry ()">xfce_gtk_toggle_tool_button_new_from_action_entry</a> <span class="c_punctuation">()</span> |
| 122 |
</td> |
| 123 |
</tr> |
| 124 |
<tr> |
| 125 |
<td class="function_type"> |
| 126 |
<span class="returnvalue">void</span> |
| 127 |
</td> |
| 128 |
<td class="function_name"> |
| 129 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-accel-map-add-entries" title="xfce_gtk_accel_map_add_entries ()">xfce_gtk_accel_map_add_entries</a> <span class="c_punctuation">()</span> |
| 130 |
</td> |
| 131 |
</tr> |
| 132 |
<tr> |
| 133 |
<td class="function_type"> |
| 134 |
<span class="returnvalue">void</span> |
| 135 |
</td> |
| 136 |
<td class="function_name"> |
| 137 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-accel-group-connect-action-entries" title="xfce_gtk_accel_group_connect_action_entries ()">xfce_gtk_accel_group_connect_action_entries</a> <span class="c_punctuation">()</span> |
| 138 |
</td> |
| 139 |
</tr> |
| 140 |
<tr> |
| 141 |
<td class="function_type"> |
| 142 |
<span class="returnvalue">void</span> |
| 143 |
</td> |
| 144 |
<td class="function_name"> |
| 145 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-accel-group-disconnect-action-entries" title="xfce_gtk_accel_group_disconnect_action_entries ()">xfce_gtk_accel_group_disconnect_action_entries</a> <span class="c_punctuation">()</span> |
| 146 |
</td> |
| 147 |
</tr> |
| 148 |
<tr> |
| 149 |
<td class="function_type">const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="returnvalue">XfceGtkActionEntry</span></a> * |
| 150 |
</td> |
| 151 |
<td class="function_name"> |
| 152 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-get-action-entry-by-id" title="xfce_gtk_get_action_entry_by_id ()">xfce_gtk_get_action_entry_by_id</a> <span class="c_punctuation">()</span> |
| 153 |
</td> |
| 154 |
</tr> |
| 155 |
<tr> |
| 156 |
<td class="function_type"> |
| 157 |
<span class="returnvalue">void</span> |
| 158 |
</td> |
| 159 |
<td class="function_name"> |
| 160 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-translate-action-entries" title="xfce_gtk_translate_action_entries ()">xfce_gtk_translate_action_entries</a> <span class="c_punctuation">()</span> |
| 161 |
</td> |
| 162 |
</tr> |
| 163 |
<tr> |
| 164 |
<td class="function_type"> |
| 165 |
<span class="returnvalue">gboolean</span> |
| 166 |
</td> |
| 167 |
<td class="function_name"> |
| 168 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-handle-tab-accels" title="xfce_gtk_handle_tab_accels ()">xfce_gtk_handle_tab_accels</a> <span class="c_punctuation">()</span> |
| 169 |
</td> |
| 170 |
</tr> |
| 171 |
<tr> |
| 172 |
<td class="function_type"> |
| 173 |
<span class="returnvalue">gboolean</span> |
| 174 |
</td> |
| 175 |
<td class="function_name"> |
| 176 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-execute-tab-accel" title="xfce_gtk_execute_tab_accel ()">xfce_gtk_execute_tab_accel</a> <span class="c_punctuation">()</span> |
| 177 |
</td> |
| 178 |
</tr> |
| 179 |
<tr> |
| 180 |
<td class="function_type"> |
| 181 |
<span class="returnvalue">void</span> |
| 182 |
</td> |
| 183 |
<td class="function_name"> |
| 184 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-menu-append-separator" title="xfce_gtk_menu_append_separator ()">xfce_gtk_menu_append_separator</a> <span class="c_punctuation">()</span> |
| 185 |
</td> |
| 186 |
</tr> |
| 187 |
<tr> |
| 188 |
<td class="function_type"> |
| 189 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 190 |
</td> |
| 191 |
<td class="function_name"> |
| 192 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-button-new-mixed" title="xfce_gtk_button_new_mixed ()">xfce_gtk_button_new_mixed</a> <span class="c_punctuation">()</span> |
| 193 |
</td> |
| 194 |
</tr> |
| 195 |
<tr> |
| 196 |
<td class="function_type"> |
| 197 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 198 |
</td> |
| 199 |
<td class="function_name"> |
| 200 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-frame-box-new" title="xfce_gtk_frame_box_new ()">xfce_gtk_frame_box_new</a> <span class="c_punctuation">()</span> |
| 201 |
</td> |
| 202 |
</tr> |
| 203 |
<tr> |
| 204 |
<td class="function_type"> |
| 205 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 206 |
</td> |
| 207 |
<td class="function_name"> |
| 208 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-frame-box-new-with-content" title="xfce_gtk_frame_box_new_with_content ()">xfce_gtk_frame_box_new_with_content</a> <span class="c_punctuation">()</span> |
| 209 |
</td> |
| 210 |
</tr> |
| 211 |
<tr> |
| 212 |
<td class="function_type"> |
| 213 |
<span class="returnvalue">void</span> |
| 214 |
</td> |
| 215 |
<td class="function_name"> |
| 216 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-window-center-on-active-screen" title="xfce_gtk_window_center_on_active_screen ()">xfce_gtk_window_center_on_active_screen</a> <span class="c_punctuation">()</span> |
| 217 |
</td> |
| 218 |
</tr> |
| 219 |
<tr> |
| 220 |
<td class="function_type"> |
| 221 |
<span class="returnvalue">gboolean</span> |
| 222 |
</td> |
| 223 |
<td class="function_name"> |
| 224 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-menu-popup-until-mapped" title="xfce_gtk_menu_popup_until_mapped ()">xfce_gtk_menu_popup_until_mapped</a> <span class="c_punctuation">()</span> |
| 225 |
</td> |
| 226 |
</tr> |
| 227 |
<tr> |
| 228 |
<td class="function_type"> |
| 229 |
<span class="returnvalue">gboolean</span> |
| 230 |
</td> |
| 231 |
<td class="function_name"> |
| 232 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-widget-reparent" title="xfce_widget_reparent ()">xfce_widget_reparent</a> <span class="c_punctuation">()</span> |
| 233 |
</td> |
| 234 |
</tr> |
| 235 |
<tr> |
| 236 |
<td class="function_type"> |
| 237 |
<span class="returnvalue">gchar</span> * |
| 238 |
</td> |
| 239 |
<td class="function_name"> |
| 240 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-icon-name-from-desktop-id" title="xfce_icon_name_from_desktop_id ()">xfce_icon_name_from_desktop_id</a> <span class="c_punctuation">()</span> |
| 241 |
</td> |
| 242 |
</tr> |
| 243 |
<tr> |
| 244 |
<td class="function_type"> |
| 245 |
<span class="returnvalue">GIcon</span> * |
| 246 |
</td> |
| 247 |
<td class="function_name"> |
| 248 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gicon-from-name" title="xfce_gicon_from_name ()">xfce_gicon_from_name</a> <span class="c_punctuation">()</span> |
| 249 |
</td> |
| 250 |
</tr> |
| 251 |
<tr> |
| 252 |
<td class="function_type"> |
| 253 |
<span class="returnvalue">void</span> |
| 254 |
</td> |
| 255 |
<td class="function_name"> |
| 256 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-menu-item-set-accel-label" title="xfce_gtk_menu_item_set_accel_label ()">xfce_gtk_menu_item_set_accel_label</a> <span class="c_punctuation">()</span> |
| 257 |
</td> |
| 258 |
</tr> |
| 259 |
<tr> |
| 260 |
<td class="function_type"> |
| 261 |
<span class="returnvalue">gboolean</span> |
| 262 |
</td> |
| 263 |
<td class="function_name"> |
| 264 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-has-gtk-frame-extents" title="xfce_has_gtk_frame_extents ()">xfce_has_gtk_frame_extents</a> <span class="c_punctuation">()</span> |
| 265 |
</td> |
| 266 |
</tr> |
| 267 |
<tr> |
| 268 |
<td class="function_type"> |
| 269 |
<span class="returnvalue">void</span> |
| 270 |
</td> |
| 271 |
<td class="function_name"> |
| 272 |
<a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-label-set-a11y-relation" title="xfce_gtk_label_set_a11y_relation ()">xfce_gtk_label_set_a11y_relation</a> <span class="c_punctuation">()</span> |
| 273 |
</td> |
| 274 |
</tr> |
| 275 |
</tbody> |
| 276 |
</table></div> |
| 277 |
</div> |
| 278 |
<div class="refsect1"> |
| 279 |
<a name="libxfce4ui-Gtk-Extensions.other"></a><h2>Types and Values</h2> |
| 280 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 281 |
<colgroup> |
| 282 |
<col width="150px" class="other_proto_type"> |
| 283 |
<col class="other_proto_name"> |
| 284 |
</colgroup> |
| 285 |
<tbody> |
| 286 |
<tr> |
| 287 |
<td class="datatype_keyword">enum</td> |
| 288 |
<td class="function_name"><a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkMenuItem" title="enum XfceGtkMenuItem">XfceGtkMenuItem</a></td> |
| 289 |
</tr> |
| 290 |
<tr> |
| 291 |
<td class="datatype_keyword"> </td> |
| 292 |
<td class="function_name"><a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry">XfceGtkActionEntry</a></td> |
| 293 |
</tr> |
| 294 |
</tbody> |
| 295 |
</table></div> |
| 296 |
</div> |
| 297 |
<div class="refsect1"> |
| 298 |
<a name="libxfce4ui-Gtk-Extensions.includes"></a><h2>Includes</h2> |
| 299 |
<pre class="synopsis">#include <libxfce4ui/libxfce4ui.h> |
| 300 |
</pre> |
| 301 |
</div> |
| 302 |
<div class="refsect1"> |
| 303 |
<a name="libxfce4ui-Gtk-Extensions.description"></a><h2>Description</h2> |
| 304 |
<p>Common used functions for GtkWidget's that are not provided by the Gtk+ library</p> |
| 305 |
</div> |
| 306 |
<div class="refsect1"> |
| 307 |
<a name="libxfce4ui-Gtk-Extensions.functions_details"></a><h2>Functions</h2> |
| 308 |
<div class="refsect2"> |
| 309 |
<a name="xfce-gtk-menu-item-new"></a><h3>xfce_gtk_menu_item_new ()</h3> |
| 310 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 311 |
xfce_gtk_menu_item_new (<em class="parameter"><code>const <span class="type">gchar</span> *label_text</code></em>, |
| 312 |
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip_text</code></em>, |
| 313 |
<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>, |
| 314 |
<em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, |
| 315 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 316 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 317 |
<p>Convenience method to create a <a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a> and preconfigure it with the passed parameters.</p> |
| 318 |
<div class="refsect3"> |
| 319 |
<a name="xfce-gtk-menu-item-new.parameters"></a><h4>Parameters</h4> |
| 320 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 321 |
<colgroup> |
| 322 |
<col width="150px" class="parameters_name"> |
| 323 |
<col class="parameters_description"> |
| 324 |
<col width="200px" class="parameters_annotations"> |
| 325 |
</colgroup> |
| 326 |
<tbody> |
| 327 |
<tr> |
| 328 |
<td class="parameter_name"><p>label_text</p></td> |
| 329 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a></p></td> |
| 330 |
<td class="parameter_annotations"> </td> |
| 331 |
</tr> |
| 332 |
<tr> |
| 333 |
<td class="parameter_name"><p>tooltip_text</p></td> |
| 334 |
<td class="parameter_description"><p>Tooltip to add on the passed item, or NULL. </p></td> |
| 335 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 336 |
</tr> |
| 337 |
<tr> |
| 338 |
<td class="parameter_name"><p>accel_path</p></td> |
| 339 |
<td class="parameter_description"><p>Unique path, used to identify the accelerator, or NULL. </p></td> |
| 340 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 341 |
</tr> |
| 342 |
<tr> |
| 343 |
<td class="parameter_name"><p>callback</p></td> |
| 344 |
<td class="parameter_description"><p><span class="type">GCallback</span> which will be triggered on activation, or NULL. </p></td> |
| 345 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 346 |
</tr> |
| 347 |
<tr> |
| 348 |
<td class="parameter_name"><p>callback_param</p></td> |
| 349 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 350 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 351 |
</tr> |
| 352 |
<tr> |
| 353 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 354 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 355 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 356 |
</tr> |
| 357 |
</tbody> |
| 358 |
</table></div> |
| 359 |
</div> |
| 360 |
<div class="refsect3"> |
| 361 |
<a name="xfce-gtk-menu-item-new.returns"></a><h4>Returns</h4> |
| 362 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a>. </p> |
| 363 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 364 |
</div> |
| 365 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 366 |
</div> |
| 367 |
<hr> |
| 368 |
<div class="refsect2"> |
| 369 |
<a name="xfce-gtk-image-menu-item-new"></a><h3>xfce_gtk_image_menu_item_new ()</h3> |
| 370 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 371 |
xfce_gtk_image_menu_item_new (<em class="parameter"><code>const <span class="type">gchar</span> *label_text</code></em>, |
| 372 |
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip_text</code></em>, |
| 373 |
<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>, |
| 374 |
<em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, |
| 375 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 376 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *image</code></em>, |
| 377 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 378 |
<p>Convenience method to create a deprecated <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a> and preconfigure it with the passed parameters. |
| 379 |
In order to prevent G_GNUC_BEGIN_IGNORE_DEPRECATIONS in all xfce projects, this method can be used</p> |
| 380 |
<div class="refsect3"> |
| 381 |
<a name="xfce-gtk-image-menu-item-new.parameters"></a><h4>Parameters</h4> |
| 382 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 383 |
<colgroup> |
| 384 |
<col width="150px" class="parameters_name"> |
| 385 |
<col class="parameters_description"> |
| 386 |
<col width="200px" class="parameters_annotations"> |
| 387 |
</colgroup> |
| 388 |
<tbody> |
| 389 |
<tr> |
| 390 |
<td class="parameter_name"><p>label_text</p></td> |
| 391 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a></p></td> |
| 392 |
<td class="parameter_annotations"> </td> |
| 393 |
</tr> |
| 394 |
<tr> |
| 395 |
<td class="parameter_name"><p>tooltip_text</p></td> |
| 396 |
<td class="parameter_description"><p>Tooltip to add on the passed item, or NULL. </p></td> |
| 397 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 398 |
</tr> |
| 399 |
<tr> |
| 400 |
<td class="parameter_name"><p>accel_path</p></td> |
| 401 |
<td class="parameter_description"><p>Unique path, used to identify the accelerator, or NULL. </p></td> |
| 402 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 403 |
</tr> |
| 404 |
<tr> |
| 405 |
<td class="parameter_name"><p>callback</p></td> |
| 406 |
<td class="parameter_description"><p><span class="type">GCallback</span> which will be triggered on activation, or NULL. </p></td> |
| 407 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 408 |
</tr> |
| 409 |
<tr> |
| 410 |
<td class="parameter_name"><p>callback_param</p></td> |
| 411 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 412 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 413 |
</tr> |
| 414 |
<tr> |
| 415 |
<td class="parameter_name"><p>image</p></td> |
| 416 |
<td class="parameter_description"><p>a widget to set as the image for the menu item, or NULL. </p></td> |
| 417 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 418 |
</tr> |
| 419 |
<tr> |
| 420 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 421 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 422 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 423 |
</tr> |
| 424 |
</tbody> |
| 425 |
</table></div> |
| 426 |
</div> |
| 427 |
<div class="refsect3"> |
| 428 |
<a name="xfce-gtk-image-menu-item-new.returns"></a><h4>Returns</h4> |
| 429 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a>. </p> |
| 430 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 431 |
</div> |
| 432 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 433 |
</div> |
| 434 |
<hr> |
| 435 |
<div class="refsect2"> |
| 436 |
<a name="xfce-gtk-image-menu-item-new-from-icon-name"></a><h3>xfce_gtk_image_menu_item_new_from_icon_name ()</h3> |
| 437 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 438 |
xfce_gtk_image_menu_item_new_from_icon_name |
| 439 |
(<em class="parameter"><code>const <span class="type">gchar</span> *label_text</code></em>, |
| 440 |
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip_text</code></em>, |
| 441 |
<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>, |
| 442 |
<em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, |
| 443 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 444 |
<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>, |
| 445 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 446 |
<p>Convenience method to create a <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a> and preconfigure it with the passed parameters.</p> |
| 447 |
<div class="refsect3"> |
| 448 |
<a name="xfce-gtk-image-menu-item-new-from-icon-name.parameters"></a><h4>Parameters</h4> |
| 449 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 450 |
<colgroup> |
| 451 |
<col width="150px" class="parameters_name"> |
| 452 |
<col class="parameters_description"> |
| 453 |
<col width="200px" class="parameters_annotations"> |
| 454 |
</colgroup> |
| 455 |
<tbody> |
| 456 |
<tr> |
| 457 |
<td class="parameter_name"><p>label_text</p></td> |
| 458 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a></p></td> |
| 459 |
<td class="parameter_annotations"> </td> |
| 460 |
</tr> |
| 461 |
<tr> |
| 462 |
<td class="parameter_name"><p>tooltip_text</p></td> |
| 463 |
<td class="parameter_description"><p>Tooltip to add on the passed item, or NULL. </p></td> |
| 464 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 465 |
</tr> |
| 466 |
<tr> |
| 467 |
<td class="parameter_name"><p>accel_path</p></td> |
| 468 |
<td class="parameter_description"><p>Unique path, used to identify the accelerator, or NULL. </p></td> |
| 469 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 470 |
</tr> |
| 471 |
<tr> |
| 472 |
<td class="parameter_name"><p>callback</p></td> |
| 473 |
<td class="parameter_description"><p><span class="type">GCallback</span> which will be triggered on activation, or NULL. </p></td> |
| 474 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 475 |
</tr> |
| 476 |
<tr> |
| 477 |
<td class="parameter_name"><p>callback_param</p></td> |
| 478 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 479 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 480 |
</tr> |
| 481 |
<tr> |
| 482 |
<td class="parameter_name"><p>icon_name</p></td> |
| 483 |
<td class="parameter_description"><p>name of the icon to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a>, or NULL. </p></td> |
| 484 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 485 |
</tr> |
| 486 |
<tr> |
| 487 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 488 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 489 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 490 |
</tr> |
| 491 |
</tbody> |
| 492 |
</table></div> |
| 493 |
</div> |
| 494 |
<div class="refsect3"> |
| 495 |
<a name="xfce-gtk-image-menu-item-new-from-icon-name.returns"></a><h4>Returns</h4> |
| 496 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a>. </p> |
| 497 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 498 |
</div> |
| 499 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 500 |
</div> |
| 501 |
<hr> |
| 502 |
<div class="refsect2"> |
| 503 |
<a name="xfce-gtk-check-menu-item-new"></a><h3>xfce_gtk_check_menu_item_new ()</h3> |
| 504 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 505 |
xfce_gtk_check_menu_item_new (<em class="parameter"><code>const <span class="type">gchar</span> *label_text</code></em>, |
| 506 |
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip_text</code></em>, |
| 507 |
<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>, |
| 508 |
<em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, |
| 509 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 510 |
<em class="parameter"><code><span class="type">gboolean</span> active</code></em>, |
| 511 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 512 |
<p>Convenience method to create a <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a> and preconfigure it with the passed parameters.</p> |
| 513 |
<div class="refsect3"> |
| 514 |
<a name="xfce-gtk-check-menu-item-new.parameters"></a><h4>Parameters</h4> |
| 515 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 516 |
<colgroup> |
| 517 |
<col width="150px" class="parameters_name"> |
| 518 |
<col class="parameters_description"> |
| 519 |
<col width="200px" class="parameters_annotations"> |
| 520 |
</colgroup> |
| 521 |
<tbody> |
| 522 |
<tr> |
| 523 |
<td class="parameter_name"><p>label_text</p></td> |
| 524 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a></p></td> |
| 525 |
<td class="parameter_annotations"> </td> |
| 526 |
</tr> |
| 527 |
<tr> |
| 528 |
<td class="parameter_name"><p>tooltip_text</p></td> |
| 529 |
<td class="parameter_description"><p>Tooltip to add on the passed item, or NULL. </p></td> |
| 530 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 531 |
</tr> |
| 532 |
<tr> |
| 533 |
<td class="parameter_name"><p>accel_path</p></td> |
| 534 |
<td class="parameter_description"><p>Unique path, used to identify the accelerator, or NULL. </p></td> |
| 535 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 536 |
</tr> |
| 537 |
<tr> |
| 538 |
<td class="parameter_name"><p>callback</p></td> |
| 539 |
<td class="parameter_description"><p><span class="type">GCallback</span> which will be triggered on activation, or NULL. </p></td> |
| 540 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 541 |
</tr> |
| 542 |
<tr> |
| 543 |
<td class="parameter_name"><p>callback_param</p></td> |
| 544 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 545 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 546 |
</tr> |
| 547 |
<tr> |
| 548 |
<td class="parameter_name"><p>active</p></td> |
| 549 |
<td class="parameter_description"><p>boolean value indicating whether the check box is active.</p></td> |
| 550 |
<td class="parameter_annotations"> </td> |
| 551 |
</tr> |
| 552 |
<tr> |
| 553 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 554 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 555 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 556 |
</tr> |
| 557 |
</tbody> |
| 558 |
</table></div> |
| 559 |
</div> |
| 560 |
<div class="refsect3"> |
| 561 |
<a name="xfce-gtk-check-menu-item-new.returns"></a><h4>Returns</h4> |
| 562 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a>. </p> |
| 563 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 564 |
</div> |
| 565 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 566 |
</div> |
| 567 |
<hr> |
| 568 |
<div class="refsect2"> |
| 569 |
<a name="xfce-gtk-radio-menu-item-new"></a><h3>xfce_gtk_radio_menu_item_new ()</h3> |
| 570 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 571 |
xfce_gtk_radio_menu_item_new (<em class="parameter"><code>const <span class="type">gchar</span> *label_text</code></em>, |
| 572 |
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip_text</code></em>, |
| 573 |
<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>, |
| 574 |
<em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, |
| 575 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 576 |
<em class="parameter"><code><span class="type">gboolean</span> active</code></em>, |
| 577 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 578 |
<p>Convenience method to create a <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a> and preconfigure it with the passed parameters. |
| 579 |
In order to simplify usage, a <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a> is created and drawn as radio-item</p> |
| 580 |
<div class="refsect3"> |
| 581 |
<a name="xfce-gtk-radio-menu-item-new.parameters"></a><h4>Parameters</h4> |
| 582 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 583 |
<colgroup> |
| 584 |
<col width="150px" class="parameters_name"> |
| 585 |
<col class="parameters_description"> |
| 586 |
<col width="200px" class="parameters_annotations"> |
| 587 |
</colgroup> |
| 588 |
<tbody> |
| 589 |
<tr> |
| 590 |
<td class="parameter_name"><p>label_text</p></td> |
| 591 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a></p></td> |
| 592 |
<td class="parameter_annotations"> </td> |
| 593 |
</tr> |
| 594 |
<tr> |
| 595 |
<td class="parameter_name"><p>tooltip_text</p></td> |
| 596 |
<td class="parameter_description"><p>Tooltip to add on the passed item, or NULL. </p></td> |
| 597 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 598 |
</tr> |
| 599 |
<tr> |
| 600 |
<td class="parameter_name"><p>accel_path</p></td> |
| 601 |
<td class="parameter_description"><p>Unique path, used to identify the accelerator, or NULL. </p></td> |
| 602 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 603 |
</tr> |
| 604 |
<tr> |
| 605 |
<td class="parameter_name"><p>callback</p></td> |
| 606 |
<td class="parameter_description"><p><span class="type">GCallback</span> which will be triggered on activation, or NULL. </p></td> |
| 607 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 608 |
</tr> |
| 609 |
<tr> |
| 610 |
<td class="parameter_name"><p>callback_param</p></td> |
| 611 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 612 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 613 |
</tr> |
| 614 |
<tr> |
| 615 |
<td class="parameter_name"><p>active</p></td> |
| 616 |
<td class="parameter_description"><p>boolean value indicating whether the check box is active.</p></td> |
| 617 |
<td class="parameter_annotations"> </td> |
| 618 |
</tr> |
| 619 |
<tr> |
| 620 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 621 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 622 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 623 |
</tr> |
| 624 |
</tbody> |
| 625 |
</table></div> |
| 626 |
</div> |
| 627 |
<div class="refsect3"> |
| 628 |
<a name="xfce-gtk-radio-menu-item-new.returns"></a><h4>Returns</h4> |
| 629 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a>. </p> |
| 630 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 631 |
</div> |
| 632 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 633 |
</div> |
| 634 |
<hr> |
| 635 |
<div class="refsect2"> |
| 636 |
<a name="xfce-gtk-menu-item-new-from-action-entry"></a><h3>xfce_gtk_menu_item_new_from_action_entry ()</h3> |
| 637 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 638 |
xfce_gtk_menu_item_new_from_action_entry |
| 639 |
(<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entry</code></em>, |
| 640 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 641 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 642 |
<p>Method to create a menu item from the passed action entry</p> |
| 643 |
<div class="refsect3"> |
| 644 |
<a name="xfce-gtk-menu-item-new-from-action-entry.parameters"></a><h4>Parameters</h4> |
| 645 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 646 |
<colgroup> |
| 647 |
<col width="150px" class="parameters_name"> |
| 648 |
<col class="parameters_description"> |
| 649 |
<col width="200px" class="parameters_annotations"> |
| 650 |
</colgroup> |
| 651 |
<tbody> |
| 652 |
<tr> |
| 653 |
<td class="parameter_name"><p>action_entry</p></td> |
| 654 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a></p></td> |
| 655 |
<td class="parameter_annotations"> </td> |
| 656 |
</tr> |
| 657 |
<tr> |
| 658 |
<td class="parameter_name"><p>callback_param</p></td> |
| 659 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 660 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 661 |
</tr> |
| 662 |
<tr> |
| 663 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 664 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 665 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 666 |
</tr> |
| 667 |
</tbody> |
| 668 |
</table></div> |
| 669 |
</div> |
| 670 |
<div class="refsect3"> |
| 671 |
<a name="xfce-gtk-menu-item-new-from-action-entry.returns"></a><h4>Returns</h4> |
| 672 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a> or NULL. </p> |
| 673 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 674 |
</div> |
| 675 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 676 |
</div> |
| 677 |
<hr> |
| 678 |
<div class="refsect2"> |
| 679 |
<a name="xfce-gtk-toggle-menu-item-new-from-action-entry"></a><h3>xfce_gtk_toggle_menu_item_new_from_action_entry ()</h3> |
| 680 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 681 |
xfce_gtk_toggle_menu_item_new_from_action_entry |
| 682 |
(<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entry</code></em>, |
| 683 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 684 |
<em class="parameter"><code><span class="type">gboolean</span> active</code></em>, |
| 685 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu_to_append_item</code></em>);</pre> |
| 686 |
<p>Method to create a toggle menu item from the passed action entry</p> |
| 687 |
<div class="refsect3"> |
| 688 |
<a name="xfce-gtk-toggle-menu-item-new-from-action-entry.parameters"></a><h4>Parameters</h4> |
| 689 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 690 |
<colgroup> |
| 691 |
<col width="150px" class="parameters_name"> |
| 692 |
<col class="parameters_description"> |
| 693 |
<col width="200px" class="parameters_annotations"> |
| 694 |
</colgroup> |
| 695 |
<tbody> |
| 696 |
<tr> |
| 697 |
<td class="parameter_name"><p>action_entry</p></td> |
| 698 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a></p></td> |
| 699 |
<td class="parameter_annotations"> </td> |
| 700 |
</tr> |
| 701 |
<tr> |
| 702 |
<td class="parameter_name"><p>callback_param</p></td> |
| 703 |
<td class="parameter_description"><p>optional callback parameter, or NULL. </p></td> |
| 704 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 705 |
</tr> |
| 706 |
<tr> |
| 707 |
<td class="parameter_name"><p>active</p></td> |
| 708 |
<td class="parameter_description"><p>boolean value indicating whether the check box is active.</p></td> |
| 709 |
<td class="parameter_annotations"> </td> |
| 710 |
</tr> |
| 711 |
<tr> |
| 712 |
<td class="parameter_name"><p>menu_to_append_item</p></td> |
| 713 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the item should be appended, or NULL. </p></td> |
| 714 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 715 |
</tr> |
| 716 |
</tbody> |
| 717 |
</table></div> |
| 718 |
</div> |
| 719 |
<div class="refsect3"> |
| 720 |
<a name="xfce-gtk-toggle-menu-item-new-from-action-entry.returns"></a><h4>Returns</h4> |
| 721 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a> or NULL. </p> |
| 722 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 723 |
</div> |
| 724 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 725 |
</div> |
| 726 |
<hr> |
| 727 |
<div class="refsect2"> |
| 728 |
<a name="xfce-gtk-tool-button-new-from-action-entry"></a><h3>xfce_gtk_tool_button_new_from_action_entry ()</h3> |
| 729 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 730 |
xfce_gtk_tool_button_new_from_action_entry |
| 731 |
(<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entry</code></em>, |
| 732 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 733 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkToolbar.html#GtkToolbar-struct"><span class="type">GtkToolbar</span></a> *toolbar_to_append_item</code></em>);</pre> |
| 734 |
<p>Method to create a toolbar button from the passed action entry.</p> |
| 735 |
<div class="refsect3"> |
| 736 |
<a name="xfce-gtk-tool-button-new-from-action-entry.parameters"></a><h4>Parameters</h4> |
| 737 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 738 |
<colgroup> |
| 739 |
<col width="150px" class="parameters_name"> |
| 740 |
<col class="parameters_description"> |
| 741 |
<col width="200px" class="parameters_annotations"> |
| 742 |
</colgroup> |
| 743 |
<tbody> |
| 744 |
<tr> |
| 745 |
<td class="parameter_name"><p>action_entry</p></td> |
| 746 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkToolButton.html#GtkToolButton-struct"><span class="type">GtkToolButton</span></a></p></td> |
| 747 |
<td class="parameter_annotations"> </td> |
| 748 |
</tr> |
| 749 |
<tr> |
| 750 |
<td class="parameter_name"><p>callback_param</p></td> |
| 751 |
<td class="parameter_description"><p>optional callback parameter, or <code class="literal">NULL</code>. </p></td> |
| 752 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 753 |
</tr> |
| 754 |
<tr> |
| 755 |
<td class="parameter_name"><p>toolbar_to_append_item</p></td> |
| 756 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkToolbar.html#GtkToolbar-struct"><span class="type">GtkToolbar</span></a> on which the item should be appended</p></td> |
| 757 |
<td class="parameter_annotations"> </td> |
| 758 |
</tr> |
| 759 |
</tbody> |
| 760 |
</table></div> |
| 761 |
</div> |
| 762 |
<div class="refsect3"> |
| 763 |
<a name="xfce-gtk-tool-button-new-from-action-entry.returns"></a><h4>Returns</h4> |
| 764 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkToolButton.html#GtkToolButton-struct"><span class="type">GtkToolButton</span></a>. </p> |
| 765 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 766 |
</div> |
| 767 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 768 |
</div> |
| 769 |
<hr> |
| 770 |
<div class="refsect2"> |
| 771 |
<a name="xfce-gtk-toggle-tool-button-new-from-action-entry"></a><h3>xfce_gtk_toggle_tool_button_new_from_action_entry ()</h3> |
| 772 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 773 |
xfce_gtk_toggle_tool_button_new_from_action_entry |
| 774 |
(<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entry</code></em>, |
| 775 |
<em class="parameter"><code><span class="type">GObject</span> *callback_param</code></em>, |
| 776 |
<em class="parameter"><code><span class="type">gboolean</span> active</code></em>, |
| 777 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkToolbar.html#GtkToolbar-struct"><span class="type">GtkToolbar</span></a> *toolbar_to_append_item</code></em>);</pre> |
| 778 |
<p>Method to create a toolbar toggle-button from the passed action entry.</p> |
| 779 |
<div class="refsect3"> |
| 780 |
<a name="xfce-gtk-toggle-tool-button-new-from-action-entry.parameters"></a><h4>Parameters</h4> |
| 781 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 782 |
<colgroup> |
| 783 |
<col width="150px" class="parameters_name"> |
| 784 |
<col class="parameters_description"> |
| 785 |
<col width="200px" class="parameters_annotations"> |
| 786 |
</colgroup> |
| 787 |
<tbody> |
| 788 |
<tr> |
| 789 |
<td class="parameter_name"><p>action_entry</p></td> |
| 790 |
<td class="parameter_description"><p>Label to use for the <a href="/usr/share/gtk-doc/html/gtk3/GtkToggleToolButton.html#GtkToggleToolButton-struct"><span class="type">GtkToggleToolButton</span></a></p></td> |
| 791 |
<td class="parameter_annotations"> </td> |
| 792 |
</tr> |
| 793 |
<tr> |
| 794 |
<td class="parameter_name"><p>callback_param</p></td> |
| 795 |
<td class="parameter_description"><p>optional callback parameter, or <code class="literal">NULL</code>. </p></td> |
| 796 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 797 |
</tr> |
| 798 |
<tr> |
| 799 |
<td class="parameter_name"><p>active</p></td> |
| 800 |
<td class="parameter_description"><p>boolean value indicating whether the toggle is initially active.</p></td> |
| 801 |
<td class="parameter_annotations"> </td> |
| 802 |
</tr> |
| 803 |
<tr> |
| 804 |
<td class="parameter_name"><p>toolbar_to_append_item</p></td> |
| 805 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkToolbar.html#GtkToolbar-struct"><span class="type">GtkToolbar</span></a> on which the item should be appended</p></td> |
| 806 |
<td class="parameter_annotations"> </td> |
| 807 |
</tr> |
| 808 |
</tbody> |
| 809 |
</table></div> |
| 810 |
</div> |
| 811 |
<div class="refsect3"> |
| 812 |
<a name="xfce-gtk-toggle-tool-button-new-from-action-entry.returns"></a><h4>Returns</h4> |
| 813 |
<p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkToggleToolButton.html#GtkToggleToolButton-struct"><span class="type">GtkToggleToolButton</span></a>. </p> |
| 814 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 815 |
</div> |
| 816 |
<p class="since">Since: <a class="link" href="api-index-4-17-6.html#api-index-4.17.6">4.17.6</a></p> |
| 817 |
</div> |
| 818 |
<hr> |
| 819 |
<div class="refsect2"> |
| 820 |
<a name="xfce-gtk-accel-map-add-entries"></a><h3>xfce_gtk_accel_map_add_entries ()</h3> |
| 821 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 822 |
xfce_gtk_accel_map_add_entries (<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entries</code></em>, |
| 823 |
<em class="parameter"><code><span class="type">guint</span> n_action_entries</code></em>);</pre> |
| 824 |
<p>Adds the default key of each ActionEntry to the accel_map, if no key was defined for the related accel_path so far.</p> |
| 825 |
<div class="refsect3"> |
| 826 |
<a name="xfce-gtk-accel-map-add-entries.parameters"></a><h4>Parameters</h4> |
| 827 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 828 |
<colgroup> |
| 829 |
<col width="150px" class="parameters_name"> |
| 830 |
<col class="parameters_description"> |
| 831 |
<col width="200px" class="parameters_annotations"> |
| 832 |
</colgroup> |
| 833 |
<tbody> |
| 834 |
<tr> |
| 835 |
<td class="parameter_name"><p>action_entries</p></td> |
| 836 |
<td class="parameter_description"><p>array of action_entries to be added</p></td> |
| 837 |
<td class="parameter_annotations"> </td> |
| 838 |
</tr> |
| 839 |
<tr> |
| 840 |
<td class="parameter_name"><p>n_action_entries</p></td> |
| 841 |
<td class="parameter_description"><p>size of the action_entries array</p></td> |
| 842 |
<td class="parameter_annotations"> </td> |
| 843 |
</tr> |
| 844 |
</tbody> |
| 845 |
</table></div> |
| 846 |
</div> |
| 847 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 848 |
</div> |
| 849 |
<hr> |
| 850 |
<div class="refsect2"> |
| 851 |
<a name="xfce-gtk-accel-group-connect-action-entries"></a><h3>xfce_gtk_accel_group_connect_action_entries ()</h3> |
| 852 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 853 |
xfce_gtk_accel_group_connect_action_entries |
| 854 |
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Keyboard-Accelerators.html#GtkAccelGroup-struct"><span class="type">GtkAccelGroup</span></a> *accel_group</code></em>, |
| 855 |
<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entries</code></em>, |
| 856 |
<em class="parameter"><code><span class="type">guint</span> n_action_entries</code></em>, |
| 857 |
<em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>);</pre> |
| 858 |
<p>This method will connect each accel_path from the <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> in action_entries |
| 859 |
to its related callback. If the accelerator is pressed, the related callback will be called.</p> |
| 860 |
<div class="refsect3"> |
| 861 |
<a name="xfce-gtk-accel-group-connect-action-entries.parameters"></a><h4>Parameters</h4> |
| 862 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 863 |
<colgroup> |
| 864 |
<col width="150px" class="parameters_name"> |
| 865 |
<col class="parameters_description"> |
| 866 |
<col width="200px" class="parameters_annotations"> |
| 867 |
</colgroup> |
| 868 |
<tbody> |
| 869 |
<tr> |
| 870 |
<td class="parameter_name"><p>accel_group</p></td> |
| 871 |
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Keyboard-Accelerators.html#GtkAccelGroup-struct"><span class="type">GtkAccelGroup</span></a> to connect to</p></td> |
| 872 |
<td class="parameter_annotations"> </td> |
| 873 |
</tr> |
| 874 |
<tr> |
| 875 |
<td class="parameter_name"><p>action_entries</p></td> |
| 876 |
<td class="parameter_description"><p>array of action_entries to be added</p></td> |
| 877 |
<td class="parameter_annotations"> </td> |
| 878 |
</tr> |
| 879 |
<tr> |
| 880 |
<td class="parameter_name"><p>n_action_entries</p></td> |
| 881 |
<td class="parameter_description"><p>size of the action_entries array</p></td> |
| 882 |
<td class="parameter_annotations"> </td> |
| 883 |
</tr> |
| 884 |
<tr> |
| 885 |
<td class="parameter_name"><p>callback_data</p></td> |
| 886 |
<td class="parameter_description"><p>data which should be passed to the callback of each <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a></p></td> |
| 887 |
<td class="parameter_annotations"> </td> |
| 888 |
</tr> |
| 889 |
</tbody> |
| 890 |
</table></div> |
| 891 |
</div> |
| 892 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 893 |
</div> |
| 894 |
<hr> |
| 895 |
<div class="refsect2"> |
| 896 |
<a name="xfce-gtk-accel-group-disconnect-action-entries"></a><h3>xfce_gtk_accel_group_disconnect_action_entries ()</h3> |
| 897 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 898 |
xfce_gtk_accel_group_disconnect_action_entries |
| 899 |
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Keyboard-Accelerators.html#GtkAccelGroup-struct"><span class="type">GtkAccelGroup</span></a> *accel_group</code></em>, |
| 900 |
<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entries</code></em>, |
| 901 |
<em class="parameter"><code><span class="type">guint</span> n_action_entries</code></em>);</pre> |
| 902 |
<p>This method will disconnect each accel_path from the <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> in action_entries.</p> |
| 903 |
<div class="refsect3"> |
| 904 |
<a name="xfce-gtk-accel-group-disconnect-action-entries.parameters"></a><h4>Parameters</h4> |
| 905 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 906 |
<colgroup> |
| 907 |
<col width="150px" class="parameters_name"> |
| 908 |
<col class="parameters_description"> |
| 909 |
<col width="200px" class="parameters_annotations"> |
| 910 |
</colgroup> |
| 911 |
<tbody> |
| 912 |
<tr> |
| 913 |
<td class="parameter_name"><p>accel_group</p></td> |
| 914 |
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Keyboard-Accelerators.html#GtkAccelGroup-struct"><span class="type">GtkAccelGroup</span></a> to connect to</p></td> |
| 915 |
<td class="parameter_annotations"> </td> |
| 916 |
</tr> |
| 917 |
<tr> |
| 918 |
<td class="parameter_name"><p>action_entries</p></td> |
| 919 |
<td class="parameter_description"><p>array of action_entries to be added</p></td> |
| 920 |
<td class="parameter_annotations"> </td> |
| 921 |
</tr> |
| 922 |
<tr> |
| 923 |
<td class="parameter_name"><p>n_action_entries</p></td> |
| 924 |
<td class="parameter_description"><p>size of the action_entries array</p></td> |
| 925 |
<td class="parameter_annotations"> </td> |
| 926 |
</tr> |
| 927 |
</tbody> |
| 928 |
</table></div> |
| 929 |
</div> |
| 930 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 931 |
</div> |
| 932 |
<hr> |
| 933 |
<div class="refsect2"> |
| 934 |
<a name="xfce-gtk-get-action-entry-by-id"></a><h3>xfce_gtk_get_action_entry_by_id ()</h3> |
| 935 |
<pre class="programlisting">const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="returnvalue">XfceGtkActionEntry</span></a> * |
| 936 |
xfce_gtk_get_action_entry_by_id (<em class="parameter"><code>const <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entries</code></em>, |
| 937 |
<em class="parameter"><code><span class="type">guint</span> n_action_entries</code></em>, |
| 938 |
<em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre> |
| 939 |
<p>Convenience method to find a specific action_entry from an array of action_entries</p> |
| 940 |
<div class="refsect3"> |
| 941 |
<a name="xfce-gtk-get-action-entry-by-id.parameters"></a><h4>Parameters</h4> |
| 942 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 943 |
<colgroup> |
| 944 |
<col width="150px" class="parameters_name"> |
| 945 |
<col class="parameters_description"> |
| 946 |
<col width="200px" class="parameters_annotations"> |
| 947 |
</colgroup> |
| 948 |
<tbody> |
| 949 |
<tr> |
| 950 |
<td class="parameter_name"><p>action_entries</p></td> |
| 951 |
<td class="parameter_description"><p>array of action_entries to be searched</p></td> |
| 952 |
<td class="parameter_annotations"> </td> |
| 953 |
</tr> |
| 954 |
<tr> |
| 955 |
<td class="parameter_name"><p>n_action_entries</p></td> |
| 956 |
<td class="parameter_description"><p>size of the action_entries array</p></td> |
| 957 |
<td class="parameter_annotations"> </td> |
| 958 |
</tr> |
| 959 |
<tr> |
| 960 |
<td class="parameter_name"><p>id</p></td> |
| 961 |
<td class="parameter_description"><p>id of the action entry (usually enum values are used)</p></td> |
| 962 |
<td class="parameter_annotations"> </td> |
| 963 |
</tr> |
| 964 |
</tbody> |
| 965 |
</table></div> |
| 966 |
</div> |
| 967 |
<div class="refsect3"> |
| 968 |
<a name="xfce-gtk-get-action-entry-by-id.returns"></a><h4>Returns</h4> |
| 969 |
<p>The matching <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> or NULL if not found. </p> |
| 970 |
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 971 |
</div> |
| 972 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 973 |
</div> |
| 974 |
<hr> |
| 975 |
<div class="refsect2"> |
| 976 |
<a name="xfce-gtk-translate-action-entries"></a><h3>xfce_gtk_translate_action_entries ()</h3> |
| 977 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 978 |
xfce_gtk_translate_action_entries (<em class="parameter"><code><a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *action_entries</code></em>, |
| 979 |
<em class="parameter"><code><span class="type">guint</span> n_action_entries</code></em>);</pre> |
| 980 |
<p>Convenience method to translate the label text and tooltip text of an array of action_entries</p> |
| 981 |
<div class="refsect3"> |
| 982 |
<a name="xfce-gtk-translate-action-entries.parameters"></a><h4>Parameters</h4> |
| 983 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 984 |
<colgroup> |
| 985 |
<col width="150px" class="parameters_name"> |
| 986 |
<col class="parameters_description"> |
| 987 |
<col width="200px" class="parameters_annotations"> |
| 988 |
</colgroup> |
| 989 |
<tbody> |
| 990 |
<tr> |
| 991 |
<td class="parameter_name"><p>action_entries</p></td> |
| 992 |
<td class="parameter_description"><p>array of action_entries to be translated</p></td> |
| 993 |
<td class="parameter_annotations"> </td> |
| 994 |
</tr> |
| 995 |
<tr> |
| 996 |
<td class="parameter_name"><p>n_action_entries</p></td> |
| 997 |
<td class="parameter_description"><p>size of the action_entries array</p></td> |
| 998 |
<td class="parameter_annotations"> </td> |
| 999 |
</tr> |
| 1000 |
</tbody> |
| 1001 |
</table></div> |
| 1002 |
</div> |
| 1003 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 1004 |
</div> |
| 1005 |
<hr> |
| 1006 |
<div class="refsect2"> |
| 1007 |
<a name="xfce-gtk-handle-tab-accels"></a><h3>xfce_gtk_handle_tab_accels ()</h3> |
| 1008 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 1009 |
xfce_gtk_handle_tab_accels (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *key_event</code></em>, |
| 1010 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Keyboard-Accelerators.html#GtkAccelGroup-struct"><span class="type">GtkAccelGroup</span></a> *accel_group</code></em>, |
| 1011 |
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>, |
| 1012 |
<em class="parameter"><code><a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *entries</code></em>, |
| 1013 |
<em class="parameter"><code><span class="type">size_t</span> entry_count</code></em>);</pre> |
| 1014 |
<p>The Tab key is used to navigate the interface by GTK+ so we need to handle shortcuts with the Tab accelerator manually. |
| 1015 |
Tab sometimes becomes ISO_Left_Tab (e.g. in Ctrl+Shift+Tab) so check both here.</p> |
| 1016 |
<div class="refsect3"> |
| 1017 |
<a name="xfce-gtk-handle-tab-accels.parameters"></a><h4>Parameters</h4> |
| 1018 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1019 |
<colgroup> |
| 1020 |
<col width="150px" class="parameters_name"> |
| 1021 |
<col class="parameters_description"> |
| 1022 |
<col width="200px" class="parameters_annotations"> |
| 1023 |
</colgroup> |
| 1024 |
<tbody> |
| 1025 |
<tr> |
| 1026 |
<td class="parameter_name"><p>key_event</p></td> |
| 1027 |
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> that might trigger a shortcut</p></td> |
| 1028 |
<td class="parameter_annotations"> </td> |
| 1029 |
</tr> |
| 1030 |
<tr> |
| 1031 |
<td class="parameter_name"><p>accel_group</p></td> |
| 1032 |
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Keyboard-Accelerators.html#GtkAccelGroup-struct"><span class="type">GtkAccelGroup</span></a> that will be get queried</p></td> |
| 1033 |
<td class="parameter_annotations"> </td> |
| 1034 |
</tr> |
| 1035 |
<tr> |
| 1036 |
<td class="parameter_name"><p>data</p></td> |
| 1037 |
<td class="parameter_description"><p>a pointer of data that will be passed to the callback if a tab-shortcut is found</p></td> |
| 1038 |
<td class="parameter_annotations"> </td> |
| 1039 |
</tr> |
| 1040 |
<tr> |
| 1041 |
<td class="parameter_name"><p>entries</p></td> |
| 1042 |
<td class="parameter_description"><p>a <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a>[]</p></td> |
| 1043 |
<td class="parameter_annotations"> </td> |
| 1044 |
</tr> |
| 1045 |
<tr> |
| 1046 |
<td class="parameter_name"><p>entry_count</p></td> |
| 1047 |
<td class="parameter_description"><p>the number of entries in <em class="parameter"><code>entries</code></em> |
| 1048 |
</p></td> |
| 1049 |
<td class="parameter_annotations"> </td> |
| 1050 |
</tr> |
| 1051 |
</tbody> |
| 1052 |
</table></div> |
| 1053 |
</div> |
| 1054 |
<div class="refsect3"> |
| 1055 |
<a name="xfce-gtk-handle-tab-accels.returns"></a><h4>Returns</h4> |
| 1056 |
<p> a boolean that is GDK_EVENT_STOP (TRUE) if the event was handled, otherwise it is GDK_EVENT_PROPAGATE (FALSE)</p> |
| 1057 |
</div> |
| 1058 |
</div> |
| 1059 |
<hr> |
| 1060 |
<div class="refsect2"> |
| 1061 |
<a name="xfce-gtk-execute-tab-accel"></a><h3>xfce_gtk_execute_tab_accel ()</h3> |
| 1062 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 1063 |
xfce_gtk_execute_tab_accel (<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>, |
| 1064 |
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>, |
| 1065 |
<em class="parameter"><code><a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> *entries</code></em>, |
| 1066 |
<em class="parameter"><code><span class="type">size_t</span> entry_count</code></em>);</pre> |
| 1067 |
<p>Activates the callback function of the <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a> that corresponds to <em class="parameter"><code>accel_path</code></em> |
| 1068 |
. If no such action |
| 1069 |
exists in <em class="parameter"><code>entries</code></em> |
| 1070 |
, then nothing happens.</p> |
| 1071 |
<div class="refsect3"> |
| 1072 |
<a name="xfce-gtk-execute-tab-accel.parameters"></a><h4>Parameters</h4> |
| 1073 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1074 |
<colgroup> |
| 1075 |
<col width="150px" class="parameters_name"> |
| 1076 |
<col class="parameters_description"> |
| 1077 |
<col width="200px" class="parameters_annotations"> |
| 1078 |
</colgroup> |
| 1079 |
<tbody> |
| 1080 |
<tr> |
| 1081 |
<td class="parameter_name"><p>accel_path</p></td> |
| 1082 |
<td class="parameter_description"><p>the accelerator path of the action that we want to activate</p></td> |
| 1083 |
<td class="parameter_annotations"> </td> |
| 1084 |
</tr> |
| 1085 |
<tr> |
| 1086 |
<td class="parameter_name"><p>data</p></td> |
| 1087 |
<td class="parameter_description"><p>a pointer of data that will be passed to the callback if a tab-shortcut is found</p></td> |
| 1088 |
<td class="parameter_annotations"> </td> |
| 1089 |
</tr> |
| 1090 |
<tr> |
| 1091 |
<td class="parameter_name"><p>entries</p></td> |
| 1092 |
<td class="parameter_description"><p>a <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a>[]</p></td> |
| 1093 |
<td class="parameter_annotations"> </td> |
| 1094 |
</tr> |
| 1095 |
<tr> |
| 1096 |
<td class="parameter_name"><p>entry_count</p></td> |
| 1097 |
<td class="parameter_description"><p>the number of entries in <em class="parameter"><code>entries</code></em> |
| 1098 |
</p></td> |
| 1099 |
<td class="parameter_annotations"> </td> |
| 1100 |
</tr> |
| 1101 |
</tbody> |
| 1102 |
</table></div> |
| 1103 |
</div> |
| 1104 |
<div class="refsect3"> |
| 1105 |
<a name="xfce-gtk-execute-tab-accel.returns"></a><h4>Returns</h4> |
| 1106 |
<p> a boolean that is TRUE if the action was found, otherwise it is FALSE</p> |
| 1107 |
</div> |
| 1108 |
</div> |
| 1109 |
<hr> |
| 1110 |
<div class="refsect2"> |
| 1111 |
<a name="xfce-gtk-menu-append-separator"></a><h3>xfce_gtk_menu_append_separator ()</h3> |
| 1112 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1113 |
xfce_gtk_menu_append_separator (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> *menu</code></em>);</pre> |
| 1114 |
<p>Convenience method do add separators, used to prevent code duplication</p> |
| 1115 |
<div class="refsect3"> |
| 1116 |
<a name="xfce-gtk-menu-append-separator.parameters"></a><h4>Parameters</h4> |
| 1117 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1118 |
<colgroup> |
| 1119 |
<col width="150px" class="parameters_name"> |
| 1120 |
<col class="parameters_description"> |
| 1121 |
<col width="200px" class="parameters_annotations"> |
| 1122 |
</colgroup> |
| 1123 |
<tbody><tr> |
| 1124 |
<td class="parameter_name"><p>menu</p></td> |
| 1125 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuShell.html#GtkMenuShell-struct"><span class="type">GtkMenuShell</span></a> on which the separator should be appended</p></td> |
| 1126 |
<td class="parameter_annotations"> </td> |
| 1127 |
</tr></tbody> |
| 1128 |
</table></div> |
| 1129 |
</div> |
| 1130 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 1131 |
</div> |
| 1132 |
<hr> |
| 1133 |
<div class="refsect2"> |
| 1134 |
<a name="xfce-gtk-button-new-mixed"></a><h3>xfce_gtk_button_new_mixed ()</h3> |
| 1135 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 1136 |
xfce_gtk_button_new_mixed (<em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>, |
| 1137 |
<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre> |
| 1138 |
<p>Creates a new <a href="/usr/share/gtk-doc/html/gtk3/GtkButton.html#GtkButton-struct"><span class="type">GtkButton</span></a> containing a mnemonic label and a stock icon. |
| 1139 |
The <em class="parameter"><code>stock_id</code></em> |
| 1140 |
could be something like <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Stock-Items.html#GTK-STOCK-OK:CAPS"><span class="type">GTK_STOCK_OK</span></a> or <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Stock-Items.html#GTK-STOCK-APPLY:CAPS"><span class="type">GTK_STOCK_APPLY</span></a>.</p> |
| 1141 |
<p>When the <em class="parameter"><code>stock_id</code></em> |
| 1142 |
is <code class="literal">NULL</code> a normal mnemonic button will be created, |
| 1143 |
when <em class="parameter"><code>label</code></em> |
| 1144 |
is <code class="literal">NULL</code> a stock button will be created. This behaviour |
| 1145 |
is added for <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a>.</p> |
| 1146 |
<div class="refsect3"> |
| 1147 |
<a name="xfce-gtk-button-new-mixed.parameters"></a><h4>Parameters</h4> |
| 1148 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1149 |
<colgroup> |
| 1150 |
<col width="150px" class="parameters_name"> |
| 1151 |
<col class="parameters_description"> |
| 1152 |
<col width="200px" class="parameters_annotations"> |
| 1153 |
</colgroup> |
| 1154 |
<tbody> |
| 1155 |
<tr> |
| 1156 |
<td class="parameter_name"><p>stock_id</p></td> |
| 1157 |
<td class="parameter_description"><p>the name of the stock item. </p></td> |
| 1158 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1159 |
</tr> |
| 1160 |
<tr> |
| 1161 |
<td class="parameter_name"><p>label</p></td> |
| 1162 |
<td class="parameter_description"><p>the text of the button, with an underscore |
| 1163 |
in front of the mnemonic character. </p></td> |
| 1164 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1165 |
</tr> |
| 1166 |
</tbody> |
| 1167 |
</table></div> |
| 1168 |
</div> |
| 1169 |
<div class="refsect3"> |
| 1170 |
<a name="xfce-gtk-button-new-mixed.returns"></a><h4>Returns</h4> |
| 1171 |
<p>the newly created <a href="/usr/share/gtk-doc/html/gtk3/GtkButton.html#GtkButton-struct"><span class="type">GtkButton</span></a> widget. </p> |
| 1172 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 1173 |
</div> |
| 1174 |
</div> |
| 1175 |
<hr> |
| 1176 |
<div class="refsect2"> |
| 1177 |
<a name="xfce-gtk-frame-box-new"></a><h3>xfce_gtk_frame_box_new ()</h3> |
| 1178 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 1179 |
xfce_gtk_frame_box_new (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>, |
| 1180 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **container_return</code></em>);</pre> |
| 1181 |
<p>Creates an Xfce-styled frame. The frame is a <a href="/usr/share/gtk-doc/html/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a>, without |
| 1182 |
outline and an optional bolded text label. The contents of the |
| 1183 |
frame are indented on the left. |
| 1184 |
The return value is the <a href="/usr/share/gtk-doc/html/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a> itself. The <em class="parameter"><code>container_return</code></em> |
| 1185 |
is |
| 1186 |
a <a href="/usr/share/gtk-doc/html/gtk3/GtkAlignment.html#GtkAlignment-struct"><span class="type">GtkAlignment</span></a> widget to which children of the frame should be added.</p> |
| 1187 |
<p>See also: <a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-frame-box-new-with-content" title="xfce_gtk_frame_box_new_with_content ()"><code class="function">xfce_gtk_frame_box_new_with_content()</code></a>.</p> |
| 1188 |
<div class="refsect3"> |
| 1189 |
<a name="xfce-gtk-frame-box-new.parameters"></a><h4>Parameters</h4> |
| 1190 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1191 |
<colgroup> |
| 1192 |
<col width="150px" class="parameters_name"> |
| 1193 |
<col class="parameters_description"> |
| 1194 |
<col width="200px" class="parameters_annotations"> |
| 1195 |
</colgroup> |
| 1196 |
<tbody> |
| 1197 |
<tr> |
| 1198 |
<td class="parameter_name"><p>label</p></td> |
| 1199 |
<td class="parameter_description"><p>the text to use as the label of the frame.</p></td> |
| 1200 |
<td class="parameter_annotations"> </td> |
| 1201 |
</tr> |
| 1202 |
<tr> |
| 1203 |
<td class="parameter_name"><p>container_return</p></td> |
| 1204 |
<td class="parameter_description"><p>return location for the frame's container. </p></td> |
| 1205 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1206 |
</tr> |
| 1207 |
</tbody> |
| 1208 |
</table></div> |
| 1209 |
</div> |
| 1210 |
<div class="refsect3"> |
| 1211 |
<a name="xfce-gtk-frame-box-new.returns"></a><h4>Returns</h4> |
| 1212 |
<p>the newly created <a href="/usr/share/gtk-doc/html/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a> widget. </p> |
| 1213 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 1214 |
</div> |
| 1215 |
</div> |
| 1216 |
<hr> |
| 1217 |
<div class="refsect2"> |
| 1218 |
<a name="xfce-gtk-frame-box-new-with-content"></a><h3>xfce_gtk_frame_box_new_with_content ()</h3> |
| 1219 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 1220 |
xfce_gtk_frame_box_new_with_content (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>, |
| 1221 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *content</code></em>);</pre> |
| 1222 |
<p>Creates a widget with <a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-frame-box-new" title="xfce_gtk_frame_box_new ()"><code class="function">xfce_gtk_frame_box_new()</code></a> and adds the |
| 1223 |
<em class="parameter"><code>content</code></em> |
| 1224 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> to the frame.</p> |
| 1225 |
<div class="refsect3"> |
| 1226 |
<a name="xfce-gtk-frame-box-new-with-content.parameters"></a><h4>Parameters</h4> |
| 1227 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1228 |
<colgroup> |
| 1229 |
<col width="150px" class="parameters_name"> |
| 1230 |
<col class="parameters_description"> |
| 1231 |
<col width="200px" class="parameters_annotations"> |
| 1232 |
</colgroup> |
| 1233 |
<tbody> |
| 1234 |
<tr> |
| 1235 |
<td class="parameter_name"><p>label</p></td> |
| 1236 |
<td class="parameter_description"><p>the text to use as the label of the frame.</p></td> |
| 1237 |
<td class="parameter_annotations"> </td> |
| 1238 |
</tr> |
| 1239 |
<tr> |
| 1240 |
<td class="parameter_name"><p>content</p></td> |
| 1241 |
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> to put inside the frame.</p></td> |
| 1242 |
<td class="parameter_annotations"> </td> |
| 1243 |
</tr> |
| 1244 |
</tbody> |
| 1245 |
</table></div> |
| 1246 |
</div> |
| 1247 |
<div class="refsect3"> |
| 1248 |
<a name="xfce-gtk-frame-box-new-with-content.returns"></a><h4>Returns</h4> |
| 1249 |
<p>the newly created <a href="/usr/share/gtk-doc/html/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a> widget. </p> |
| 1250 |
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p> |
| 1251 |
</div> |
| 1252 |
</div> |
| 1253 |
<hr> |
| 1254 |
<div class="refsect2"> |
| 1255 |
<a name="xfce-gtk-window-center-on-active-screen"></a><h3>xfce_gtk_window_center_on_active_screen ()</h3> |
| 1256 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1257 |
xfce_gtk_window_center_on_active_screen |
| 1258 |
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>);</pre> |
| 1259 |
<p>Determines the screen that contains the pointer and centers the |
| 1260 |
<em class="parameter"><code>window</code></em> |
| 1261 |
on it. If it failes to determine the current pointer position, |
| 1262 |
<em class="parameter"><code>window</code></em> |
| 1263 |
is centered on the default screen.</p> |
| 1264 |
<p>This function only works properly if you call it before realizing the |
| 1265 |
window and you haven't set a fixed window position using <a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#gtk-window-move"><code class="function">gtk_window_move()</code></a>.</p> |
| 1266 |
<p>See also: <a class="link" href="libxfce4ui-Gdk-Extensions.html#xfce-gdk-screen-get-active" title="xfce_gdk_screen_get_active ()"><code class="function">xfce_gdk_screen_get_active()</code></a>.</p> |
| 1267 |
<div class="refsect3"> |
| 1268 |
<a name="xfce-gtk-window-center-on-active-screen.parameters"></a><h4>Parameters</h4> |
| 1269 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1270 |
<colgroup> |
| 1271 |
<col width="150px" class="parameters_name"> |
| 1272 |
<col class="parameters_description"> |
| 1273 |
<col width="200px" class="parameters_annotations"> |
| 1274 |
</colgroup> |
| 1275 |
<tbody><tr> |
| 1276 |
<td class="parameter_name"><p>window</p></td> |
| 1277 |
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> to center.</p></td> |
| 1278 |
<td class="parameter_annotations"> </td> |
| 1279 |
</tr></tbody> |
| 1280 |
</table></div> |
| 1281 |
</div> |
| 1282 |
</div> |
| 1283 |
<hr> |
| 1284 |
<div class="refsect2"> |
| 1285 |
<a name="xfce-gtk-menu-popup-until-mapped"></a><h3>xfce_gtk_menu_popup_until_mapped ()</h3> |
| 1286 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 1287 |
xfce_gtk_menu_popup_until_mapped (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a> *menu</code></em>, |
| 1288 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent_menu_shell</code></em>, |
| 1289 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent_menu_item</code></em>, |
| 1290 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenuPositionFunc"><span class="type">GtkMenuPositionFunc</span></a> func</code></em>, |
| 1291 |
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>, |
| 1292 |
<em class="parameter"><code><span class="type">guint</span> button</code></em>, |
| 1293 |
<em class="parameter"><code><span class="type">guint32</span> activate_time</code></em>);</pre> |
| 1294 |
<p>Attempts to pop up a <a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a> for a short duration. Unlike the original |
| 1295 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>, this function will verify that the menu has been mapped |
| 1296 |
or will keep trying for up to 250ms. It will also return a value indicating |
| 1297 |
whether the menu was eventually mapped or not. Following is an excerpt from |
| 1298 |
the GTK+ Documentation on <a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a>.</p> |
| 1299 |
<p>Displays a menu and makes it available for selection.</p> |
| 1300 |
<p>Applications can use this function to display context-sensitive menus, and will |
| 1301 |
typically supply <code class="literal">NULL</code> for the <em class="parameter"><code>parent_menu_shell</code></em> |
| 1302 |
, <em class="parameter"><code>parent_menu_item</code></em> |
| 1303 |
, <em class="parameter"><code>func</code></em> |
| 1304 |
and |
| 1305 |
<em class="parameter"><code>data</code></em> |
| 1306 |
parameters. The default menu positioning function will position the menu |
| 1307 |
at the current mouse cursor position.</p> |
| 1308 |
<p>The <em class="parameter"><code>button</code></em> |
| 1309 |
parameter should be the mouse button pressed to initiate the menu |
| 1310 |
popup. If the menu popup was initiated by something other than a mouse button |
| 1311 |
press, such as a mouse button release or a keypress, button should be 0.</p> |
| 1312 |
<p>The <em class="parameter"><code>activate_time</code></em> |
| 1313 |
parameter is used to conflict-resolve initiation of concurrent |
| 1314 |
requests for mouse/keyboard grab requests. To function properly, this needs to |
| 1315 |
be the timestamp of the user event (such as a mouse click or key press) that |
| 1316 |
caused the initiation of the popup. Only if no such event is available, |
| 1317 |
<a href="/usr/share/gtk-doc/html/gtk3/gtk3-General.html#gtk-get-current-event-time"><code class="function">gtk_get_current_event_time()</code></a> can be used instead.</p> |
| 1318 |
<div class="refsect3"> |
| 1319 |
<a name="xfce-gtk-menu-popup-until-mapped.parameters"></a><h4>Parameters</h4> |
| 1320 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1321 |
<colgroup> |
| 1322 |
<col width="150px" class="parameters_name"> |
| 1323 |
<col class="parameters_description"> |
| 1324 |
<col width="200px" class="parameters_annotations"> |
| 1325 |
</colgroup> |
| 1326 |
<tbody> |
| 1327 |
<tr> |
| 1328 |
<td class="parameter_name"><p>menu</p></td> |
| 1329 |
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a>.</p></td> |
| 1330 |
<td class="parameter_annotations"> </td> |
| 1331 |
</tr> |
| 1332 |
<tr> |
| 1333 |
<td class="parameter_name"><p>parent_menu_shell</p></td> |
| 1334 |
<td class="parameter_description"><p>the menu shell containing the triggering menu item, or <code class="literal">NULL</code>. </p></td> |
| 1335 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1336 |
</tr> |
| 1337 |
<tr> |
| 1338 |
<td class="parameter_name"><p>parent_menu_item</p></td> |
| 1339 |
<td class="parameter_description"><p>the menu item whose activation triggered the popup, or <code class="literal">NULL</code>. </p></td> |
| 1340 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1341 |
</tr> |
| 1342 |
<tr> |
| 1343 |
<td class="parameter_name"><p>func</p></td> |
| 1344 |
<td class="parameter_description"><p>a user supplied function used to position the menu, or <code class="literal">NULL</code>. </p></td> |
| 1345 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1346 |
</tr> |
| 1347 |
<tr> |
| 1348 |
<td class="parameter_name"><p>data</p></td> |
| 1349 |
<td class="parameter_description"><p>user supplied data to be passed to func. </p></td> |
| 1350 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1351 |
</tr> |
| 1352 |
<tr> |
| 1353 |
<td class="parameter_name"><p>button</p></td> |
| 1354 |
<td class="parameter_description"><p>the mouse button which was pressed to initiate the event.</p></td> |
| 1355 |
<td class="parameter_annotations"> </td> |
| 1356 |
</tr> |
| 1357 |
<tr> |
| 1358 |
<td class="parameter_name"><p>activate_time</p></td> |
| 1359 |
<td class="parameter_description"><p>the time at which the activation event occurred.</p></td> |
| 1360 |
<td class="parameter_annotations"> </td> |
| 1361 |
</tr> |
| 1362 |
</tbody> |
| 1363 |
</table></div> |
| 1364 |
</div> |
| 1365 |
<div class="refsect3"> |
| 1366 |
<a name="xfce-gtk-menu-popup-until-mapped.returns"></a><h4>Returns</h4> |
| 1367 |
<p> <code class="literal">TRUE</code> if the menu could be mapped, <code class="literal">FALSE</code> otherwise.</p> |
| 1368 |
</div> |
| 1369 |
<p class="since">Since: <a class="link" href="api-index-4-14.html#api-index-4.14">4.14</a></p> |
| 1370 |
</div> |
| 1371 |
<hr> |
| 1372 |
<div class="refsect2"> |
| 1373 |
<a name="xfce-widget-reparent"></a><h3>xfce_widget_reparent ()</h3> |
| 1374 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 1375 |
xfce_widget_reparent (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>, |
| 1376 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *new_parent</code></em>);</pre> |
| 1377 |
<p>Moves a widget from one GtkContainer to another, handling reference |
| 1378 |
count issues to avoid destroying the widget.</p> |
| 1379 |
<div class="refsect3"> |
| 1380 |
<a name="xfce-widget-reparent.parameters"></a><h4>Parameters</h4> |
| 1381 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1382 |
<colgroup> |
| 1383 |
<col width="150px" class="parameters_name"> |
| 1384 |
<col class="parameters_description"> |
| 1385 |
<col width="200px" class="parameters_annotations"> |
| 1386 |
</colgroup> |
| 1387 |
<tbody> |
| 1388 |
<tr> |
| 1389 |
<td class="parameter_name"><p>widget</p></td> |
| 1390 |
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a>.</p></td> |
| 1391 |
<td class="parameter_annotations"> </td> |
| 1392 |
</tr> |
| 1393 |
<tr> |
| 1394 |
<td class="parameter_name"><p>new_parent</p></td> |
| 1395 |
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct"><span class="type">GtkContainer</span></a> to move the widget into</p></td> |
| 1396 |
<td class="parameter_annotations"> </td> |
| 1397 |
</tr> |
| 1398 |
</tbody> |
| 1399 |
</table></div> |
| 1400 |
</div> |
| 1401 |
<div class="refsect3"> |
| 1402 |
<a name="xfce-widget-reparent.returns"></a><h4>Returns</h4> |
| 1403 |
<p> <code class="literal">TRUE</code> if the widget could be moved, <code class="literal">FALSE</code> otherwise.</p> |
| 1404 |
</div> |
| 1405 |
<p class="since">Since: <a class="link" href="api-index-4-14.html#api-index-4.14">4.14</a></p> |
| 1406 |
</div> |
| 1407 |
<hr> |
| 1408 |
<div class="refsect2"> |
| 1409 |
<a name="xfce-icon-name-from-desktop-id"></a><h3>xfce_icon_name_from_desktop_id ()</h3> |
| 1410 |
<pre class="programlisting"><span class="returnvalue">gchar</span> * |
| 1411 |
xfce_icon_name_from_desktop_id (<em class="parameter"><code>const <span class="type">gchar</span> *desktop_id</code></em>);</pre> |
| 1412 |
<div class="refsect3"> |
| 1413 |
<a name="xfce-icon-name-from-desktop-id.parameters"></a><h4>Parameters</h4> |
| 1414 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1415 |
<colgroup> |
| 1416 |
<col width="150px" class="parameters_name"> |
| 1417 |
<col class="parameters_description"> |
| 1418 |
<col width="200px" class="parameters_annotations"> |
| 1419 |
</colgroup> |
| 1420 |
<tbody><tr> |
| 1421 |
<td class="parameter_name"><p>desktop_id</p></td> |
| 1422 |
<td class="parameter_description"><p>Name of the desktop file.</p></td> |
| 1423 |
<td class="parameter_annotations"> </td> |
| 1424 |
</tr></tbody> |
| 1425 |
</table></div> |
| 1426 |
</div> |
| 1427 |
<div class="refsect3"> |
| 1428 |
<a name="xfce-icon-name-from-desktop-id.returns"></a><h4>Returns</h4> |
| 1429 |
<p> <code class="literal">NULL</code> on error, else the string value of the "Icon" property.</p> |
| 1430 |
</div> |
| 1431 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 1432 |
</div> |
| 1433 |
<hr> |
| 1434 |
<div class="refsect2"> |
| 1435 |
<a name="xfce-gicon-from-name"></a><h3>xfce_gicon_from_name ()</h3> |
| 1436 |
<pre class="programlisting"><span class="returnvalue">GIcon</span> * |
| 1437 |
xfce_gicon_from_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> |
| 1438 |
<p>This function will first look for a desktop file of <em class="parameter"><code>name</code></em> |
| 1439 |
and if successful |
| 1440 |
use the value of the "Icon" property to return a <span class="type">GIcon</span>. |
| 1441 |
If no desktop file of <em class="parameter"><code>name</code></em> |
| 1442 |
is found it will fallback to returning a <span class="type">GIcon</span> |
| 1443 |
based on <span class="type">g_themed_icon_new_with_default_fallbacks</span> and |
| 1444 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkIconTheme.html#gtk-icon-theme-lookup-by-gicon"><span class="type">gtk_icon_theme_lookup_by_gicon</span></a>.</p> |
| 1445 |
<div class="refsect3"> |
| 1446 |
<a name="xfce-gicon-from-name.parameters"></a><h4>Parameters</h4> |
| 1447 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1448 |
<colgroup> |
| 1449 |
<col width="150px" class="parameters_name"> |
| 1450 |
<col class="parameters_description"> |
| 1451 |
<col width="200px" class="parameters_annotations"> |
| 1452 |
</colgroup> |
| 1453 |
<tbody><tr> |
| 1454 |
<td class="parameter_name"><p>name</p></td> |
| 1455 |
<td class="parameter_description"><p>Name of the application.</p></td> |
| 1456 |
<td class="parameter_annotations"> </td> |
| 1457 |
</tr></tbody> |
| 1458 |
</table></div> |
| 1459 |
</div> |
| 1460 |
<div class="refsect3"> |
| 1461 |
<a name="xfce-gicon-from-name.returns"></a><h4>Returns</h4> |
| 1462 |
<p>a new <span class="type">GThemedIcon</span>. </p> |
| 1463 |
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1464 |
</div> |
| 1465 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 1466 |
</div> |
| 1467 |
<hr> |
| 1468 |
<div class="refsect2"> |
| 1469 |
<a name="xfce-gtk-menu-item-set-accel-label"></a><h3>xfce_gtk_menu_item_set_accel_label ()</h3> |
| 1470 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1471 |
xfce_gtk_menu_item_set_accel_label (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a> *menu_item</code></em>, |
| 1472 |
<em class="parameter"><code>const <span class="type">gchar</span> *accel_path</code></em>);</pre> |
| 1473 |
<p>Use the passed accel_path show the related <a href="/usr/share/gtk-doc/html/gtk3/GtkAccelLabel.html#GtkAccelLabel-struct"><span class="type">GtkAccelLabel</span></a> with the correct accelerator on the item.</p> |
| 1474 |
<div class="refsect3"> |
| 1475 |
<a name="xfce-gtk-menu-item-set-accel-label.parameters"></a><h4>Parameters</h4> |
| 1476 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1477 |
<colgroup> |
| 1478 |
<col width="150px" class="parameters_name"> |
| 1479 |
<col class="parameters_description"> |
| 1480 |
<col width="200px" class="parameters_annotations"> |
| 1481 |
</colgroup> |
| 1482 |
<tbody> |
| 1483 |
<tr> |
| 1484 |
<td class="parameter_name"><p>menu_item</p></td> |
| 1485 |
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a> on which the accel label is to set</p></td> |
| 1486 |
<td class="parameter_annotations"> </td> |
| 1487 |
</tr> |
| 1488 |
<tr> |
| 1489 |
<td class="parameter_name"><p>accel_path</p></td> |
| 1490 |
<td class="parameter_description"><p>Unique path, used to identify the accelerator, or NULL to show no accelerator. </p></td> |
| 1491 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 1492 |
</tr> |
| 1493 |
</tbody> |
| 1494 |
</table></div> |
| 1495 |
</div> |
| 1496 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 1497 |
</div> |
| 1498 |
<hr> |
| 1499 |
<div class="refsect2"> |
| 1500 |
<a name="xfce-has-gtk-frame-extents"></a><h3>xfce_has_gtk_frame_extents ()</h3> |
| 1501 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 1502 |
xfce_has_gtk_frame_extents (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> *window</code></em>, |
| 1503 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkStyleContext.html#GtkBorder-struct"><span class="type">GtkBorder</span></a> *extents</code></em>);</pre> |
| 1504 |
<p>This function can be called to determine if a <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> is using client-side decorations |
| 1505 |
which is indicated by the _GTK_FRAME_EXTENTS X11 atom. It furthermore sets a pointer |
| 1506 |
of type <a href="/usr/share/gtk-doc/html/gtk3/GtkStyleContext.html#GtkBorder-struct"><span class="type">GtkBorder</span></a> to the actual extents.</p> |
| 1507 |
<div class="refsect3"> |
| 1508 |
<a name="xfce-has-gtk-frame-extents.parameters"></a><h4>Parameters</h4> |
| 1509 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1510 |
<colgroup> |
| 1511 |
<col width="150px" class="parameters_name"> |
| 1512 |
<col class="parameters_description"> |
| 1513 |
<col width="200px" class="parameters_annotations"> |
| 1514 |
</colgroup> |
| 1515 |
<tbody> |
| 1516 |
<tr> |
| 1517 |
<td class="parameter_name"><p>window</p></td> |
| 1518 |
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a></p></td> |
| 1519 |
<td class="parameter_annotations"> </td> |
| 1520 |
</tr> |
| 1521 |
<tr> |
| 1522 |
<td class="parameter_name"><p>extents</p></td> |
| 1523 |
<td class="parameter_description"><p>A pointer to a <a href="/usr/share/gtk-doc/html/gtk3/GtkStyleContext.html#GtkBorder-struct"><span class="type">GtkBorder</span></a> to copy to.</p></td> |
| 1524 |
<td class="parameter_annotations"> </td> |
| 1525 |
</tr> |
| 1526 |
</tbody> |
| 1527 |
</table></div> |
| 1528 |
</div> |
| 1529 |
<div class="refsect3"> |
| 1530 |
<a name="xfce-has-gtk-frame-extents.returns"></a><h4>Returns</h4> |
| 1531 |
<p> TRUE if a <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> has the _GTK_FRAME_EXTENTS atom set.</p> |
| 1532 |
</div> |
| 1533 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 1534 |
</div> |
| 1535 |
<hr> |
| 1536 |
<div class="refsect2"> |
| 1537 |
<a name="xfce-gtk-label-set-a11y-relation"></a><h3>xfce_gtk_label_set_a11y_relation ()</h3> |
| 1538 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1539 |
xfce_gtk_label_set_a11y_relation (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkLabel.html#GtkLabel-struct"><span class="type">GtkLabel</span></a> *label</code></em>, |
| 1540 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre> |
| 1541 |
<p>Sets the <code class="literal">ATK_RELATION_LABEL_FOR</code> relation on <em class="parameter"><code>label</code></em> |
| 1542 |
for <em class="parameter"><code>widget</code></em> |
| 1543 |
, which means |
| 1544 |
accessiblity tools will identify <em class="parameter"><code>label</code></em> |
| 1545 |
as descriptive item for the specified |
| 1546 |
<em class="parameter"><code>widget</code></em> |
| 1547 |
.</p> |
| 1548 |
<div class="refsect3"> |
| 1549 |
<a name="xfce-gtk-label-set-a11y-relation.parameters"></a><h4>Parameters</h4> |
| 1550 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1551 |
<colgroup> |
| 1552 |
<col width="150px" class="parameters_name"> |
| 1553 |
<col class="parameters_description"> |
| 1554 |
<col width="200px" class="parameters_annotations"> |
| 1555 |
</colgroup> |
| 1556 |
<tbody> |
| 1557 |
<tr> |
| 1558 |
<td class="parameter_name"><p>label</p></td> |
| 1559 |
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkLabel.html#GtkLabel-struct"><span class="type">GtkLabel</span></a>.</p></td> |
| 1560 |
<td class="parameter_annotations"> </td> |
| 1561 |
</tr> |
| 1562 |
<tr> |
| 1563 |
<td class="parameter_name"><p>widget</p></td> |
| 1564 |
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a>.</p></td> |
| 1565 |
<td class="parameter_annotations"> </td> |
| 1566 |
</tr> |
| 1567 |
</tbody> |
| 1568 |
</table></div> |
| 1569 |
</div> |
| 1570 |
</div> |
| 1571 |
</div> |
| 1572 |
<div class="refsect1"> |
| 1573 |
<a name="libxfce4ui-Gtk-Extensions.other_details"></a><h2>Types and Values</h2> |
| 1574 |
<div class="refsect2"> |
| 1575 |
<a name="XfceGtkMenuItem"></a><h3>enum XfceGtkMenuItem</h3> |
| 1576 |
<p>List of item types which are supported by the <a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry" title="XfceGtkActionEntry"><span class="type">XfceGtkActionEntry</span></a>. |
| 1577 |
To be extended if required.</p> |
| 1578 |
<div class="refsect3"> |
| 1579 |
<a name="XfceGtkMenuItem.members"></a><h4>Members</h4> |
| 1580 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1581 |
<colgroup> |
| 1582 |
<col width="300px" class="enum_members_name"> |
| 1583 |
<col class="enum_members_description"> |
| 1584 |
<col width="200px" class="enum_members_annotations"> |
| 1585 |
</colgroup> |
| 1586 |
<tbody> |
| 1587 |
<tr> |
| 1588 |
<td class="enum_member_name"><p><a name="XFCE-GTK-MENU-ITEM:CAPS"></a>XFCE_GTK_MENU_ITEM</p></td> |
| 1589 |
<td class="enum_member_description"> |
| 1590 |
<p>see <a href="/usr/share/gtk-doc/html/gtk3/GtkMenuItem.html#GtkMenuItem-struct"><span class="type">GtkMenuItem</span></a></p> |
| 1591 |
</td> |
| 1592 |
<td class="enum_member_annotations"> </td> |
| 1593 |
</tr> |
| 1594 |
<tr> |
| 1595 |
<td class="enum_member_name"><p><a name="XFCE-GTK-IMAGE-MENU-ITEM:CAPS"></a>XFCE_GTK_IMAGE_MENU_ITEM</p></td> |
| 1596 |
<td class="enum_member_description"> |
| 1597 |
<p>see <a href="/usr/share/gtk-doc/html/gtk3/GtkImageMenuItem.html#GtkImageMenuItem-struct"><span class="type">GtkImageMenuItem</span></a></p> |
| 1598 |
</td> |
| 1599 |
<td class="enum_member_annotations"> </td> |
| 1600 |
</tr> |
| 1601 |
<tr> |
| 1602 |
<td class="enum_member_name"><p><a name="XFCE-GTK-CHECK-MENU-ITEM:CAPS"></a>XFCE_GTK_CHECK_MENU_ITEM</p></td> |
| 1603 |
<td class="enum_member_description"> |
| 1604 |
<p>see <a href="/usr/share/gtk-doc/html/gtk3/GtkCheckMenuItem.html#GtkCheckMenuItem-struct"><span class="type">GtkCheckMenuItem</span></a></p> |
| 1605 |
</td> |
| 1606 |
<td class="enum_member_annotations"> </td> |
| 1607 |
</tr> |
| 1608 |
<tr> |
| 1609 |
<td class="enum_member_name"><p><a name="XFCE-GTK-RADIO-MENU-ITEM:CAPS"></a>XFCE_GTK_RADIO_MENU_ITEM</p></td> |
| 1610 |
<td class="enum_member_description"> |
| 1611 |
<p>see <a href="/usr/share/gtk-doc/html/gtk3/GtkRadioMenuItem.html#GtkRadioMenuItem-struct"><span class="type">GtkRadioMenuItem</span></a></p> |
| 1612 |
</td> |
| 1613 |
<td class="enum_member_annotations"> </td> |
| 1614 |
</tr> |
| 1615 |
</tbody> |
| 1616 |
</table></div> |
| 1617 |
</div> |
| 1618 |
</div> |
| 1619 |
<hr> |
| 1620 |
<div class="refsect2"> |
| 1621 |
<a name="XfceGtkActionEntry"></a><h3>XfceGtkActionEntry</h3> |
| 1622 |
<pre class="programlisting">typedef struct { |
| 1623 |
guint id; |
| 1624 |
const gchar *accel_path; |
| 1625 |
const gchar *default_accelerator; |
| 1626 |
|
| 1627 |
/* menu_item data is optional, only relevant if there exists a menu_item for that accelerator */ |
| 1628 |
XfceGtkMenuItem menu_item_type; |
| 1629 |
gchar *menu_item_label_text; |
| 1630 |
gchar *menu_item_tooltip_text; |
| 1631 |
const gchar *menu_item_icon_name; |
| 1632 |
|
| 1633 |
GCallback callback; |
| 1634 |
} XfceGtkActionEntry; |
| 1635 |
</pre> |
| 1636 |
<p>Replacement for the deprecated <a href="/usr/share/gtk-doc/html/gtk3/GtkActionGroup.html#GtkActionEntry"><span class="type">GtkActionEntry</span></a>. |
| 1637 |
The idea is to provide a fixed list of <a href="libxfce4ui-Gtk-Extensions.html#XfceGtkActionEntry"><span class="type">XfceGtkActionEntrys</span></a>:</p> |
| 1638 |
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| 1639 |
<li class="listitem"><p>use <a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-translate-action-entries" title="xfce_gtk_translate_action_entries ()"><code class="function">xfce_gtk_translate_action_entries()</code></a> once to translate the list</p></li> |
| 1640 |
<li class="listitem"><p>use <a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-accel-map-add-entries" title="xfce_gtk_accel_map_add_entries ()"><code class="function">xfce_gtk_accel_map_add_entries()</code></a> once to register the provided accelerators</p></li> |
| 1641 |
<li class="listitem"><p>use <a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-get-action-entry-by-id" title="xfce_gtk_get_action_entry_by_id ()"><code class="function">xfce_gtk_get_action_entry_by_id()</code></a> to find a single entry, e.g. by using a enumeration</p></li> |
| 1642 |
<li class="listitem"><p>use xfce_gtk_*_new_from_action_entry() to create the specific menu- or tool-items from the entry</p></li> |
| 1643 |
</ul></div> |
| 1644 |
<div class="refsect3"> |
| 1645 |
<a name="XfceGtkActionEntry.members"></a><h4>Members</h4> |
| 1646 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 1647 |
<colgroup> |
| 1648 |
<col width="300px" class="struct_members_name"> |
| 1649 |
<col class="struct_members_description"> |
| 1650 |
<col width="200px" class="struct_members_annotations"> |
| 1651 |
</colgroup> |
| 1652 |
<tbody> |
| 1653 |
<tr> |
| 1654 |
<td class="struct_member_name"><p><span class="type">guint</span> <em class="structfield"><code><a name="XfceGtkActionEntry.id"></a>id</code></em>;</p></td> |
| 1655 |
<td class="struct_member_description"><p>unique identifier for instances of this structure (you might want to use a enum)</p></td> |
| 1656 |
<td class="struct_member_annotations"> </td> |
| 1657 |
</tr> |
| 1658 |
<tr> |
| 1659 |
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="XfceGtkActionEntry.accel-path"></a>accel_path</code></em>;</p></td> |
| 1660 |
<td class="struct_member_description"><p>the unique path, used to identify the accelerator</p></td> |
| 1661 |
<td class="struct_member_annotations"> </td> |
| 1662 |
</tr> |
| 1663 |
<tr> |
| 1664 |
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="XfceGtkActionEntry.default-accelerator"></a>default_accelerator</code></em>;</p></td> |
| 1665 |
<td class="struct_member_description"><p>the default key and modifier to trigger the callback linked to the entry</p></td> |
| 1666 |
<td class="struct_member_annotations"> </td> |
| 1667 |
</tr> |
| 1668 |
<tr> |
| 1669 |
<td class="struct_member_name"><p><a class="link" href="libxfce4ui-Gtk-Extensions.html#XfceGtkMenuItem" title="enum XfceGtkMenuItem"><span class="type">XfceGtkMenuItem</span></a> <em class="structfield"><code><a name="XfceGtkActionEntry.menu-item-type"></a>menu_item_type</code></em>;</p></td> |
| 1670 |
<td class="struct_member_description"><p>the type of the item which should be used for creation</p></td> |
| 1671 |
<td class="struct_member_annotations"> </td> |
| 1672 |
</tr> |
| 1673 |
<tr> |
| 1674 |
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="XfceGtkActionEntry.menu-item-label-text"></a>menu_item_label_text</code></em>;</p></td> |
| 1675 |
<td class="struct_member_description"><p>text which should be shown in the menu</p></td> |
| 1676 |
<td class="struct_member_annotations"> </td> |
| 1677 |
</tr> |
| 1678 |
<tr> |
| 1679 |
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="XfceGtkActionEntry.menu-item-tooltip-text"></a>menu_item_tooltip_text</code></em>;</p></td> |
| 1680 |
<td class="struct_member_description"><p>optional tooltip of the item</p></td> |
| 1681 |
<td class="struct_member_annotations"> </td> |
| 1682 |
</tr> |
| 1683 |
<tr> |
| 1684 |
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="XfceGtkActionEntry.menu-item-icon-name"></a>menu_item_icon_name</code></em>;</p></td> |
| 1685 |
<td class="struct_member_description"><p>optional icon name which will be used to find a image for the item</p></td> |
| 1686 |
<td class="struct_member_annotations"> </td> |
| 1687 |
</tr> |
| 1688 |
<tr> |
| 1689 |
<td class="struct_member_name"><p><span class="type">GCallback</span> <em class="structfield"><code><a name="XfceGtkActionEntry.callback"></a>callback</code></em>;</p></td> |
| 1690 |
<td class="struct_member_description"><p>the callback which will be triggered on activation. The callback has to return <code class="literal">TRUE</code> |
| 1691 |
to signal that the accelerator was activated and handled</p></td> |
| 1692 |
<td class="struct_member_annotations"> </td> |
| 1693 |
</tr> |
| 1694 |
</tbody> |
| 1695 |
</table></div> |
| 1696 |
</div> |
| 1697 |
</div> |
| 1698 |
</div> |
| 1699 |
</div> |
| 1700 |
<div class="footer"> |
| 1701 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 1702 |
</body> |
| 1703 |
</html> |