Popover

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_popover_get_type ()" ) ]
public class Popover : Widget, Accessible, Buildable, ConstraintTarget, Native, ShortcutManager

`GtkPopover` is a bubble-like context popup.

![An example GtkPopover](popover.png)

It is primarily meant to provide context-dependent information or options. Popovers are attached to a parent widget. By default, they point to the whole widget area, although this behavior can be changed with [method@Gtk.Popover.set_pointing_to].

The position of a popover relative to the widget it is attached to can also be changed with [method@Gtk.Popover.set_position]

By default, `GtkPopover` performs a 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 Escape key being pressed). If no such modal behavior is desired on a popover, [method@Gtk.Popover.set_autohide] may be called on it to tweak its behavior.

GtkPopover as menu replacement

`GtkPopover` is often used to replace menus. The best was to do this is to use the [class@Gtk.PopoverMenu] subclass which supports being populated from a `GMenuModel` with [ctor@Gtk.PopoverMenu.new_from_model].

```xml <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

``` popover.background[.menu] ├── arrow ╰── contents ╰── <child> ```

`GtkPopover` has a main node with name `popover`, an arrow with name `arrow`, and another node for the content named `contents`. The `popover` node always gets the `.background` style class. It also gets the `.menu` style class if the popover is menu-like, e.g. is a [ class@Gtk.PopoverMenu].

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

When styling a popover directly, the `popover` node should usually not have any background. The visible part of the popover can have a shadow. To specify it in CSS, set the box-shadow of the `contents` node.

Note that, in order to accomplish appropriate arrow visuals, `GtkPopover` uses custom drawing for the `arrow` node. This makes it possible for the arrow to change its shape dynamically, but it also limits the possibilities of styling it using CSS. In particular, the `arrow` gets drawn over the `content` node's border and shadow, so they look like one shape, which means that the border width of the `content` node and the `arrow` node should be the same. The arrow also does not support any border shape other than solid, no border-radius, only one border width ( border-bottom-width is used) and no box-shadow.

All known sub-classes:

EmojiChooser

PopoverMenu

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool autohide { get; set; }
Whether to dismiss the popover on outside clicks.
public bool cascade_popdown { get; set; }
Whether the popover pops down after a child popover.
public Widget child { get; set; }
The child widget.
public Widget default_widget { owned get; set; }
The default widget inside the popover.
public bool has_arrow { get; set; }
Whether to draw an arrow.
public bool mnemonics_visible { get; set; }
Whether mnemonics are currently visible in this popover.
public Rectangle pointing_to { owned get; set; }
Rectangle in the parent widget that the popover points to.
public PositionType position { get; set; }
How to place the popover, relative to its parent.

Creation methods:

public Popover ()
Creates a new `GtkPopover`.

Methods:

public bool get_autohide ()
Returns whether the popover is modal.
public bool get_cascade_popdown ()
Returns whether the popover will close after a modal child is closed.
public unowned Widget? get_child ()
Gets the child widget of this.
public bool get_has_arrow ()
Gets whether this popover is showing an arrow pointing at the widget that it is relative to.
public bool get_mnemonics_visible ()
Gets whether mnemonics are visible.
public void get_offset (out int x_offset, out int y_offset)
Gets the offset previous set with [method@Gtk.
public bool get_pointing_to (out Rectangle rect)
Gets the rectangle that the popover points to.
public PositionType get_position ()
Returns the preferred position of this.
public void popdown ()
Pops this down.
public void popup ()
Pops this up.
public void present ()
Allocate a size for the `GtkPopover`.
public void set_autohide (bool autohide)
Sets whether this is modal.
public void set_cascade_popdown (bool cascade_popdown)
If cascade_popdown is true, the popover will be closed when a child modal popover is closed.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_default_widget (Widget? widget)
Sets the default widget of a `GtkPopover`.
public void set_has_arrow (bool has_arrow)
Sets whether this popover should draw an arrow pointing at the widget it is relative to.
public void set_mnemonics_visible (bool mnemonics_visible)
Sets whether mnemonics should be visible.
public void set_offset (int x_offset, int y_offset)
Sets the offset to use when calculating the position of the popover.
public void set_pointing_to (Rectangle? rect)
Sets the rectangle that this points to.
public void set_position (PositionType position)
Sets the preferred position for this to appear.

Signals:

public virtual signal void activate_default ()
Emitted whend the user activates the default widget.
public virtual signal void closed ()
Emitted when the popover is closed.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Native

All known members inherited from interface Gtk.ShortcutManager

add_controller

remove_controller