Class: Clutter::ClickAction

Inherits:

Action

• Object
• GObject::InitiallyUnowned
• ActorMeta
• Action
• Clutter::ClickAction

Defined in:

(unknown)

Overview

The Clutter::ClickActionClass structure contains only private data

Instance Method Summary

• #button ⇒ Integer

  Retrieves the button that was pressed.

• #get_coords(press_x, press_y) ⇒ nil

  Retrieves the screen coordinates of the button press.

• #held=(held) ⇒ Boolean

  Whether the clickable actor has the pointer grabbed.

• #held? ⇒ Boolean

  Whether the clickable actor has the pointer grabbed.

• #initialize ⇒ Clutter::Action constructor

  Creates a new Clutter::ClickAction instance.

• #long_press_duration ⇒ Integer

  The minimum duration of a press for it to be recognized as a long press gesture, in milliseconds.

• #long_press_duration=(long_press_duration) ⇒ Integer

  The minimum duration of a press for it to be recognized as a long press gesture, in milliseconds.

• #long_press_threshold ⇒ Integer

  The maximum allowed distance that can be covered (on both axes) before a long press gesture is cancelled, in pixels.

• #long_press_threshold=(long_press_threshold) ⇒ Integer

  The maximum allowed distance that can be covered (on both axes) before a long press gesture is cancelled, in pixels.

• #pressed=(pressed) ⇒ Boolean

  Whether the clickable actor should be in "pressed" state.

• #pressed? ⇒ Boolean

  Whether the clickable actor should be in "pressed" state.

• #release ⇒ nil

  Emulates a release of the pointer button, which ungrabs the pointer and unsets the Clutter::ClickAction:pressed state.

• #state ⇒ Clutter::ModifierType

  Retrieves the modifier state of the click action.

Methods inherited from ActorMeta

#actor, #actor=, #enabled, #enabled=, #enabled?, #name, #name=

Constructor Details

#initialize ⇒ Clutter::Action

Creates a new Clutter::ClickAction instance

Instance Method Details

#button ⇒ Integer

Retrieves the button that was pressed.

Returns:

• (Integer) —

  the button value

#get_coords(press_x, press_y) ⇒ nil

Retrieves the screen coordinates of the button press.

Parameters:

• press_x (Clutter::gfloat) —

  return location for the X coordinate, or nil

• press_y (Clutter::gfloat) —

  return location for the Y coordinate, or nil

Returns:

• (nil)

#held=(held) ⇒ Boolean

Whether the clickable actor has the pointer grabbed

Parameters:

• held (Boolean)

Returns:

• (Boolean) —

  held

• (Boolean) —

  held

#held? ⇒ Boolean

Whether the clickable actor has the pointer grabbed

Returns:

• (Boolean) —

  held

#long_press_duration ⇒ Integer

The minimum duration of a press for it to be recognized as a long press gesture, in milliseconds.

A value of -1 will make the Clutter::ClickAction use the value of the Clutter::Settings:long-press-duration property.

Returns:

• (Integer) —

  long-press-duration

#long_press_duration=(long_press_duration) ⇒ Integer

The minimum duration of a press for it to be recognized as a long press gesture, in milliseconds.

A value of -1 will make the Clutter::ClickAction use the value of the Clutter::Settings:long-press-duration property.

Parameters:

• long_press_duration (Integer)

Returns:

• (Integer) —

  long-press-duration

• (Integer) —

  long-press-duration

#long_press_threshold ⇒ Integer

The maximum allowed distance that can be covered (on both axes) before a long press gesture is cancelled, in pixels.

A value of -1 will make the Clutter::ClickAction use the value of the Clutter::Settings:dnd-drag-threshold property.

Returns:

• (Integer) —

  long-press-threshold

#long_press_threshold=(long_press_threshold) ⇒ Integer

The maximum allowed distance that can be covered (on both axes) before a long press gesture is cancelled, in pixels.

A value of -1 will make the Clutter::ClickAction use the value of the Clutter::Settings:dnd-drag-threshold property.

Parameters:

• long_press_threshold (Integer)

Returns:

• (Integer) —

  long-press-threshold

• (Integer) —

  long-press-threshold

#pressed=(pressed) ⇒ Boolean

Whether the clickable actor should be in "pressed" state

Parameters:

• pressed (Boolean)

Returns:

• (Boolean) —

  pressed

• (Boolean) —

  pressed

#pressed? ⇒ Boolean

Whether the clickable actor should be in "pressed" state

Returns:

• (Boolean) —

  pressed

#release ⇒ nil

Emulates a release of the pointer button, which ungrabs the pointer and unsets the Clutter::ClickAction:pressed state.

This function will also cancel the long press gesture if one was initiated.

This function is useful to break a grab, for instance after a certain amount of time has passed.

Returns:

• (nil)

#state ⇒ Clutter::ModifierType

Retrieves the modifier state of the click action.

Returns:

• (Clutter::ModifierType) —

  the modifier state parameter, or 0