libkate  0.4.1
Data Fields
kate_info Struct Reference

#include <kate.h>

Data Fields

unsigned char bitstream_version_major
 
unsigned char bitstream_version_minor
 
kate_text_encoding text_encoding
 
kate_text_directionality text_directionality
 
unsigned char num_headers
 
unsigned char granule_shift
 
kate_uint32_t gps_numerator
 
kate_uint32_t gps_denominator
 
kate_const char * language
 
kate_const char * category
 
size_t nregions
 
kate_const kate_region *kate_const * regions
 
size_t nstyles
 
kate_const kate_style *kate_const * styles
 
size_t ncurves
 
kate_const kate_curve *kate_const * curves
 
size_t nmotions
 
kate_const kate_motion *kate_const * motions
 
size_t npalettes
 
kate_const kate_palette *kate_const * palettes
 
size_t nbitmaps
 
kate_const kate_bitmap *kate_const * bitmaps
 
size_t nfont_ranges
 
kate_const kate_font_range *kate_const * font_ranges
 
size_t nfont_mappings
 
kate_const kate_font_mapping *kate_const * font_mappings
 
kate_markup_type text_markup_type
 
size_t original_canvas_width
 
size_t original_canvas_height
 

Detailed Description

Information about a Kate bitstream. On encoding, this information will be filled by the encoder. On decoding, it will be extracted from the stream headers.

Examples:
decoding.c, and encoding.c.

Field Documentation

§ bitmaps

kate_const kate_bitmap* kate_const* kate_info::bitmaps

§ bitstream_version_major

unsigned char kate_info::bitstream_version_major

the version of the bitstream being read or written

Referenced by kate_decode_init(), kate_decode_is_idheader(), and kate_info_init().

§ bitstream_version_minor

unsigned char kate_info::bitstream_version_minor

the version of the bitstream being read or written

Referenced by kate_decode_init(), kate_decode_is_idheader(), and kate_info_init().

§ category

kate_const char* kate_info::category

freeform for now, 15 characters + terminating zero max

Referenced by kate_decode_is_idheader(), kate_encode_init(), kate_info_clear(), kate_info_init(), and kate_info_set_category().

§ curves

kate_const kate_curve* kate_const* kate_info::curves

§ font_mappings

kate_const kate_font_mapping* kate_const* kate_info::font_mappings

§ font_ranges

kate_const kate_font_range* kate_const* kate_info::font_ranges

§ gps_denominator

kate_uint32_t kate_info::gps_denominator

§ gps_numerator

kate_uint32_t kate_info::gps_numerator

§ granule_shift

unsigned char kate_info::granule_shift

§ language

kate_const char* kate_info::language

based on RFC 3066, 15 character + terminating zero max

Referenced by kate_decode_is_idheader(), kate_encode_init(), kate_info_clear(), kate_info_init(), kate_info_matches_language(), and kate_info_set_language().

§ motions

kate_const kate_motion* kate_const* kate_info::motions

§ nbitmaps

size_t kate_info::nbitmaps

§ ncurves

size_t kate_info::ncurves

§ nfont_mappings

size_t kate_info::nfont_mappings

§ nfont_ranges

size_t kate_info::nfont_ranges

§ nmotions

size_t kate_info::nmotions

§ npalettes

size_t kate_info::npalettes

§ nregions

size_t kate_info::nregions

§ nstyles

size_t kate_info::nstyles

§ num_headers

unsigned char kate_info::num_headers

number of header packets in the bitstream

Referenced by kate_decode_is_idheader(), kate_encode_init(), and kate_info_init().

§ original_canvas_height

size_t kate_info::original_canvas_height

height of the canvas this stream was authored for

Referenced by kate_decode_is_idheader(), kate_encode_init(), kate_info_init(), and kate_info_set_original_canvas_size().

§ original_canvas_width

size_t kate_info::original_canvas_width

width of the canvas this stream was authored for

Referenced by kate_decode_is_idheader(), kate_encode_init(), kate_info_init(), and kate_info_set_original_canvas_size().

§ palettes

kate_const kate_palette* kate_const* kate_info::palettes

§ regions

kate_const kate_region* kate_const* kate_info::regions

§ styles

kate_const kate_style* kate_const* kate_info::styles

§ text_directionality

kate_text_directionality kate_info::text_directionality

the default text directionality (left to right, etc)

Referenced by kate_decode_is_idheader(), kate_encode_init(), kate_info_init(), and kate_info_set_text_directionality().

§ text_encoding

kate_text_encoding kate_info::text_encoding

the default text encoding (utf-8 only for now)

Referenced by kate_decode_is_idheader(), kate_encode_init(), and kate_info_init().

§ text_markup_type

kate_markup_type kate_info::text_markup_type

how to interpret any markup found in the text

Referenced by kate_encode_init(), kate_info_init(), and kate_info_set_markup_type().


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