Class: Gtk::Popover

Inherits:
Widget
  • Object
show all
Defined in:
lib/gtk4/popover.rb

Direct Known Subclasses

EmojiChooser, PopoverMenu

Instance Method Summary collapse

Methods inherited from Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #children, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #error_bell, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Constructor Details

#initialize ⇒ Gtk::Widget

Creates a new GtkPopover.

Instance Method Details

#autohide ⇒ Boolean

Returns whether the popover is modal.

See [methodGtk.Popover.set_autohide] for the implications of this.

Returns:

  • (Boolean) —

    true if popover is modal

#autohide=(autohide) ⇒ Boolean

Whether to dismiss the popover on outside clicks.

Parameters:

  • autohide (Boolean)

Returns:

  • (Boolean) —

    autohide

  • (Boolean) —

    autohide

#autohide? ⇒ Boolean

Whether to dismiss the popover on outside clicks.

Returns:

  • (Boolean) —

    autohide

#cascade_popdown ⇒ Boolean

Returns whether the popover will close after a modal child is closed.

Returns:

  • (Boolean) —

    true if popover will close after a modal child.

#cascade_popdown=(cascade_popdown) ⇒ Boolean

Whether the popover pops down after a child popover.

This is used to implement the expected behavior of submenus.

Parameters:

  • cascade_popdown (Boolean)

Returns:

  • (Boolean) —

    cascade-popdown

  • (Boolean) —

    cascade-popdown

#cascade_popdown? ⇒ Boolean

Whether the popover pops down after a child popover.

This is used to implement the expected behavior of submenus.

Returns:

  • (Boolean) —

    cascade-popdown

#child ⇒ Gtk::Widget

The child widget.

Returns:

#child=(child) ⇒ Gtk::Widget

The child widget.

Parameters:

Returns:

#default_widget ⇒ Gtk::Widget

The default widget inside the popover.

Returns:

#default_widget=(default_widget) ⇒ Gtk::Widget

The default widget inside the popover.

Parameters:

Returns:

#get_offset(x_offset, y_offset) ⇒ nil

Gets the offset previous set with [methodGtk.Popover.set_offset()].

Parameters:

  • x_offset (Integer) —

    a location for the x_offset

  • y_offset (Integer) —

    a location for the y_offset

Returns:

  • (nil)

#get_pointing_to(rect) ⇒ Boolean

Gets the rectangle that the popover points to.

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 parent widget coordinates.

Parameters:

  • rect (Gdk::Rectangle) —

    location to store the rectangle

Returns:

  • (Boolean) —

    true if a rectangle to point to was set.

#has_arrow ⇒ Boolean

Gets whether this popover is showing an arrow pointing at the widget that it is relative to.

Returns:

  • (Boolean) —

    whether the popover has an arrow

#has_arrow=(has_arrow) ⇒ Boolean

Whether to draw an arrow.

Parameters:

  • has_arrow (Boolean)

Returns:

  • (Boolean) —

    has-arrow

  • (Boolean) —

    has-arrow

#has_arrow? ⇒ Boolean

Whether to draw an arrow.

Returns:

  • (Boolean) —

    has-arrow

#mnemonics_visible ⇒ Boolean

Gets whether mnemonics are visible.

Returns:

  • (Boolean) —

    true if mnemonics are supposed to be visible in this popover

#mnemonics_visible=(mnemonics_visible) ⇒ Boolean

Whether mnemonics are currently visible in this popover.

Parameters:

  • mnemonics_visible (Boolean)

Returns:

  • (Boolean) —

    mnemonics-visible

  • (Boolean) —

    mnemonics-visible

#mnemonics_visible? ⇒ Boolean

Whether mnemonics are currently visible in this popover.

Returns:

  • (Boolean) —

    mnemonics-visible

#pointing_to ⇒ Gdk::Rectangle

Rectangle in the parent widget that the popover points to.

Returns:

  • (Gdk::Rectangle) —

    pointing-to



20
21
22
23
24
25
26
27
 
# File 'lib/gtk4/popover.rb', line 20

def pointing_to
  have, rectangle = pointing_to_raw
  if have
    rectangle
  else
    nil
  end
end

#pointing_to=(pointing_to) ⇒ Gdk::Rectangle

Rectangle in the parent widget that the popover points to.

Parameters:

  • pointing_to (Gdk::Rectangle)

Returns:

  • (Gdk::Rectangle) —

    pointing-to

  • (Gdk::Rectangle) —

    pointing-to

#pointing_to_raw ⇒ Gdk::Rectangle

Rectangle in the parent widget that the popover points to.

Returns:

  • (Gdk::Rectangle) —

    pointing-to




# File 'lib/gtk4/popover.rb', line 19

#popdown ⇒ nil

Pops popover down.

This may have the side-effect of closing a parent popover as well. See [propertyGtk.Popover:cascade-popdown].

Returns:

  • (nil)

#popup ⇒ nil

Pops popover up.

Returns:

  • (nil)

#position ⇒ Gtk::PositionType

How to place the popover, relative to its parent.

Returns:

#position=(position) ⇒ Gtk::PositionType

How to place the popover, relative to its parent.

Parameters:

Returns:

#present ⇒ nil

Allocate a size for the GtkPopover.

This function needs to be called in size-allocate by widgets who have a GtkPopover as child. When using a layout manager, this is happening automatically.

To make a popover appear on screen, use [methodGtk.Popover.popup].

Returns:

  • (nil)

#set_offset(x_offset, y_offset) ⇒ nil

Sets the offset to use when calculating the position of the popover.

These values are used when preparing the [structGdk.PopupLayout] for positioning the popover.

Parameters:

  • x_offset (Integer) —

    the x offset to adjust the position by

  • y_offset (Integer) —

    the y offset to adjust the position by

Returns:

  • (nil)