Class: Handy::Deck

Inherits:

Gtk::Container

• Object
• Gtk::Container
• Handy::Deck

Defined in:

(unknown)

Instance Method Summary

• #can_swipe_back ⇒ Boolean

  Gets whether swipe gestures for navigating backward are enabled.

• #can_swipe_back=(can_swipe_back) ⇒ Boolean

  Whether swipe gestures allow switching to the previous child.

• #can_swipe_back? ⇒ Boolean

  Whether swipe gestures allow switching to the previous child.

• #can_swipe_forward ⇒ Boolean

  Gets whether swipe gestures for navigating forward enabled.

• #can_swipe_forward=(can_swipe_forward) ⇒ Boolean

  Whether swipe gestures allow switching to the next child.

• #can_swipe_forward? ⇒ Boolean

  Whether swipe gestures allow switching to the next child.

• #get_adjacent_child(direction) ⇒ Gtk::Widget

  Finds the previous or next navigatable child.

• #get_child_by_name(name) ⇒ Gtk::Widget

  Finds the child of self with name.

• #get_homogeneous(orientation) ⇒ Boolean

  Gets whether self is homogeneous for the given orientation.

• #hhomogeneous=(hhomogeneous) ⇒ Boolean

  Horizontally homogeneous sizing.

• #hhomogeneous? ⇒ Boolean

  Horizontally homogeneous sizing.

• #initialize ⇒ Gtk::Widget constructor

  Creates a new HdyDeck.

• #insert_child_after(child, sibling) ⇒ nil

  Inserts child in the position after sibling in the list of children.

• #interpolate_size ⇒ Boolean

  Gets whether self will interpolate its size when changing the visible child.

• #interpolate_size=(interpolate_size) ⇒ Boolean

  Whether or not the size should smoothly change when changing between differently sized children.

• #interpolate_size? ⇒ Boolean

  Whether or not the size should smoothly change when changing between differently sized children.

• #navigate(direction) ⇒ Boolean

  Navigates to the previous or next child.

• #prepend(child) ⇒ nil

  Inserts child at the first position in self.

• #reorder_child_after(child, sibling) ⇒ nil

  Moves child to the position after sibling in the list of children.

• #set_homogeneous(orientation, homogeneous) ⇒ nil

  Sets whether self is homogeneous for a given orientation.

• #transition_duration ⇒ Integer

  The transition animation duration, in milliseconds.

• #transition_duration=(transition_duration) ⇒ Integer

  The transition animation duration, in milliseconds.

• #transition_running ⇒ Boolean

  Gets whether a transition is currently running for self.

• #transition_running=(transition_running) ⇒ Boolean

  Whether or not the transition is currently running.

• #transition_running? ⇒ Boolean

  Whether or not the transition is currently running.

• #transition_type ⇒ Handy::DeckTransitionType

  The type of animation that will be used for transitions between children.

• #transition_type=(transition_type) ⇒ Handy::DeckTransitionType

  The type of animation that will be used for transitions between children.

• #vhomogeneous=(vhomogeneous) ⇒ Boolean

  Vertically homogeneous sizing.

• #vhomogeneous? ⇒ Boolean

  Vertically homogeneous sizing.

• #visible_child ⇒ Gtk::Widget

  The widget currently visible.

• #visible_child=(visible_child) ⇒ Gtk::Widget

  The widget currently visible.

• #visible_child_name ⇒ String

  The name of the widget currently visible.

• #visible_child_name=(visible_child_name) ⇒ String

  The name of the widget currently visible.

Constructor Details

#initialize ⇒ Gtk::Widget

Creates a new HdyDeck.

Instance Method Details

#can_swipe_back ⇒ Boolean

Gets whether swipe gestures for navigating backward are enabled.

Returns:

• (Boolean) —

  Whether swipe gestures are enabled.

#can_swipe_back=(can_swipe_back) ⇒ Boolean

Whether swipe gestures allow switching to the previous child.

Parameters:

• can_swipe_back (Boolean)

Returns:

• (Boolean) —

  can-swipe-back

• (Boolean) —

  can-swipe-back

#can_swipe_back? ⇒ Boolean

Whether swipe gestures allow switching to the previous child.

Returns:

• (Boolean) —

  can-swipe-back

#can_swipe_forward ⇒ Boolean

Gets whether swipe gestures for navigating forward enabled.

Returns:

• (Boolean) —

  Whether swipe gestures are enabled.

#can_swipe_forward=(can_swipe_forward) ⇒ Boolean

Whether swipe gestures allow switching to the next child.

Parameters:

• can_swipe_forward (Boolean)

Returns:

• (Boolean) —

  can-swipe-forward

• (Boolean) —

  can-swipe-forward

#can_swipe_forward? ⇒ Boolean

Whether swipe gestures allow switching to the next child.

Returns:

• (Boolean) —

  can-swipe-forward

#get_adjacent_child(direction) ⇒ Gtk::Widget

Finds the previous or next navigatable child.

Gets the previous or next child. This will be the same widget [methodDeck.navigate] will navigate to.

If there's no child to navigate to, NULL will be returned instead.

Parameters:

• direction (Handy::NavigationDirection) —

  the direction

Returns:

• (Gtk::Widget) —

  the previous or next child

#get_child_by_name(name) ⇒ Gtk::Widget

Finds the child of self with name.

Returns NULL if there is no child with this name.

Parameters:

• name (String) —

  the name of the child to find

Returns:

