Phoc.Cursor
Description: Reference for Phoc.Cursor

### Class

# PhocCursor

#### Description

    class Phoc.Cursor : GObject.Object
    {
      PhocSeat* seat,
      wlr_cursor* cursor,
      wlr_pointer_constraint_v1* active_constraint,
      pixman_region32_t confine,
      int offs_x,
      int offs_y,
      int view_x,
      int view_y,
      int view_width,
      int view_height,
      uint32_t resize_edges,
      PhocSeatView* pointer_view,
      wlr_surface* wlr_surface,
      wl_listener motion,
      wl_listener motion_absolute,
      wl_listener button,
      wl_listener axis,
      wl_listener frame,
      wl_listener swipe_begin,
      wl_listener swipe_update,
      wl_listener swipe_end,
      wl_listener pinch_begin,
      wl_listener pinch_update,
      wl_listener pinch_end,
      wl_listener touch_down,
      wl_listener touch_up,
      wl_listener touch_motion,
      wl_listener touch_frame,
      wl_listener tool_axis,
      wl_listener tool_tip,
      wl_listener tool_proximity,
      wl_listener tool_button,
      wl_listener request_set_cursor,
      wl_listener focus_change,
      wl_listener constraint_commit
    }

No description available.

#### Hierarchy

#### Ancestors

- GObject

#### Constructors

###### phoc_cursor_new

No description available.

#### Instance methods

###### phoc_cursor_add_gesture

Adds a gesture to the list of gestures handled by `self`.

###### phoc_cursor_configure_xcursor

Load cursor theme for the current output scales and set a default cursor.

###### phoc_cursor_constrain

No description available.

###### phoc_cursor_get_gestures

Gets the currently registered gestures of `self`.

###### phoc_cursor_get_mode

Get the current cursor mode.

###### phoc_cursor_get_touch_points

Gets the touch points currently tracked by the cursor.

###### phoc_cursor_handle_event

Feed an event that happened at the cursor coordinates of type `type` to the event system. This gives all gestures that are registered in the compositor a chance to handle the event.

###### phoc_cursor_handle_focus_change

No description available.

###### phoc_cursor_handle_tool_axis

No description available.

###### phoc_cursor_handle_tool_tip

No description available.

###### phoc_cursor_handle_touch_down

No description available.

###### phoc_cursor_handle_touch_motion

No description available.

###### phoc_cursor_handle_touch_up

No description available.

###### phoc_cursor_is_active_touch_id

Checks whether the given touch is is in the list of active touch points.

###### phoc_cursor_set_image

Set the cursor image via a surface. To use an image from the cursor theme see `phoc_cursor_set_image()`.

###### phoc_cursor_set_mode

Set the cursor mode.

###### phoc_cursor_set_name

Select a cursor from the cursor theme by its name. To use a surface see `phoc_cursor_set_image()`.

###### phoc_cursor_set_xcursor_theme

Set the current cursor theme.

###### phoc_cursor_update_focus

No description available.

###### phoc_cursor_update_position

No description available.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### Phoc.Cursor:seat

No description available.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct PhocCursorClass {
      GObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.