WebKitDOMGTK+ Reference Manual: WebKitDOMTextTrackCue

## WebKitDOMTextTrackCue WebKitDOMTextTrackCue |

## Synopsis

                        WebKitDOMTextTrackCue;
    WebKitDOMDocumentFragment * webkit_dom_text_track_cue_get_cue_as_html
                                                            (WebKitDOMTextTrackCue *self);
    gboolean            webkit_dom_text_track_cue_dispatch_event
                                                            (WebKitDOMTextTrackCue *self,
                                                             WebKitDOMEvent *evt,
                                                             GError **error);
    WebKitDOMTextTrack * webkit_dom_text_track_cue_get_track
                                                            (WebKitDOMTextTrackCue *self);
    gchar *             webkit_dom_text_track_cue_get_id    (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_id    (WebKitDOMTextTrackCue *self,
                                                             const gchar *value);
    gdouble             webkit_dom_text_track_cue_get_start_time
                                                            (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_start_time
                                                            (WebKitDOMTextTrackCue *self,
                                                             gdouble value,
                                                             GError **error);
    gdouble             webkit_dom_text_track_cue_get_end_time
                                                            (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_end_time
                                                            (WebKitDOMTextTrackCue *self,
                                                             gdouble value,
                                                             GError **error);
    gboolean            webkit_dom_text_track_cue_get_pause_on_exit
                                                            (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_pause_on_exit
                                                            (WebKitDOMTextTrackCue *self,
                                                             gboolean value);
    gchar *             webkit_dom_text_track_cue_get_vertical
                                                            (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_vertical
                                                            (WebKitDOMTextTrackCue *self,
                                                             const gchar *value,
                                                             GError **error);
    gboolean            webkit_dom_text_track_cue_get_snap_to_lines
                                                            (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_snap_to_lines
                                                            (WebKitDOMTextTrackCue *self,
                                                             gboolean value);
    glong               webkit_dom_text_track_cue_get_line  (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_line  (WebKitDOMTextTrackCue *self,
                                                             glong value,
                                                             GError **error);
    glong               webkit_dom_text_track_cue_get_position
                                                            (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_position
                                                            (WebKitDOMTextTrackCue *self,
                                                             glong value,
                                                             GError **error);
    glong               webkit_dom_text_track_cue_get_size  (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_size  (WebKitDOMTextTrackCue *self,
                                                             glong value,
                                                             GError **error);
    gchar *             webkit_dom_text_track_cue_get_align (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_align (WebKitDOMTextTrackCue *self,
                                                             const gchar *value,
                                                             GError **error);
    gchar *             webkit_dom_text_track_cue_get_text  (WebKitDOMTextTrackCue *self);
    void                webkit_dom_text_track_cue_set_text  (WebKitDOMTextTrackCue *self,
                                                             const gchar *value);

## Object Hierarchy

      GObject
       +----WebKitDOMObject
             +----WebKitDOMTextTrackCue

## Implemented Interfaces

WebKitDOMTextTrackCue implements WebKitDOMEventTarget.

## Properties

      "align"                    gchar*                : Read / Write
      "end-time"                 gdouble               : Read / Write
      "id"                       gchar*                : Read / Write
      "line"                     glong                 : Read / Write
      "pause-on-exit"            gboolean              : Read / Write
      "position"                 glong                 : Read / Write
      "size"                     glong                 : Read / Write
      "snap-to-lines"            gboolean              : Read / Write
      "start-time"               gdouble               : Read / Write
      "text"                     gchar*                : Read / Write
      "track"                    WebKitDOMTextTrack*   : Read
      "vertical"                 gchar*                : Read / Write

## Description

## Details

### WebKitDOMTextTrackCue

    typedef struct _WebKitDOMTextTrackCue WebKitDOMTextTrackCue;

### webkit_dom_text_track_cue_get_cue_as_html ()

    WebKitDOMDocumentFragment * webkit_dom_text_track_cue_get_cue_as_html
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A WebKitDOMDocumentFragment. [transfer none]

### webkit_dom_text_track_cue_dispatch_event ()

    gboolean            webkit_dom_text_track_cue_dispatch_event
                                                            (WebKitDOMTextTrackCue *self,
                                                             WebKitDOMEvent *evt,
                                                             GError **error);

### Warning

`webkit_dom_text_track_cue_dispatch_event` has been deprecated since version 2.4 and should not be used in newly-written code. Use `webkit_dom_event_target_dispatch_event()` instead.

`self` : | A WebKitDOMTextTrackCue
`evt` : | A WebKitDOMEvent
`error` : | GError
Returns : | A gboolean

### webkit_dom_text_track_cue_get_track ()

    WebKitDOMTextTrack * webkit_dom_text_track_cue_get_track
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A WebKitDOMTextTrack. [transfer none]

### webkit_dom_text_track_cue_get_id ()

    gchar *             webkit_dom_text_track_cue_get_id    (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gchar

### webkit_dom_text_track_cue_set_id ()

    void                webkit_dom_text_track_cue_set_id    (WebKitDOMTextTrackCue *self,
                                                             const gchar *value);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gchar

### webkit_dom_text_track_cue_get_start_time ()

    gdouble             webkit_dom_text_track_cue_get_start_time
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gdouble

### webkit_dom_text_track_cue_set_start_time ()

    void                webkit_dom_text_track_cue_set_start_time
                                                            (WebKitDOMTextTrackCue *self,
                                                             gdouble value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gdouble
`error` : | GError

### webkit_dom_text_track_cue_get_end_time ()

    gdouble             webkit_dom_text_track_cue_get_end_time
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gdouble

### webkit_dom_text_track_cue_set_end_time ()

    void                webkit_dom_text_track_cue_set_end_time
                                                            (WebKitDOMTextTrackCue *self,
                                                             gdouble value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gdouble
`error` : | GError

### webkit_dom_text_track_cue_get_pause_on_exit ()

    gboolean            webkit_dom_text_track_cue_get_pause_on_exit
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gboolean

### webkit_dom_text_track_cue_set_pause_on_exit ()

    void                webkit_dom_text_track_cue_set_pause_on_exit
                                                            (WebKitDOMTextTrackCue *self,
                                                             gboolean value);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gboolean

### webkit_dom_text_track_cue_get_vertical ()

    gchar *             webkit_dom_text_track_cue_get_vertical
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gchar

### webkit_dom_text_track_cue_set_vertical ()

    void                webkit_dom_text_track_cue_set_vertical
                                                            (WebKitDOMTextTrackCue *self,
                                                             const gchar *value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gchar
`error` : | GError

### webkit_dom_text_track_cue_get_snap_to_lines ()

    gboolean            webkit_dom_text_track_cue_get_snap_to_lines
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gboolean

### webkit_dom_text_track_cue_set_snap_to_lines ()

    void                webkit_dom_text_track_cue_set_snap_to_lines
                                                            (WebKitDOMTextTrackCue *self,
                                                             gboolean value);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gboolean

### webkit_dom_text_track_cue_get_line ()

    glong               webkit_dom_text_track_cue_get_line  (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A glong

### webkit_dom_text_track_cue_set_line ()

    void                webkit_dom_text_track_cue_set_line  (WebKitDOMTextTrackCue *self,
                                                             glong value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A glong
`error` : | GError

### webkit_dom_text_track_cue_get_position ()

    glong               webkit_dom_text_track_cue_get_position
                                                            (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A glong

### webkit_dom_text_track_cue_set_position ()

    void                webkit_dom_text_track_cue_set_position
                                                            (WebKitDOMTextTrackCue *self,
                                                             glong value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A glong
`error` : | GError

### webkit_dom_text_track_cue_get_size ()

    glong               webkit_dom_text_track_cue_get_size  (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A glong

### webkit_dom_text_track_cue_set_size ()

    void                webkit_dom_text_track_cue_set_size  (WebKitDOMTextTrackCue *self,
                                                             glong value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A glong
`error` : | GError

### webkit_dom_text_track_cue_get_align ()

    gchar *             webkit_dom_text_track_cue_get_align (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gchar

### webkit_dom_text_track_cue_set_align ()

    void                webkit_dom_text_track_cue_set_align (WebKitDOMTextTrackCue *self,
                                                             const gchar *value,
                                                             GError **error);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gchar
`error` : | GError

### webkit_dom_text_track_cue_get_text ()

    gchar *             webkit_dom_text_track_cue_get_text  (WebKitDOMTextTrackCue *self);

`self` : | A WebKitDOMTextTrackCue
Returns : | A gchar

### webkit_dom_text_track_cue_set_text ()

    void                webkit_dom_text_track_cue_set_text  (WebKitDOMTextTrackCue *self,
                                                             const gchar *value);

`self` : | A WebKitDOMTextTrackCue
`value` : | A gchar

## Property Details

### The `"align"` property

      "align"                    gchar*                : Read / Write

read-only gchar* TextTrackCue:align.

Default value: ""

### The `"end-time"` property

      "end-time"                 gdouble               : Read / Write

read-only gdouble TextTrackCue:end-time.

Default value: 0

### The `"id"` property

      "id"                       gchar*                : Read / Write

read-only gchar* TextTrackCue:id.

Default value: ""

### The `"line"` property

      "line"                     glong                 : Read / Write

read-only glong TextTrackCue:line.

Default value: 0

### The `"pause-on-exit"` property

      "pause-on-exit"            gboolean              : Read / Write

read-only gboolean TextTrackCue:pause-on-exit.

Default value: FALSE

### The `"position"` property

      "position"                 glong                 : Read / Write

read-only glong TextTrackCue:position.

Default value: 0

### The `"size"` property

      "size"                     glong                 : Read / Write

read-only glong TextTrackCue:size.

Default value: 0

### The `"snap-to-lines"` property

      "snap-to-lines"            gboolean              : Read / Write

read-only gboolean TextTrackCue:snap-to-lines.

Default value: FALSE

### The `"start-time"` property

      "start-time"               gdouble               : Read / Write

read-only gdouble TextTrackCue:start-time.

Default value: 0

### The `"text"` property

      "text"                     gchar*                : Read / Write

read-only gchar* TextTrackCue:text.

Default value: ""

### The `"track"` property

      "track"                    WebKitDOMTextTrack*   : Read

read-only WebKitDOMTextTrack* TextTrackCue:track.

### The `"vertical"` property

      "vertical"                 gchar*                : Read / Write

read-only gchar* TextTrackCue:vertical.

Default value: ""