kate_info Struct Reference

#include <kate.h>


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.


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_int32_t gps_numerator
kate_int32_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

Field Documentation

unsigned char kate_info::bitstream_version_major

the version of the bitstream being read or written

unsigned char kate_info::bitstream_version_minor

the version of the bitstream being read or written

kate_text_encoding kate_info::text_encoding

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

kate_text_directionality kate_info::text_directionality

the default text directionality (left to right, etc)

unsigned char kate_info::num_headers

number of header packets in the bitstream

unsigned char kate_info::granule_shift

how many low granpos bits are used for the offset

Examples:
encoding.c.

kate_int32_t kate_info::gps_numerator

granules per second numerator

Examples:
encoding.c.

kate_int32_t kate_info::gps_denominator

granules per second denominator

Examples:
encoding.c.

kate_const char* kate_info::language

based on RFC 3066, 15 character + terminating zero max

kate_const char* kate_info::category

freeform for now, 15 characters + terminating zero max

size_t kate_info::nregions

the number of predefined regions

kate_const kate_region* kate_const* kate_info::regions

the list of predefined regions

size_t kate_info::nstyles

the number of predefined styles

kate_const kate_style* kate_const* kate_info::styles

the list of predefined styles

size_t kate_info::ncurves

the number of predefined curves

kate_const kate_curve* kate_const* kate_info::curves

the list of predefined curves

size_t kate_info::nmotions

the number of predefined motions

kate_const kate_motion* kate_const* kate_info::motions

the list of predefined motions

size_t kate_info::npalettes

the number of predefined palettes

kate_const kate_palette* kate_const* kate_info::palettes

the list of predefined palettes

size_t kate_info::nbitmaps

the number of predefined bitmaps

kate_const kate_bitmap* kate_const* kate_info::bitmaps

the list of predefined bitmaps

size_t kate_info::nfont_ranges

the number of predefined font ranges

kate_const kate_font_range* kate_const* kate_info::font_ranges

the list of predefined font ranges

size_t kate_info::nfont_mappings

the number of predefined font mappings

kate_const kate_font_mapping* kate_const* kate_info::font_mappings

the list of predefined font mappings

kate_markup_type kate_info::text_markup_type

how to interpret any markup found in the text


The documentation for this struct was generated from the following file:
Generated on Sun Jun 22 18:20:28 2008 for libkate by  doxygen 1.5.4