Class: Handy::Flap

Inherits:
Gtk::Container
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Gtk::Widget

Creates a new HdyFlap.

Instance Method Details

#content ⇒ Gtk::Widget

The content widget.

It's always displayed when unfolded, and partially visible when folded.

Returns:

  • (Gtk::Widget) —

    content

#content=(content) ⇒ Gtk::Widget

The content widget.

It's always displayed when unfolded, and partially visible when folded.

Parameters:

  • content (Gtk::Widget)

Returns:

  • (Gtk::Widget) —

    content

  • (Gtk::Widget) —

    content

#flap ⇒ Gtk::Widget

The flap widget.

It's only visible when [propertyFlap:reveal-progress] is greater than 0.

Returns:

  • (Gtk::Widget) —

    flap

#flap=(flap) ⇒ Gtk::Widget

The flap widget.

It's only visible when [propertyFlap:reveal-progress] is greater than 0.

Parameters:

  • flap (Gtk::Widget)

Returns:

  • (Gtk::Widget) —

    flap

  • (Gtk::Widget) —

    flap

#flap_position ⇒ Gtk::PackType

The flap position.

If GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it's displayed after the content.

Returns:

  • (Gtk::PackType) —

    flap-position

#flap_position=(flap_position) ⇒ Gtk::PackType

The flap position.

If GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it's displayed after the content.

Parameters:

  • flap_position (Gtk::PackType)

Returns:

  • (Gtk::PackType) —

    flap-position

  • (Gtk::PackType) —

    flap-position

#fold_duration ⇒ Integer

The fold transition animation duration, in milliseconds.

Returns:

  • (Integer) —

    fold-duration

#fold_duration=(fold_duration) ⇒ Integer

The fold transition animation duration, in milliseconds.

Parameters:

  • fold_duration (Integer)

Returns:

  • (Integer) —

    fold-duration

  • (Integer) —

    fold-duration

#fold_policy ⇒ Handy::FlapFoldPolicy

The current fold policy.

See [enumFlapFoldPolicy] for available policies.

Returns:

#fold_policy=(fold_policy) ⇒ Handy::FlapFoldPolicy

The current fold policy.

See [enumFlapFoldPolicy] for available policies.

Parameters:

Returns:

#folded ⇒ Boolean

Gets whether self is currently folded.

Returns:

  • (Boolean) —

    TRUE if self is currently folded

#folded=(folded) ⇒ Boolean

Whether the flap is currently folded.

See [propertyFlap:fold-policy].

Parameters:

  • folded (Boolean)

Returns:

  • (Boolean) —

    folded

  • (Boolean) —

    folded

#folded? ⇒ Boolean

Whether the flap is currently folded.

See [propertyFlap:fold-policy].

Returns:

  • (Boolean) —

    folded

#locked ⇒ Boolean

Gets whether self is locked.

Returns:

  • (Boolean) —

    whether self is locked

#locked=(locked) ⇒ Boolean

Whether the flap is locked.

If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, [propertyFlap:reveal-flap] value never changes on its own.

Parameters:

  • locked (Boolean)

Returns:

  • (Boolean) —

    locked

  • (Boolean) —

    locked

#locked? ⇒ Boolean

Whether the flap is locked.

If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, [propertyFlap:reveal-flap] value never changes on its own.

Returns:

  • (Boolean) —

    locked

#modal ⇒ Boolean

Gets whether the self is modal.

Returns:

  • (Boolean) —

    whether self is modal

#modal=(modal) ⇒ Boolean

Whether the flap is modal.

If TRUE, clicking the content widget while flap is revealed, as well as pressing the Esc key, will close the flap. If FALSE, clicks are passed through to the content widget.

Parameters:

  • modal (Boolean)

Returns:

  • (Boolean) —

    modal

  • (Boolean) —

    modal

#modal? ⇒ Boolean

Whether the flap is modal.

If TRUE, clicking the content widget while flap is revealed, as well as pressing the Esc key, will close the flap. If FALSE, clicks are passed through to the content widget.

Returns:

  • (Boolean) —

    modal

#reveal_duration ⇒ Integer

The reveal transition animation duration, in milliseconds.

Returns:

  • (Integer) —

    reveal-duration

