Struct gtk4::Revealer

#[repr(transparent)]
pub struct Revealer { /* private fields */ }

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

The style of transition can be controlled with set_transition_type().

These animations respect the gtk-enable-animations setting.

CSS nodes

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

Accessibility

Revealer uses the AccessibleRole::Group role.

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

Properties

child

The child widget.

Readable | Writeable

child-revealed

Whether the child is revealed and the animation target reached.

Readable

reveal-child

Whether the revealer should reveal the child.

Readable | Writeable | Construct

transition-duration

The animation duration, in milliseconds.

Readable | Writeable | Construct

transition-type

The type of animation used to transition.

Readable | Writeable | Construct

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Revealer

pub fn new() -> Revealer

Creates a new Revealer.

Returns

a newly created Revealer

pub fn builder() -> RevealerBuilder

Creates a new builder-pattern struct instance to construct Revealer objects.

This method returns an instance of RevealerBuilder which can be used to create Revealer objects.

pub fn child(&self) -> Option<Widget>

Gets the child widget of @self.

Returns

the child widget of @self

pub fn is_child_revealed(&self) -> bool

Returns whether the child is fully revealed.

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

Returns

true if the child is fully revealed

pub fn reveals_child(&self) -> bool

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 is_child_revealed().

Returns

true if the child is revealed.

pub fn transition_duration(&self) -> u32

Returns the amount of time (in milliseconds) that transitions will take.

Returns

the transition duration

pub fn transition_type(&self) -> RevealerTransitionType

Gets the type of animation that will be used for transitions in @self.

Returns

the current transition type of @self

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

Sets the child widget of @self.

child

the child widget

pub fn set_reveal_child(&self, reveal_child: bool)

Tells the Revealer to reveal or conceal its child.

The transition will be animated with the current transition type of @self.

reveal_child

true to reveal the child

pub fn set_transition_duration(&self, duration: u32)

Sets the duration that transitions will take.

duration

the new duration, in milliseconds

pub fn set_transition_type(&self, transition: RevealerTransitionType)

Sets the type of animation that will be used for transitions in @self.

Available types include various kinds of fades and slides.

transition

the new transition type

pub fn connect_child_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_child_revealed_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reveal_child_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_transition_duration_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_transition_type_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for Revealer

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Revealer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Revealer

fn default() -> Self

Returns the “default value” for a type.

impl Display for Revealer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Revealer

type ParamSpec = ParamSpecObject

type SetValue = Revealer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Revealer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Revealer

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Revealer

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Revealer

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Revealer

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Revealer

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Revealer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Revealer

impl IsA<Accessible> for Revealer

impl IsA<Buildable> for Revealer

impl IsA<ConstraintTarget> for Revealer

impl IsA<Widget> for Revealer