Gtk.Revealer

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Bin Gtk.Bin Gtk.Revealer Gtk.Revealer Gtk.Bin->Gtk.Revealer Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget->Gtk.Container

Subclasses:None

Properties

Inherited:Gtk.Container (3), Gtk.Widget (39)
Name Type Flags Short Description
child-revealed bool r Whether the child is revealed and the animation target reached
reveal-child bool r/w/c/en Whether the container should reveal the child
transition-duration int r/w/c/en The animation duration, in milliseconds
transition-type Gtk.RevealerTransitionType r/w/c/en The type of animation used to transition

Style Properties

Inherited:Gtk.Widget (17)

Fields

Inherited:Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)
Name Type Access Description
parent_instance Gtk.Bin r  

Class Details

class Gtk.Revealer(**kwargs)
Bases:Gtk.Bin
Abstract:No
Structure:Gtk.RevealerClass

The Gtk.Revealer widget is a container which animates the transition of its child from invisible to visible.

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

These animations respect the Gtk.Settings :gtk-enable-animations setting.

CSS nodes

Gtk.Revealer has a single CSS node with name revealer.

The Gtk.Revealer widget was added in GTK+ 3.10.

classmethod new()[source]
Returns:a newly created Gtk.Revealer
Return type:Gtk.Widget

Creates a new Gtk.Revealer.

New in version 3.10.

get_child_revealed()[source]
Returns:True if the child is fully revealed
Return type:bool

Returns whether the child is fully revealed, in other words whether the transition to the revealed state is completed.

New in version 3.10.

get_reveal_child()[source]
Returns:True if the child is revealed.
Return type:bool

Returns whether the child is currently revealed. See Gtk.Revealer.set_reveal_child().

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 Gtk.Revealer.get_child_revealed().

New in version 3.10.

get_transition_duration()[source]
Returns:the transition duration
Return type:int

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

New in version 3.10.

get_transition_type()[source]
Returns:the current transition type of self
Return type:Gtk.RevealerTransitionType

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

New in version 3.10.

set_reveal_child(reveal_child)[source]
Parameters:reveal_child (bool) – True to reveal the child

Tells the Gtk.Revealer to reveal or conceal its child.

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

New in version 3.10.

set_transition_duration(duration)[source]
Parameters:duration (int) – the new duration, in milliseconds

Sets the duration that transitions will take.

New in version 3.10.

set_transition_type(transition)[source]
Parameters:transition (Gtk.RevealerTransitionType) – the new transition type

Sets the type of animation that will be used for transitions in self. Available types include various kinds of fades and slides.

New in version 3.10.

Property Details

Gtk.Revealer.props.child_revealed
Name:child-revealed
Type:bool
Default Value:False
Flags:READABLE

Whether the child is revealed and the animation target reached

Gtk.Revealer.props.reveal_child
Name:reveal-child
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether the container should reveal the child

Gtk.Revealer.props.transition_duration
Name:transition-duration
Type:int
Default Value:250
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

The animation duration, in milliseconds

Gtk.Revealer.props.transition_type
Name:transition-type
Type:Gtk.RevealerTransitionType
Default Value:Gtk.RevealerTransitionType.SLIDE_DOWN
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

The type of animation used to transition