#reveal_duration=(reveal_duration) ⇒ Integer

The reveal transition animation duration, in milliseconds.

Parameters:

  • reveal_duration (Integer)

Returns:

  • (Integer) —

    reveal-duration

  • (Integer) —

    reveal-duration

#reveal_flap ⇒ Boolean

Gets whether the flap widget is revealed for self.

Returns:

  • (Boolean) —

    whether flap widget is revealed

#reveal_flap=(reveal_flap) ⇒ Boolean

Whether the flap widget is revealed.

Parameters:

  • reveal_flap (Boolean)

Returns:

  • (Boolean) —

    reveal-flap

  • (Boolean) —

    reveal-flap

#reveal_flap? ⇒ Boolean

Whether the flap widget is revealed.

Returns:

  • (Boolean) —

    reveal-flap

#reveal_progress ⇒ Float

The current reveal transition progress.

0 means fully hidden, 1 means fully revealed. See [propertyFlap:reveal-flap].

Returns:

  • (Float) —

    reveal-progress

#reveal_progress=(reveal_progress) ⇒ Float

The current reveal transition progress.

0 means fully hidden, 1 means fully revealed. See [propertyFlap:reveal-flap].

Parameters:

  • reveal_progress (Float)

Returns:

  • (Float) —

    reveal-progress

  • (Float) —

    reveal-progress

#separator ⇒ Gtk::Widget

The separator widget.

It's displayed between content and flap when there's no shadow to display. When exactly it's visible depends on the [propertyFlap:transition-type] value. If NULL, no separator will be used.

Returns:

  • (Gtk::Widget) —

    separator

#separator=(separator) ⇒ Gtk::Widget

The separator widget.

It's displayed between content and flap when there's no shadow to display. When exactly it's visible depends on the [propertyFlap:transition-type] value. If NULL, no separator will be used.

Parameters:

  • separator (Gtk::Widget)

Returns:

  • (Gtk::Widget) —

    separator

  • (Gtk::Widget) —

    separator

#swipe_to_close ⇒ Boolean

Gets whether self can be closed with a swipe gesture.

Returns:

  • (Boolean) —

    TRUE if self can be closed with a swipe gesture

#swipe_to_close=(swipe_to_close) ⇒ Boolean

Whether the flap can be closed with a swipe gesture.

The area that can be swiped depends on the [propertyFlap:transition-type] value.

Parameters:

  • swipe_to_close (Boolean)

Returns:

  • (Boolean) —

    swipe-to-close

  • (Boolean) —

    swipe-to-close

#swipe_to_close? ⇒ Boolean

Whether the flap can be closed with a swipe gesture.

The area that can be swiped depends on the [propertyFlap:transition-type] value.

Returns:

  • (Boolean) —

    swipe-to-close

#swipe_to_open ⇒ Boolean

Gets whether self can be opened with a swipe gesture.

Returns:

  • (Boolean) —

    TRUE if self can be opened with a swipe gesture

#swipe_to_open=(swipe_to_open) ⇒ Boolean

Whether the flap can be opened with a swipe gesture.

The area that can be swiped depends on the [propertyFlap:transition-type] value.

Parameters:

  • swipe_to_open (Boolean)

Returns:

  • (Boolean) —

    swipe-to-open

  • (Boolean) —

    swipe-to-open

#swipe_to_open? ⇒ Boolean

Whether the flap can be opened with a swipe gesture.

The area that can be swiped depends on the [propertyFlap:transition-type] value.

Returns:

  • (Boolean) —

    swipe-to-open

#transition_type ⇒ Handy::FlapTransitionType

the type of animation used for reveal and fold transitions.

[propertyFlap:flap] is transparent by default, which means the content will be seen through it with HDY_FLAP_TRANSITION_TYPE_OVER transitions; add the .background style class to it if this is unwanted.

Returns:

#transition_type=(transition_type) ⇒ Handy::FlapTransitionType

the type of animation used for reveal and fold transitions.

[propertyFlap:flap] is transparent by default, which means the content will be seen through it with HDY_FLAP_TRANSITION_TYPE_OVER transitions; add the .background style class to it if this is unwanted.

Parameters:

Returns: