WebKitDOMGTK+ Reference Manual: WebKitDOMMouseEvent

## WebKitDOMMouseEvent WebKitDOMMouseEvent |

## Synopsis

                        WebKitDOMMouseEvent;
    void                webkit_dom_mouse_event_init_mouse_event
                                                            (WebKitDOMMouseEvent *self,
                                                             const gchar *type,
                                                             gboolean canBubble,
                                                             gboolean cancelable,
                                                             WebKitDOMDOMWindow *view,
                                                             glong detail,
                                                             glong screenX,
                                                             glong screenY,
                                                             glong clientX,
                                                             glong clientY,
                                                             gboolean ctrlKey,
                                                             gboolean altKey,
                                                             gboolean shiftKey,
                                                             gboolean metaKey,
                                                             gushort button,
                                                             WebKitDOMEventTarget *relatedTarget);
    glong               webkit_dom_mouse_event_get_screen_x (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_screen_y (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_client_x (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_client_y (WebKitDOMMouseEvent *self);
    gboolean            webkit_dom_mouse_event_get_ctrl_key (WebKitDOMMouseEvent *self);
    gboolean            webkit_dom_mouse_event_get_shift_key
                                                            (WebKitDOMMouseEvent *self);
    gboolean            webkit_dom_mouse_event_get_alt_key  (WebKitDOMMouseEvent *self);
    gboolean            webkit_dom_mouse_event_get_meta_key (WebKitDOMMouseEvent *self);
    gushort             webkit_dom_mouse_event_get_button   (WebKitDOMMouseEvent *self);
    WebKitDOMEventTarget * webkit_dom_mouse_event_get_related_target
                                                            (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_webkit_movement_x
                                                            (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_webkit_movement_y
                                                            (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_offset_x (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_offset_y (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_x        (WebKitDOMMouseEvent *self);
    glong               webkit_dom_mouse_event_get_y        (WebKitDOMMouseEvent *self);
    WebKitDOMNode *     webkit_dom_mouse_event_get_from_element
                                                            (WebKitDOMMouseEvent *self);
    WebKitDOMNode *     webkit_dom_mouse_event_get_to_element
                                                            (WebKitDOMMouseEvent *self);

## Object Hierarchy

      GObject
       +----WebKitDOMObject
             +----WebKitDOMEvent
                   +----WebKitDOMUIEvent
                         +----WebKitDOMMouseEvent
                               +----WebKitDOMWheelEvent

## Properties

      "alt-key"                  gboolean              : Read
      "button"                   guint                 : Read
      "client-x"                 glong                 : Read
      "client-y"                 glong                 : Read
      "ctrl-key"                 gboolean              : Read
      "from-element"             WebKitDOMNode*        : Read
      "meta-key"                 gboolean              : Read
      "offset-x"                 glong                 : Read
      "offset-y"                 glong                 : Read
      "related-target"           WebKitDOMEventTarget*  : Read
      "screen-x"                 glong                 : Read
      "screen-y"                 glong                 : Read
      "shift-key"                gboolean              : Read
      "to-element"               WebKitDOMNode*        : Read
      "webkit-movement-x"        glong                 : Read
      "webkit-movement-y"        glong                 : Read
      "x"                        glong                 : Read
      "y"                        glong                 : Read

## Description

## Details

### WebKitDOMMouseEvent

    typedef struct _WebKitDOMMouseEvent WebKitDOMMouseEvent;

### webkit_dom_mouse_event_init_mouse_event ()

    void                webkit_dom_mouse_event_init_mouse_event
                                                            (WebKitDOMMouseEvent *self,
                                                             const gchar *type,
                                                             gboolean canBubble,
                                                             gboolean cancelable,
                                                             WebKitDOMDOMWindow *view,
                                                             glong detail,
                                                             glong screenX,
                                                             glong screenY,
                                                             glong clientX,
                                                             glong clientY,
                                                             gboolean ctrlKey,
                                                             gboolean altKey,
                                                             gboolean shiftKey,
                                                             gboolean metaKey,
                                                             gushort button,
                                                             WebKitDOMEventTarget *relatedTarget);

`self` : | A WebKitDOMMouseEvent
`type` : | A gchar
`canBubble` : | A gboolean
`cancelable` : | A gboolean
`view` : | A WebKitDOMDOMWindow
`detail` : | A glong
`screenX` : | A glong
`screenY` : | A glong
`clientX` : | A glong
`clientY` : | A glong
`ctrlKey` : | A gboolean
`altKey` : | A gboolean
`shiftKey` : | A gboolean
`metaKey` : | A gboolean
`button` : | A gushort
`relatedTarget` : | A WebKitDOMEventTarget

### webkit_dom_mouse_event_get_screen_x ()

    glong               webkit_dom_mouse_event_get_screen_x (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_screen_y ()

    glong               webkit_dom_mouse_event_get_screen_y (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_client_x ()

    glong               webkit_dom_mouse_event_get_client_x (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_client_y ()

    glong               webkit_dom_mouse_event_get_client_y (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_ctrl_key ()

    gboolean            webkit_dom_mouse_event_get_ctrl_key (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A gboolean

### webkit_dom_mouse_event_get_shift_key ()

    gboolean            webkit_dom_mouse_event_get_shift_key
                                                            (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A gboolean

### webkit_dom_mouse_event_get_alt_key ()

    gboolean            webkit_dom_mouse_event_get_alt_key  (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A gboolean

### webkit_dom_mouse_event_get_meta_key ()

    gboolean            webkit_dom_mouse_event_get_meta_key (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A gboolean

### webkit_dom_mouse_event_get_button ()

    gushort             webkit_dom_mouse_event_get_button   (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A gushort

### webkit_dom_mouse_event_get_related_target ()

    WebKitDOMEventTarget * webkit_dom_mouse_event_get_related_target
                                                            (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A WebKitDOMEventTarget. [transfer none]

### webkit_dom_mouse_event_get_webkit_movement_x ()

    glong               webkit_dom_mouse_event_get_webkit_movement_x
                                                            (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_webkit_movement_y ()

    glong               webkit_dom_mouse_event_get_webkit_movement_y
                                                            (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_offset_x ()

    glong               webkit_dom_mouse_event_get_offset_x (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_offset_y ()

    glong               webkit_dom_mouse_event_get_offset_y (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_x ()

    glong               webkit_dom_mouse_event_get_x        (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_y ()

    glong               webkit_dom_mouse_event_get_y        (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A glong

### webkit_dom_mouse_event_get_from_element ()

    WebKitDOMNode *     webkit_dom_mouse_event_get_from_element
                                                            (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A WebKitDOMNode. [transfer none]

### webkit_dom_mouse_event_get_to_element ()

    WebKitDOMNode *     webkit_dom_mouse_event_get_to_element
                                                            (WebKitDOMMouseEvent *self);

`self` : | A WebKitDOMMouseEvent
Returns : | A WebKitDOMNode. [transfer none]

## Property Details

### The `"alt-key"` property

      "alt-key"                  gboolean              : Read

read-only gboolean MouseEvent:alt-key.

Default value: FALSE

### The `"button"` property

      "button"                   guint                 : Read

read-only gushort MouseEvent:button.

Default value: 0

### The `"client-x"` property

      "client-x"                 glong                 : Read

read-only glong MouseEvent:client-x.

Default value: 0

### The `"client-y"` property

      "client-y"                 glong                 : Read

read-only glong MouseEvent:client-y.

Default value: 0

### The `"ctrl-key"` property

      "ctrl-key"                 gboolean              : Read

read-only gboolean MouseEvent:ctrl-key.

Default value: FALSE

### The `"from-element"` property

      "from-element"             WebKitDOMNode*        : Read

read-only WebKitDOMNode* MouseEvent:from-element.

### The `"meta-key"` property

      "meta-key"                 gboolean              : Read

read-only gboolean MouseEvent:meta-key.

Default value: FALSE

### The `"offset-x"` property

      "offset-x"                 glong                 : Read

read-only glong MouseEvent:offset-x.

Default value: 0

### The `"offset-y"` property

      "offset-y"                 glong                 : Read

read-only glong MouseEvent:offset-y.

Default value: 0

### The `"related-target"` property

      "related-target"           WebKitDOMEventTarget*  : Read

read-only WebKitDOMEventTarget* MouseEvent:related-target.

### The `"screen-x"` property

      "screen-x"                 glong                 : Read

read-only glong MouseEvent:screen-x.

Default value: 0

### The `"screen-y"` property

      "screen-y"                 glong                 : Read

read-only glong MouseEvent:screen-y.

Default value: 0

### The `"shift-key"` property

      "shift-key"                gboolean              : Read

read-only gboolean MouseEvent:shift-key.

Default value: FALSE

### The `"to-element"` property

      "to-element"               WebKitDOMNode*        : Read

read-only WebKitDOMNode* MouseEvent:to-element.

### The `"webkit-movement-x"` property

      "webkit-movement-x"        glong                 : Read

read-only glong MouseEvent:webkit-movement-x.

Default value: 0

### The `"webkit-movement-y"` property

      "webkit-movement-y"        glong                 : Read

read-only glong MouseEvent:webkit-movement-y.

Default value: 0

### The `"x"` property

      "x"                        glong                 : Read

read-only glong MouseEvent:x.

Default value: 0

### The `"y"` property

      "y"                        glong                 : Read

read-only glong MouseEvent:y.

Default value: 0