Popover

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_popover_get_type ()" ) ]
[ Version ( since = "3.12" ) ]
public class Popover : Bin, Implementor, Buildable

GtkPopover is a bubble-like context window, primarily meant to provide context-dependent information or options.

Popovers are attached to a widget, passed at construction time on Popover , or updated afterwards through set_relative_to, by default they will point to the whole widget area, although this behavior can be changed through set_pointing_to.

The position of a popover relative to the widget it is attached to can also be changed through set_position.

By default, Popover performs a GTK+ grab, in order to ensure input events get redirected to it while it is shown, and also so the popover is dismissed in the expected situations (clicks outside the popover, or the Esc key being pressed). If no such modal behavior is desired on a popover, set_modal may be called on it to tweak its behavior.

GtkPopover as menu replacement

GtkPopover is often used to replace menus. To facilitate this, it supports being populated from a MenuModel, using Popover.from_model. In addition to all the regular menu model features, this function supports rendering sections in the model in a more compact form, as a row of icon buttons instead of menu items.

To use this rendering, set the ”display-hint” attribute of the section to ”horizontal-buttons” and set the icons of your items with the ”verb-icon” attribute.

<section>
  <attribute name="display-hint">horizontal-buttons</attribute>
  <item>
    <attribute name="label">Cut</attribute>
    <attribute name="action">app.cut</attribute>
    <attribute name="verb-icon">edit-cut-symbolic</attribute>
  </item>
  <item>
    <attribute name="label">Copy</attribute>
    <attribute name="action">app.copy</attribute>
    <attribute name="verb-icon">edit-copy-symbolic</attribute>
  </item>
  <item>
    <attribute name="label">Paste</attribute>
    <attribute name="action">app.paste</attribute>
    <attribute name="verb-icon">edit-paste-symbolic</attribute>
  </item>
</section>

CSS nodes

GtkPopover has a single css node called popover. It always gets the .background style class and it gets the .menu style class if it is menu-like (e.g. PopoverMenu or created using Popover.from_model.

Particular uses of GtkPopover, such as touch selection popups or magnifiers in Entry or TextView get style classes like .touch-selection or .magnifier to differentiate from plain popovers.

All known sub-classes:

PopoverMenu

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public PopoverConstraint constrain_to { get; set; }
Sets a constraint for the popover position.
public bool modal { get; set; }
Sets whether the popover is modal (so other elements in the window do not receive input while the popover is visible).
public Rectangle pointing_to { owned get; set; }
Marks a specific rectangle to be pointed.
public PositionType position { get; set; }
Sets the preferred position of the popover.
public Widget relative_to { get; set; }
Sets the attached widget.
public bool transitions_enabled { get; set; }
Whether show/hide transitions are enabled for this popover.

Creation methods:

public Popover (Widget? relative_to)
Creates a new popover to point to relative_to
public Popover.from_model (Widget? relative_to, MenuModel model)
Creates a Popover and populates it according to model.

Methods:

public void bind_model (MenuModel? model, string? action_namespace)
Establishes a binding between a Popover and a MenuModel.
public PopoverConstraint get_constrain_to ()
Returns the constraint for placing this popover.
public unowned Widget? get_default_widget ()
Gets the widget that should be set as the default while the popover is shown.
public bool get_modal ()
Returns whether the popover is modal, see gtk_popover_set_modal to see the implications of this.
public bool get_pointing_to (out Rectangle 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 width and height if a widget exists, otherwise it will zero-out rect.
public PositionType get_position ()
Returns the preferred position of this.
public unowned Widget get_relative_to ()
Returns the widget this is currently attached to
public bool get_transitions_enabled ()
Returns whether show/hide transitions are enabled on this popover.
public void popdown ()
Pops this down.
public void popup ()
Pops this up.
public void set_constrain_to (PopoverConstraint constraint)
Sets a constraint for positioning this popover.
public void set_default_widget (Widget? widget)
Sets the widget that should be set as default widget while the popover is shown (see set_default).
public void set_modal (bool modal)
Sets whether this is modal, a modal popover will grab all input within the toplevel and grab the keyboard focus on it when being displayed.
public void set_pointing_to (Rectangle rect)
Sets the rectangle that this will point to, in the coordinate space of the widget this is attached to, see set_relative_to.
public void set_position (PositionType position)
Sets the preferred position for this to appear.
public void set_relative_to (Widget? relative_to)
Sets a new widget to be attached to this.
public void set_transitions_enabled (bool transitions_enabled)
Sets whether show/hide transitions are enabled on this popover

Signals:

public virtual signal void closed ()
This signal is emitted when the popover is dismissed either through API or user interaction.

Inherited Members:

All known members inherited from class Gtk.Bin

get_child

All known members inherited from class Gtk.Container

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable