PopoverMenu

GtkPopoverMenu is a subclass of #GtkPopover that treats its children like menus and allows switching between them. It is meant to be used primarily together with #GtkModelButton, but any widget can be used, such as #GtkSpinButton or #GtkScale. In this respect, GtkPopoverMenu is more flexible than popovers that are created from a #GMenuModel with gtk_popover_new_from_model().

To add a child as a submenu, set the #GtkPopoverMenu:submenu child property to the name of the submenu. To let the user open this submenu, add a #GtkModelButton whose #GtkModelButton:menu-name property is set to the name you've given to the submenu.

By convention, the first child of a submenu should be a #GtkModelButton to switch back to the parent menu. Such a button should use the #GtkModelButton:inverted and #GtkModelButton:centered properties to achieve a title-like appearance and place the submenu indicator at the opposite side. To switch back to the main menu, use "main" as the menu name.

Example

|[ <object class="GtkPopoverMenu"> <child> <object class="GtkBox"> <property name="visible">True</property> <property name="margin">10</property> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="action-name">win.frob</property> <property name="text" translatable="yes">Frob</property> </object> </child> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="menu-name">more</property> <property name="text" translatable="yes">More</property> </object> </child> </object> </child> <child> <object class="GtkBox"> <property name="visible">True</property> <property name="margin">10</property> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="action-name">win.foo</property> <property name="text" translatable="yes">Foo</property> </object> </child> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="action-name">win.bar</property> <property name="text" translatable="yes">Bar</property> </object> </child> </object> <packing> <property name="submenu">more</property> </packing> </child> </object> ]|

Just like normal popovers created using gtk_popover_new_from_model, #GtkPopoverMenu instances have a single css node called "popover" and get the .menu style class.

Constructors

this
this(GtkPopoverMenu* gtkPopoverMenu, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new popover menu.

Members

Functions

getPopoverMenuStruct
GtkPopoverMenu* getPopoverMenuStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

openSubmenu
void openSubmenu(string name)

Opens a submenu of the @popover. The @name must be one of the names given to the submenus of @popover with #GtkPopoverMenu:submenu, or "main" to switch back to the main menu.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

getType
GType getType()

Variables

gtkPopoverMenu
GtkPopoverMenu* gtkPopoverMenu;

the main Gtk struct

Inherited Members

From Popover

gtkPopover
GtkPopover* gtkPopover;

the main Gtk struct

getPopoverStruct
GtkPopover* getPopoverStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
getType
GType getType()
bindModel
void bindModel(MenuModel model, string actionNamespace)

Establishes a binding between a #GtkPopover and a #GMenuModel.

getConstrainTo
GtkPopoverConstraint getConstrainTo()

Returns the constraint for placing this popover. See gtk_popover_set_constrain_to().

getDefaultWidget
Widget getDefaultWidget()

Gets the widget that should be set as the default while the popover is shown.

getModal
bool getModal()

Returns whether the popover is modal, see gtk_popover_set_modal to see the implications of this.

getPointingTo
bool getPointingTo(GdkRectangle rect)

If a rectangle to point to has been set, this function will return %TRUE and fill in @rect with such rectangle, otherwise it will return %FALSE and fill in @rect with the attached widget coordinates.

getPosition
GtkPositionType getPosition()

Returns the preferred position of @popover.

getRelativeTo
Widget getRelativeTo()

Returns the widget @popover is currently attached to

getTransitionsEnabled
bool getTransitionsEnabled()

Returns whether show/hide transitions are enabled on this popover.

popdown
void popdown()

Pops @popover down.This is different than a gtk_widget_hide() call in that it shows the popover with a transition. If you want to hide the popover without a transition, use gtk_widget_hide().

popup
void popup()

Pops @popover up. This is different than a gtk_widget_show() call in that it shows the popover with a transition. If you want to show the popover without a transition, use gtk_widget_show().

setConstrainTo
void setConstrainTo(GtkPopoverConstraint constraint)

Sets a constraint for positioning this popover.

setDefaultWidget
void setDefaultWidget(Widget widget)

Sets the widget that should be set as default widget while the popover is shown (see gtk_window_set_default()). #GtkPopover remembers the previous default widget and reestablishes it when the popover is dismissed.

setModal
void setModal(bool modal)

Sets whether @popover is modal, a modal popover will grab all input within the toplevel and grab the keyboard focus on it when being displayed. Clicking outside the popover area or pressing Esc will dismiss the popover and ungrab input.

setPointingTo
void setPointingTo(GdkRectangle* rect)

Sets the rectangle that @popover will point to, in the coordinate space of the widget @popover is attached to, see gtk_popover_set_relative_to().

setPosition
void setPosition(GtkPositionType position)

Sets the preferred position for @popover to appear. If the @popover is currently visible, it will be immediately updated.

setRelativeTo
void setRelativeTo(Widget relativeTo)

Sets a new widget to be attached to @popover. If @popover is visible, the position will be updated.

setTransitionsEnabled
void setTransitionsEnabled(bool transitionsEnabled)

Sets whether show/hide transitions are enabled on this popover

OnClosedDelegateWrapper
class OnClosedDelegateWrapper
Undocumented in source.
onClosedListeners
OnClosedDelegateWrapper[] onClosedListeners;
Undocumented in source.
addOnClosed
gulong addOnClosed(void delegate(Popover) dlg, ConnectFlags connectFlags)
callBackClosed
void callBackClosed(GtkPopover* popoverStruct, OnClosedDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackClosedDestroy
void callBackClosedDestroy(OnClosedDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta