WebKitDOMGTK+ Reference Manual: WebKitDOMRange

## WebKitDOMRange WebKitDOMRange |

## Synopsis

                        WebKitDOMRange;
    void                webkit_dom_range_set_start          (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);
    void                webkit_dom_range_set_end            (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);
    void                webkit_dom_range_set_start_before   (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    void                webkit_dom_range_set_start_after    (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    void                webkit_dom_range_set_end_before     (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    void                webkit_dom_range_set_end_after      (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    void                webkit_dom_range_collapse           (WebKitDOMRange *self,
                                                             gboolean toStart,
                                                             GError **error);
    void                webkit_dom_range_select_node        (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    void                webkit_dom_range_select_node_contents
                                                            (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    gshort              webkit_dom_range_compare_boundary_points
                                                            (WebKitDOMRange *self,
                                                             gushort how,
                                                             WebKitDOMRange *sourceRange,
                                                             GError **error);
    void                webkit_dom_range_delete_contents    (WebKitDOMRange *self,
                                                             GError **error);
    WebKitDOMDocumentFragment * webkit_dom_range_extract_contents
                                                            (WebKitDOMRange *self,
                                                             GError **error);
    WebKitDOMDocumentFragment * webkit_dom_range_clone_contents
                                                            (WebKitDOMRange *self,
                                                             GError **error);
    void                webkit_dom_range_insert_node        (WebKitDOMRange *self,
                                                             WebKitDOMNode *newNode,
                                                             GError **error);
    void                webkit_dom_range_surround_contents  (WebKitDOMRange *self,
                                                             WebKitDOMNode *newParent,
                                                             GError **error);
    WebKitDOMRange *    webkit_dom_range_clone_range        (WebKitDOMRange *self,
                                                             GError **error);
    gchar *             webkit_dom_range_to_string          (WebKitDOMRange *self,
                                                             GError **error);
    void                webkit_dom_range_detach             (WebKitDOMRange *self,
                                                             GError **error);
    WebKitDOMDocumentFragment * webkit_dom_range_create_contextual_fragment
                                                            (WebKitDOMRange *self,
                                                             const gchar *html,
                                                             GError **error);
    gboolean            webkit_dom_range_intersects_node    (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    gshort              webkit_dom_range_compare_node       (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);
    gshort              webkit_dom_range_compare_point      (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);
    gboolean            webkit_dom_range_is_point_in_range  (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);
    void                webkit_dom_range_expand             (WebKitDOMRange *self,
                                                             const gchar *unit,
                                                             GError **error);
    WebKitDOMNode *     webkit_dom_range_get_start_container
                                                            (WebKitDOMRange *self,
                                                             GError **error);
    glong               webkit_dom_range_get_start_offset   (WebKitDOMRange *self,
                                                             GError **error);
    WebKitDOMNode *     webkit_dom_range_get_end_container  (WebKitDOMRange *self,
                                                             GError **error);
    glong               webkit_dom_range_get_end_offset     (WebKitDOMRange *self,
                                                             GError **error);
    gboolean            webkit_dom_range_get_collapsed      (WebKitDOMRange *self,
                                                             GError **error);
    WebKitDOMNode *     webkit_dom_range_get_common_ancestor_container
                                                            (WebKitDOMRange *self,
                                                             GError **error);
    gchar *             webkit_dom_range_get_text           (WebKitDOMRange *self);

## Object Hierarchy

      GObject
       +----WebKitDOMObject
             +----WebKitDOMRange

## Properties

      "collapsed"                gboolean              : Read
      "common-ancestor-container" WebKitDOMNode*        : Read
      "end-container"            WebKitDOMNode*        : Read
      "end-offset"               glong                 : Read
      "start-container"          WebKitDOMNode*        : Read
      "start-offset"             glong                 : Read
      "text"                     gchar*                : Read

## Description

## Details

### WebKitDOMRange

    typedef struct _WebKitDOMRange WebKitDOMRange;

### webkit_dom_range_set_start ()

    void                webkit_dom_range_set_start          (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`offset` : | A glong
`error` : | GError

### webkit_dom_range_set_end ()

    void                webkit_dom_range_set_end            (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`offset` : | A glong
`error` : | GError

### webkit_dom_range_set_start_before ()

    void                webkit_dom_range_set_start_before   (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_set_start_after ()

    void                webkit_dom_range_set_start_after    (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_set_end_before ()

    void                webkit_dom_range_set_end_before     (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_set_end_after ()

    void                webkit_dom_range_set_end_after      (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_collapse ()

    void                webkit_dom_range_collapse           (WebKitDOMRange *self,
                                                             gboolean toStart,
                                                             GError **error);

`self` : | A WebKitDOMRange
`toStart` : | A gboolean
`error` : | GError

### webkit_dom_range_select_node ()

    void                webkit_dom_range_select_node        (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_select_node_contents ()

    void                webkit_dom_range_select_node_contents
                                                            (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_compare_boundary_points ()

    gshort              webkit_dom_range_compare_boundary_points
                                                            (WebKitDOMRange *self,
                                                             gushort how,
                                                             WebKitDOMRange *sourceRange,
                                                             GError **error);

`self` : | A WebKitDOMRange
`how` : | A gushort
`sourceRange` : | A WebKitDOMRange
`error` : | GError
Returns : | A gshort

### webkit_dom_range_delete_contents ()

    void                webkit_dom_range_delete_contents    (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError

### webkit_dom_range_extract_contents ()

    WebKitDOMDocumentFragment * webkit_dom_range_extract_contents
                                                            (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A WebKitDOMDocumentFragment. [transfer none]

### webkit_dom_range_clone_contents ()

    WebKitDOMDocumentFragment * webkit_dom_range_clone_contents
                                                            (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A WebKitDOMDocumentFragment. [transfer none]

### webkit_dom_range_insert_node ()

    void                webkit_dom_range_insert_node        (WebKitDOMRange *self,
                                                             WebKitDOMNode *newNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`newNode` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_surround_contents ()

    void                webkit_dom_range_surround_contents  (WebKitDOMRange *self,
                                                             WebKitDOMNode *newParent,
                                                             GError **error);

`self` : | A WebKitDOMRange
`newParent` : | A WebKitDOMNode
`error` : | GError

### webkit_dom_range_clone_range ()

    WebKitDOMRange *    webkit_dom_range_clone_range        (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A WebKitDOMRange. [transfer none]

### webkit_dom_range_to_string ()

    gchar *             webkit_dom_range_to_string          (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A gchar

### webkit_dom_range_detach ()

    void                webkit_dom_range_detach             (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError

### webkit_dom_range_create_contextual_fragment ()

    WebKitDOMDocumentFragment * webkit_dom_range_create_contextual_fragment
                                                            (WebKitDOMRange *self,
                                                             const gchar *html,
                                                             GError **error);

`self` : | A WebKitDOMRange
`html` : | A gchar
`error` : | GError
Returns : | A WebKitDOMDocumentFragment. [transfer none]

### webkit_dom_range_intersects_node ()

    gboolean            webkit_dom_range_intersects_node    (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError
Returns : | A gboolean

### webkit_dom_range_compare_node ()

    gshort              webkit_dom_range_compare_node       (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`error` : | GError
Returns : | A gshort

### webkit_dom_range_compare_point ()

    gshort              webkit_dom_range_compare_point      (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`offset` : | A glong
`error` : | GError
Returns : | A gshort

### webkit_dom_range_is_point_in_range ()

    gboolean            webkit_dom_range_is_point_in_range  (WebKitDOMRange *self,
                                                             WebKitDOMNode *refNode,
                                                             glong offset,
                                                             GError **error);

`self` : | A WebKitDOMRange
`refNode` : | A WebKitDOMNode
`offset` : | A glong
`error` : | GError
Returns : | A gboolean

### webkit_dom_range_expand ()

    void                webkit_dom_range_expand             (WebKitDOMRange *self,
                                                             const gchar *unit,
                                                             GError **error);

`self` : | A WebKitDOMRange
`unit` : | A gchar
`error` : | GError

### webkit_dom_range_get_start_container ()

    WebKitDOMNode *     webkit_dom_range_get_start_container
                                                            (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A WebKitDOMNode. [transfer none]

### webkit_dom_range_get_start_offset ()

    glong               webkit_dom_range_get_start_offset   (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A glong

### webkit_dom_range_get_end_container ()

    WebKitDOMNode *     webkit_dom_range_get_end_container  (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A WebKitDOMNode. [transfer none]

### webkit_dom_range_get_end_offset ()

    glong               webkit_dom_range_get_end_offset     (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A glong

### webkit_dom_range_get_collapsed ()

    gboolean            webkit_dom_range_get_collapsed      (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A gboolean

### webkit_dom_range_get_common_ancestor_container ()

    WebKitDOMNode *     webkit_dom_range_get_common_ancestor_container
                                                            (WebKitDOMRange *self,
                                                             GError **error);

`self` : | A WebKitDOMRange
`error` : | GError
Returns : | A WebKitDOMNode. [transfer none]

### webkit_dom_range_get_text ()

    gchar *             webkit_dom_range_get_text           (WebKitDOMRange *self);

`self` : | A WebKitDOMRange
Returns : | A gchar

## Property Details

### The `"collapsed"` property

      "collapsed"                gboolean              : Read

read-only gboolean Range:collapsed.

Default value: FALSE

### The `"common-ancestor-container"` property

      "common-ancestor-container" WebKitDOMNode*        : Read

read-only WebKitDOMNode* Range:common-ancestor-container.

### The `"end-container"` property

      "end-container"            WebKitDOMNode*        : Read

read-only WebKitDOMNode* Range:end-container.

### The `"end-offset"` property

      "end-offset"               glong                 : Read

read-only glong Range:end-offset.

Default value: 0

### The `"start-container"` property

      "start-container"          WebKitDOMNode*        : Read

read-only WebKitDOMNode* Range:start-container.

### The `"start-offset"` property

      "start-offset"             glong                 : Read

read-only glong Range:start-offset.

Default value: 0

### The `"text"` property

      "text"                     gchar*                : Read

read-only gchar* Range:text.

Default value: ""