Class: Gtk::Revealer

Inherits:
Widget
  • Object
show all
Extended by:
GLib::Deprecatable
Defined in:
lib/gtk4/deprecated.rb

Overview

A GtkRevealer animates the transition of its child from invisible to visible.

The style of transition can be controlled with [methodGtk.Revealer.set_transition_type].

These animations respect the [propertyGtk.Settings:gtk-enable-animations] setting.

CSS nodes

GtkRevealer has a single CSS node with name revealer. When styling GtkRevealer using CSS, remember that it only hides its contents, not itself. That means applied margin, padding and borders will be visible even when the [propertyGtk.Revealer:reveal-child] property is set to false.

Accessibility

GtkRevealer uses the %GTK_ACCESSIBLE_ROLE_GROUP role.

The child of GtkRevealer, if set, is always available in the accessibility tree, regardless of the state of the revealer widget.

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 GtkRevealer.

Instance Method Details

#child ⇒ Gtk::Widget

The child widget.

Returns:

#child=(child) ⇒ Gtk::Widget

The child widget.

Parameters:

Returns:

#child_revealed ⇒ Boolean

Returns whether the child is fully revealed.

In other words, this returns whether the transition to the revealed state is completed.

Returns:

  • (Boolean) —

    true if the child is fully revealed

#child_revealed=(child_revealed) ⇒ Boolean

Whether the child is revealed and the animation target reached.

Parameters:

  • child_revealed (Boolean)

Returns:

  • (Boolean) —

    child-revealed

  • (Boolean) —

    child-revealed

#child_revealed? ⇒ Boolean

Whether the child is revealed and the animation target reached.

Returns:

  • (Boolean) —

    child-revealed

#reveal_child ⇒ Boolean

Returns whether the child is currently revealed.

This function returns true as soon as the transition is to the revealed state is started. To learn whether the child is fully revealed (ie the transition is completed), use [methodGtk.Revealer.get_child_revealed].

Returns:

  • (Boolean) —

    true if the child is revealed.

#reveal_child=(reveal_child) ⇒ Boolean

Whether the revealer should reveal the child.

Parameters:

  • reveal_child (Boolean)

Returns:

  • (Boolean) —

    reveal-child

  • (Boolean) —

    reveal-child

#reveal_child? ⇒ Boolean

Whether the revealer should reveal the child.

Returns:

  • (Boolean) —

    reveal-child

#transition_duration ⇒ Integer

The animation duration, in milliseconds.

Returns:

  • (Integer) —

    transition-duration

#transition_duration=(transition_duration) ⇒ Integer

The animation duration, in milliseconds.

Parameters:

  • transition_duration (Integer)

Returns:

  • (Integer) —

    transition-duration

  • (Integer) —

    transition-duration

#transition_type ⇒ Gtk::RevealerTransitionType

The type of animation used to transition.

Returns:

#transition_type=(transition_type) ⇒ Gtk::RevealerTransitionType

The type of animation used to transition.

Parameters:

Returns: