dbusmenu-gtk3 0.1.0

Rust bindings to dbusmenu-gtk3
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
<!-- file * -->
<!-- struct Client -->
A subclass of [`dbusmenu_glib::Client`][crate::dbusmenu_glib::Client] to add functionality with regarding
building GTK items out of the abstract tree.

# Implements

[`ClientExt`][trait@crate::prelude::ClientExt], [`trait@dbusmenu_glib::prelude::ClientExt`]
<!-- struct Menu -->
A [`gtk::Menu`][crate::gtk::Menu] that is built using an abstract tree built from
a [`Client`][crate::Client].

## Properties


#### `dbus-name`
 Readable | Writeable | Construct Only


#### `dbus-object`
 Readable | Writeable | Construct Only
<details><summary><h4>Menu</h4></summary>


#### `accel-group`
 The accel group holding accelerators for the menu.

Readable | Writeable


#### `accel-path`
 An accel path used to conveniently construct accel paths of child items.

Readable | Writeable


#### `active`
 The index of the currently selected menu item, or -1 if no
menu item is selected.

Readable | Writeable


#### `anchor-hints`
 Positioning hints for aligning the menu relative to a rectangle.

These hints determine how the menu should be positioned in the case that
the menu would fall off-screen if placed in its ideal position.

![](popup-flip.png)

