Gjsify LogoGjsify Logo

Generic event wrapper.

union

Hierarchy

  • Event

Index

Constructors

Properties

name: string

Methods

  • free(): void
  • Retrieves the angle relative from source to target.

    The direction of the angle is from the position X axis towards the positive Y axis.

    Parameters

    Returns number

  • get_axes(): [number, number]
  • get_button(): number
  • get_click_count(): number
  • get_coords(): [number, number]
  • Retrieves the #ClutterInputDevice for the event. If you want the physical device the event originated from, use clutter_event_get_source_device().

    The #ClutterInputDevice structure is completely opaque and should be cast to the platform-specific implementation.

    Returns InputDevice

  • get_device_id(): number
  • get_gesture_motion_delta(): [number, number]
  • get_gesture_pinch_angle_delta(): number
  • get_gesture_pinch_scale(): number
  • Returns the current scale as reported by event, 1.0 being the original distance at the time the corresponding event with phase %CLUTTER_TOUCHPAD_GESTURE_PHASE_BEGIN is received. is received.

    Returns number

  • get_gesture_swipe_finger_count(): number
  • get_key_code(): number
  • get_key_symbol(): number
  • get_key_unicode(): string
  • get_scroll_delta(): [number, number]
  • Retrieves the precise scrolling information of event.

    The event has to have a #ClutterScrollEvent.direction value of %CLUTTER_SCROLL_SMOOTH.

    Returns [number, number]

  • Retrieves the hardware device that originated the event.

    If you need the virtual device, use clutter_event_get_device().

    If no hardware device originated this event, this function will return the same device as clutter_event_get_device().

    Returns InputDevice

  • get_time(): number
  • has_control_modifier(): boolean
  • has_shift_modifier(): boolean
  • is_pointer_emulated(): boolean
  • Checks whether a pointer event has been generated by the windowing system. The returned value can be used to distinguish between events synthesized by the windowing system itself (as opposed by Clutter).

    Returns boolean

  • put(): void
  • Puts a copy of the event on the back of the event queue. The event will have the %CLUTTER_EVENT_FLAG_SYNTHETIC flag set. If the source is set event signals will be emitted for this source and capture/bubbling for its ancestors. If the source is not set it will be generated by picking or use the actor that currently has keyboard focus

    Returns void

  • set_button(button: number): void
  • set_coords(x: number, y: number): void
  • Sets the coordinates of the event.

    Parameters

    • x: number

      the X coordinate of the event

    • y: number

      the Y coordinate of the event

    Returns void

  • set_key_code(key_code: number): void
  • set_key_symbol(key_sym: number): void
  • set_key_unicode(key_unicode: string): void
  • set_scroll_delta(dx: number, dy: number): void
  • Sets the precise scrolling information of event.

    Parameters

    • dx: number

      delta on the horizontal axis

    • dy: number

      delta on the vertical axis

    Returns void

  • Sets the source #ClutterInputDevice for event.

    The #ClutterEvent must have been created using clutter_event_new().

    Parameters

    Returns void

  • set_time(time_: number): void
  • Adds a function which will be called for all events that Clutter processes. The function will be called before any signals are emitted for the event and it will take precedence over any grabs.

    Parameters

    • stage: Clutter.Stage

      The #ClutterStage to capture events for

    • func: EventFilterFunc

      The callback function which will be passed all events.

    Returns number

  • remove_filter(id: number): void
  • Removes an event filter that was previously added with clutter_event_add_filter().

    Parameters

    • id: number

      The ID of the event filter, as returned from clutter_event_add_filter()

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method