Dazzle.DockRevealer¶

Subclasses:: Dazzle.DockBinEdge

Methods¶

Inherited:: Dazzle.Bin (1), Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` ()
	`animate_to_position` (position, transition_duration)
	`get_child_revealed` ()
	`get_position` ()
	`get_position_set` ()
	`get_reveal_child` ()
	`get_transition_duration` ()
	`get_transition_type` ()
	`is_animating` ()
	`set_position` (position)
	`set_position_set` (position_set)
	`set_reveal_child` (reveal_child)
	`set_transition_duration` (transition_duration)
	`set_transition_type` (transition_type)

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties¶

Inherited:: Gtk.Container (3), Gtk.Widget (39)

Name	Type	Flags	Short Description
`child-revealed`	`bool`	r	If the child is fully revealed
`position`	`int`	r/w/en	Position
`position-set`	`bool`	r/w/en	If the position has been set
`reveal-child`	`bool`	r/w/en	If the child should be revealed
`transition-duration`	`int`	r/w/en	Length of duration in milliseconds
`transition-type`	`Dazzle.DockRevealerTransitionType`	r/w/en	Transition Type

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Dazzle.Bin`	r

Class Details¶

class Dazzle.DockRevealer(**kwargs)¶

Bases:: Dazzle.Bin
Abstract:: No
Structure:: Dazzle.DockRevealerClass

This widget is a bit like Gtk.Revealer with a couple of important differences. First, it only supports a couple transition types (the direction to slide reveal). Additionally, the size of the child allocation will not change during the animation. This is not as generally useful as an upstream GTK+ widget, but is extremely important for the panel case to avoid things looking strange while animating into and out of view.

classmethod new()¶

Return type:: Gtk.Widget

animate_to_position(position, transition_duration)¶

Parameters:

position (int) –
transition_duration (int) –

get_child_revealed()¶

Return type:: bool

get_position()¶

Return type:: int

get_position_set()¶

Return type:: bool

get_reveal_child()¶

Return type:: bool

get_transition_duration()¶

Return type:: int

get_transition_type()¶

Return type:: Dazzle.DockRevealerTransitionType

is_animating()¶

Returns:: True if an animation is in progress.
Return type:: bool

This is a helper to check if the revealer is animating. You probably don’t want to poll this function. Connect to notify::child-revealed or notify::reveal-child instead.

set_position(position)¶

Parameters:: position (int) –

set_position_set(position_set)¶

Parameters:: position_set (bool) –

set_reveal_child(reveal_child)¶

Parameters:: reveal_child (bool) –

set_transition_duration(transition_duration)¶

Parameters:: transition_duration (int) –

set_transition_type(transition_type)¶

Parameters:: transition_type (Dazzle.DockRevealerTransitionType) –

Property Details¶

Dazzle.DockRevealer.props.child_revealed¶

Name:: child-revealed
Type:: bool
Default Value:: True
Flags:: READABLE

If the child is fully revealed

Dazzle.DockRevealer.props.position¶

Name:: position
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Position

Dazzle.DockRevealer.props.position_set¶

Name:: position-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If the position has been set

Dazzle.DockRevealer.props.reveal_child¶

Name:: reveal-child
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If the child should be revealed

Dazzle.DockRevealer.props.transition_duration¶

Name:: transition-duration
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Length of duration in milliseconds

Dazzle.DockRevealer.props.transition_type¶

Name:: transition-type
Type:: Dazzle.DockRevealerTransitionType
Default Value:: Dazzle.DockRevealerTransitionType.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Transition Type