For example, `GDK_ANCHOR_FLIP_Y` will replace `GDK_GRAVITY_NORTH_WEST` with
`GDK_GRAVITY_SOUTH_WEST` and vice versa if the menu extends beyond the
bottom edge of the monitor.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (),
gtk_menu_popup_at_pointer (), [`rect-anchor-dx`][struct@crate::gtk::Menu#rect-anchor-dx],
[`rect-anchor-dy`][struct@crate::gtk::Menu#rect-anchor-dy], [`menu-type-hint`][struct@crate::gtk::Menu#menu-type-hint], and [`popped-up`][struct@crate::gtk::Menu#popped-up].

Readable | Writeable | Construct


#### `attach-widget`
 The widget the menu is attached to. Setting this property attaches
the menu without a `GtkMenuDetachFunc`. If you need to use a detacher,
use [`MenuExtManual::attach_to_widget()`][crate::gtk::prelude::MenuExtManual::attach_to_widget()] directly.

Readable | Writeable


#### `menu-type-hint`
 The `GdkWindowTypeHint` to use for the menu's `GdkWindow`.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (),
gtk_menu_popup_at_pointer (), [`anchor-hints`][struct@crate::gtk::Menu#anchor-hints],
[`rect-anchor-dx`][struct@crate::gtk::Menu#rect-anchor-dx], [`rect-anchor-dy`][struct@crate::gtk::Menu#rect-anchor-dy], and [`popped-up`][struct@crate::gtk::Menu#popped-up].

Readable | Writeable | Construct


#### `monitor`
 The monitor the menu will be popped up on.

Readable | Writeable


#### `rect-anchor-dx`
 Horizontal offset to apply to the menu, i.e. the rectangle or widget
anchor.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (),
gtk_menu_popup_at_pointer (), [`anchor-hints`][struct@crate::gtk::Menu#anchor-hints],
[`rect-anchor-dy`][struct@crate::gtk::Menu#rect-anchor-dy], [`menu-type-hint`][struct@crate::gtk::Menu#menu-type-hint], and [`popped-up`][struct@crate::gtk::Menu#popped-up].

Readable | Writeable | Construct


#### `rect-anchor-dy`
 Vertical offset to apply to the menu, i.e. the rectangle or widget anchor.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (),
gtk_menu_popup_at_pointer (), [`anchor-hints`][struct@crate::gtk::Menu#anchor-hints],
[`rect-anchor-dx`][struct@crate::gtk::Menu#rect-anchor-dx], [`menu-type-hint`][struct@crate::gtk::Menu#menu-type-hint], and [`popped-up`][struct@crate::gtk::Menu#popped-up].

Readable | Writeable | Construct


#### `reserve-toggle-size`
 A boolean that indicates whether the menu reserves space for
toggles and icons, regardless of their actual presence.

This property should only be changed from its default value
for special-purposes such as tabular menus. Regular menus that
are connected to a menu bar or context menus should reserve
toggle space for consistency.

Readable | Writeable


#### `tearoff-state`
 A boolean that indicates whether the menu is torn-off.

Readable | Writeable


#### `tearoff-title`
 A title that may be displayed by the window manager when this
menu is torn-off.

Readable | Writeable
</details>
<details><summary><h4>MenuShell</h4></summary>


#### `take-focus`
 A boolean that determines whether the menu and its submenus grab the
keyboard focus. See [`MenuShellExtManual::set_take_focus()`][crate::gtk::prelude::MenuShellExtManual::set_take_focus()] and
[`MenuShellExtManual::takes_focus()`][crate::gtk::prelude::MenuShellExtManual::takes_focus()].

Readable | Writeable
</details>
<details><summary><h4>Container</h4></summary>


#### `border-width`
 Readable | Writeable


#### `child`
 Writeable


#### `resize-mode`
 Readable | Writeable
</details>
<details><summary><h4>Widget</h4></summary>


#### `app-paintable`
 Readable | Writeable


#### `can-default`
 Readable | Writeable


#### `can-focus`
 Readable | Writeable


#### `composite-child`
 Readable


#### `double-buffered`
 Whether the widget is double buffered.

Readable | Writeable


#### `events`
 Readable | Writeable


#### `expand`
 Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::gtk::Widget#hexpand] and [`vexpand`][struct@crate::gtk::Widget#vexpand]

Readable | Writeable


#### `focus-on-click`
 Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
GtkComboBox) implemented this property individually.

Readable | Writeable


#### `halign`
 How to distribute horizontal space if widget gets extra space, see `GtkAlign`

Readable | Writeable


#### `has-default`
 Readable | Writeable


#### `has-focus`
 Readable | Writeable


#### `has-tooltip`
 Enables or disables the emission of [`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] on `widget`.
A value of [`true`] indicates that `widget` can have a tooltip, in this case
the widget will be queried using [`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] to determine
whether it will provide a tooltip or not.

Note that setting this property to [`true`] for the first time will change
the event masks of the GdkWindows of this widget to include leave-notify
and motion-notify events. This cannot and will not be undone when the
property is set to [`false`] again.

Readable | Writeable


#### `height-request`
 Readable | Writeable


#### `hexpand`
 Whether to expand horizontally. See [`WidgetExtManual::set_hexpand()`][crate::gtk::prelude::WidgetExtManual::set_hexpand()].

Readable | Writeable


#### `hexpand-set`
 Whether to use the [`hexpand`][struct@crate::gtk::Widget#hexpand] property. See [`WidgetExtManual::is_hexpand_set()`][crate::gtk::prelude::WidgetExtManual::is_hexpand_set()].

Readable | Writeable


#### `is-focus`
 Readable | Writeable


#### `margin`
 Sets all four sides' margin at once. If read, returns max
margin on any side.

Readable | Writeable


#### `margin-bottom`
 Margin on bottom side of widget.

This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
[`WidgetExtManual::set_size_request()`][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable


#### `margin-end`
 Margin on end of widget, horizontally. This property supports
left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
[`WidgetExtManual::set_size_request()`][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable


#### `margin-left`
 Margin on left side of widget.

This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
[`WidgetExtManual::set_size_request()`][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable


#### `margin-right`
 Margin on right side of widget.

This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
[`WidgetExtManual::set_size_request()`][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable


#### `margin-start`
 Margin on start of widget, horizontally. This property supports
left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
[`WidgetExtManual::set_size_request()`][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable


#### `margin-top`
 Margin on top side of widget.

This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
[`WidgetExtManual::set_size_request()`][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable


#### `name`
 Readable | Writeable


#### `no-show-all`
 Readable | Writeable


#### `opacity`
 The requested opacity of the widget. See [`WidgetExtManual::set_opacity()`][crate::gtk::prelude::WidgetExtManual::set_opacity()] for
more details about window opacity.

Before 3.8 this was only available in GtkWindow

Readable | Writeable


#### `parent`
 Readable | Writeable


#### `receives-default`
 Readable | Writeable


#### `scale-factor`
 The scale factor of the widget. See [`WidgetExtManual::scale_factor()`][crate::gtk::prelude::WidgetExtManual::scale_factor()] for
more details about widget scaling.

Readable


#### `sensitive`
 Readable | Writeable


#### `style`
 The style of the widget, which contains information about how it will look (colors, etc).

Readable | Writeable


#### `tooltip-markup`
 Sets the text of tooltip to be the given string, which is marked up
with the [Pango text markup language][PangoMarkupFormat].
Also see `gtk_tooltip_set_markup()`.

This is a convenience property which will take care of getting the
tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::gtk::Widget#has-tooltip]
will automatically be set to [`true`] and there will be taken care of
[`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] in the default signal handler.

Note that if both [`tooltip-text`][struct@crate::gtk::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::gtk::Widget#tooltip-markup]
are set, the last one wins.

Readable | Writeable


#### `tooltip-text`
 Sets the text of tooltip to be the given string.

Also see `gtk_tooltip_set_text()`.

This is a convenience property which will take care of getting the
tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::gtk::Widget#has-tooltip]
will automatically be set to [`true`] and there will be taken care of
[`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] in the default signal handler.

Note that if both [`tooltip-text`][struct@crate::gtk::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::gtk::Widget#tooltip-markup]
are set, the last one wins.

Readable | Writeable


#### `valign`
 How to distribute vertical space if widget gets extra space, see `GtkAlign`

Readable | Writeable


#### `vexpand`
 Whether to expand vertically. See [`WidgetExtManual::set_vexpand()`][crate::gtk::prelude::WidgetExtManual::set_vexpand()].

Readable | Writeable


#### `vexpand-set`
 Whether to use the [`vexpand`][struct@crate::gtk::Widget#vexpand] property. See [`WidgetExtManual::is_vexpand_set()`][crate::gtk::prelude::WidgetExtManual::is_vexpand_set()].

Readable | Writeable


#### `visible`
 Readable | Writeable


#### `width-request`
 Readable | Writeable


#### `window`
 The widget's window if it is realized, [`None`] otherwise.

Readable
</details>

# Implements

[`MenuExt`][trait@crate::prelude::MenuExt], [`trait@gtk::prelude::MenuExt`], [`trait@gtk::prelude::MenuShellExt`], [`trait@gtk::prelude::ContainerExt`], [`trait@gtk::prelude::WidgetExt`], [`trait@glib::InitiallyUnownedExt`], [`trait@atk::prelude::ImplementorIfaceExt`], [`trait@gtk::prelude::BuildableExt`]