kate_event Struct Reference

#include <kate.h>


Data Fields

kate_int64_t start
kate_int64_t duration
kate_int64_t backlink
kate_float start_time
kate_float end_time
kate_int32_t id
kate_text_encoding text_encoding
kate_text_directionality text_directionality
kate_const char * language
kate_const char * text
size_t len
size_t len0
size_t nmotions
kate_const kate_motion
*kate_const * 
motions
kate_const kate_regionregion
kate_const kate_stylestyle
kate_const kate_stylesecondary_style
kate_const kate_font_mappingfont_mapping
kate_const kate_palettepalette
kate_const kate_bitmapbitmap
kate_markup_type text_markup_type
size_t nbitmaps
kate_const kate_bitmap
*kate_const * 
bitmaps


Detailed Description

This is an event passed to the user. A kate_tracker may be used to track animation changes to this event.
Examples:

decoding.c, and high.c.


Field Documentation

kate_int64_t kate_event::start

the time at offset rate at which this event starts

kate_int64_t kate_event::duration

the duration in granules

kate_int64_t kate_event::backlink

the relative offset in granules since the start of the earliest still active event (positive or zero)

the time at which this event starts

Referenced by kate_tracker_remap(), and kate_tracker_update().

the time at which this event ends

Referenced by kate_tracker_remap(), and kate_tracker_update().

kate_int32_t kate_event::id

unique id to identify this event

character encoding for the text in this event

Referenced by kate_tracker_init().

directionality of the text in this event

kate_const char* kate_event::language

language of the text in this event (may be NULL if no override)

kate_const char* kate_event::text

the event text (may be NULL if none)

Examples:
decoding.c, and high.c.

Referenced by kate_tracker_init().

length in bytes of the text

length in bytes of the text, including terminating zero(s)

Referenced by kate_tracker_init().

number of attached motions (may be zero)

Referenced by kate_tracker_update().

kate_const kate_motion* kate_const* kate_event::motions

the list of attached motions (may be NULL if none)

region to display in (may be NULL for no particular region)

Referenced by kate_tracker_update().

style to display text (may be NULL for no particular style)

Referenced by kate_tracker_update().

secondary style to display text (may be NULL for no particular style)

Referenced by kate_tracker_update().

font mapping to use for the text (may be NULL for no particular mapping)

palette to use as background (may be NULL for none)

bitmap to use as background (may be NULL for none)

Referenced by kate_tracker_remap().

how to interpret any markup found in the text

number of attached bitmaps (may be zero)

kate_const kate_bitmap* kate_const* kate_event::bitmaps

the list of attached bitmaps (may be NULL if none)


The documentation for this struct was generated from the following file:

Generated on Thu Dec 17 17:51:41 2015 for libkate by  doxygen 1.5.6