• (Gtk::Widget) —

  the requested child of self

#get_homogeneous(orientation) ⇒ Boolean

Gets whether self is homogeneous for the given orientation.

Parameters:

• orientation (Gtk::Orientation) —

  the orientation

Returns:

• (Boolean) —

  whether self is homogeneous for the given orientation

#hhomogeneous=(hhomogeneous) ⇒ Boolean

Horizontally homogeneous sizing.

Parameters:

• hhomogeneous (Boolean)

Returns:

• (Boolean) —

  hhomogeneous

• (Boolean) —

  hhomogeneous

#hhomogeneous? ⇒ Boolean

Horizontally homogeneous sizing.

Returns:

• (Boolean) —

  hhomogeneous

#insert_child_after(child, sibling) ⇒ nil

Inserts child in the position after sibling in the list of children.

If sibling is NULL, inserts child at the first position.

Parameters:

• child (Gtk::Widget) —

  the widget to insert

• sibling (Gtk::Widget) —

  the sibling after which to insert child

Returns:

• (nil)

#interpolate_size ⇒ Boolean

Gets whether self will interpolate its size when changing the visible child.

Returns:

• (Boolean) —

  whether child sizes are interpolated

#interpolate_size=(interpolate_size) ⇒ Boolean

Whether or not the size should smoothly change when changing between differently sized children.

Parameters:

• interpolate_size (Boolean)

Returns:

• (Boolean) —

  interpolate-size

• (Boolean) —

  interpolate-size

#interpolate_size? ⇒ Boolean

Whether or not the size should smoothly change when changing between differently sized children.

Returns:

• (Boolean) —

  interpolate-size

#navigate(direction) ⇒ Boolean

Navigates to the previous or next child.

The switch is similar to performing a swipe gesture to go in direction.

Parameters:

• direction (Handy::NavigationDirection) —

  the direction

Returns:

• (Boolean) —

  whether the visible child was changed

#prepend(child) ⇒ nil

Inserts child at the first position in self.

Parameters:

• child (Gtk::Widget) —

  the widget to prepend

Returns:

• (nil)

#reorder_child_after(child, sibling) ⇒ nil

Moves child to the position after sibling in the list of children.

If sibling is NULL, move child to the first position.

Parameters:

• child (Gtk::Widget) —

  the widget to move, must be a child of self

• sibling (Gtk::Widget) —

  the sibling to move child after

Returns:

• (nil)

#set_homogeneous(orientation, homogeneous) ⇒ nil

Sets whether self is homogeneous for a given orientation.

If set to FALSE, different children can have different size along the opposite orientation.

Parameters:

• orientation (Gtk::Orientation) —

  the orientation

• homogeneous (Boolean) —

  TRUE to make self homogeneous

Returns:

• (nil)

#transition_duration ⇒ Integer

The transition animation duration, in milliseconds.

Returns:

• (Integer) —

  transition-duration

#transition_duration=(transition_duration) ⇒ Integer

The transition animation duration, in milliseconds.

Parameters:

• transition_duration (Integer)

Returns:

• (Integer) —

  transition-duration

• (Integer) —

  transition-duration

#transition_running ⇒ Boolean

Gets whether a transition is currently running for self.

Returns:

• (Boolean) —

  whether a transition is currently running

#transition_running=(transition_running) ⇒ Boolean

Whether or not the transition is currently running.

Parameters:

• transition_running (Boolean)

Returns:

• (Boolean) —

  transition-running

• (Boolean) —

  transition-running

#transition_running? ⇒ Boolean

Whether or not the transition is currently running.

Returns:

• (Boolean) —

  transition-running

#transition_type ⇒ Handy::DeckTransitionType

The type of animation that will be used for transitions between children.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the child that is about to become current.

Returns:

• (Handy::DeckTransitionType) —

  transition-type

#transition_type=(transition_type) ⇒ Handy::DeckTransitionType

The type of animation that will be used for transitions between children.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the child that is about to become current.

Parameters:

• transition_type (Handy::DeckTransitionType)

Returns:

• (Handy::DeckTransitionType) —

  transition-type

• (Handy::DeckTransitionType) —

  transition-type

#vhomogeneous=(vhomogeneous) ⇒ Boolean

Vertically homogeneous sizing.

Parameters:

• vhomogeneous (Boolean)

Returns:

• (Boolean) —

  vhomogeneous

• (Boolean) —

  vhomogeneous

#vhomogeneous? ⇒ Boolean

Vertically homogeneous sizing.

Returns:

• (Boolean) —

  vhomogeneous

#visible_child ⇒ Gtk::Widget

The widget currently visible.

The transition is determined by [propertyDeck:transition-type] and [propertyDeck:transition-duration]. The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

Returns:

• (Gtk::Widget) —

  visible-child

#visible_child=(visible_child) ⇒ Gtk::Widget

The widget currently visible.

The transition is determined by [propertyDeck:transition-type] and [propertyDeck:transition-duration]. The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

Parameters:

• visible_child (Gtk::Widget)

Returns:

• (Gtk::Widget) —

  visible-child

• (Gtk::Widget) —

  visible-child

#visible_child_name ⇒ String

The name of the widget currently visible.

Returns:

• (String) —

  visible-child-name

#visible_child_name=(visible_child_name) ⇒ String

The name of the widget currently visible.

Parameters:

• visible_child_name (String)

Returns:

• (String) —

  visible-child-name

• (String) —

  visible-child-name