LibUMD definitions, data structures and functions


Classes

struct  umd_cover_t
struct  umd_chapter_t

Defines

#define UMD_LOG(f)   ((void (*) (void *, const char *, ...)) f)

Typedefs

typedef void(* umd_log )(void *, const char *,...)
typedef struct umd_s umd_t
typedef struct umd_page_s umd_page_t

Enumerations

enum  umd_type_t { UMD_TEXT, UMD_IMAGE }

Functions

umd_tumd_new ()
 new a umd struct
void umd_free (umd_t *umd)
 free the umd struct resources, but not free ths struct
void umd_destroy (umd_t *umd)
 destroy a umd struct. This will free the umd struct
umd_tumd_new_from_file (const char *file)
 new a umd from a input file
int umd_parser_file (umd_t *umd, const char *file)
 parser a umd file to umd struct
void umd_set_log (umd_t *umd, int loglevel, umd_log log, void *arg)
 set umd log callback
void umd_set_font_face (umd_t *umd, const char *face, int italic, int bold)
 set render font face
char * umd_get_title (umd_t *umd)
 get book title
char * umd_get_author (umd_t *umd)
 get book author
char * umd_get_year (umd_t *umd)
 get book year
char * umd_get_month (umd_t *umd)
 get book month
char * umd_get_day (umd_t *umd)
 get book day
char * umd_get_type (umd_t *umd)
 get book type
char * umd_get_publisher (umd_t *umd)
 get book publisher
char * umd_get_vendor (umd_t *umd)
 get book vendor
char * umd_get_content (umd_t *umd, size_t *lenp)
 get book content
int umd_get_chapter_n (umd_t *umd)
 get chapter count of a umd struct
umd_chapter_tumd_get_nth_chapter (umd_t *umd, size_t id)
 get chapter of a umd struct
umd_cover_tumd_get_cover (umd_t *umd)
 get cover of a umd struct
int * umd_write_file (umd_t *umd, const char *file)
 write a umd_t to a file
int * umd_write_fp (umd_t *umd, FILE *fp)
 write a umd_t to a file descriptor
void umd_fprintf (umd_t *umd, FILE *fp)
 printf umd struct for debug
int umd_get_page_n (umd_t *umd)
 get page count of a umd struct
umd_page_tumd_get_nth_page (umd_t *umd, size_t id)
 get page of a umd struct
int umd_page_get_content (umd_page_t *page, char *buf, size_t size)
 get page content
void umd_page_free (umd_page_t *page)
 free a page
int umd_page_get_size (umd_page_t *page, int *px, int *py)
 get page size
int umd_page_render (umd_page_t *page, int fromx, int fromy, int tox, int toy, double zm, int rot, unsigned char *buffer, size_t size)
 render umd page to a gdk-pixbuf

Define Documentation

#define UMD_LOG (  )     ((void (*) (void *, const char *, ...)) f)

UMD log callback


Typedef Documentation

typedef void(* umd_log)(void *, const char *,...)

UMD log callback function

typedef struct umd_page_s umd_page_t

UMD book page

typedef struct umd_s umd_t

UMD book type


Enumeration Type Documentation

enum umd_type_t

UMD type

Enumerator:
UMD_TEXT  common text
UMD_IMAGE  image


Function Documentation

void umd_destroy ( umd_t umd  ) 

destroy a umd struct. This will free the umd struct

Parameters:
umd umd struct pointer
Returns:
null

void umd_fprintf ( umd_t umd,
FILE *  fp 
)

printf umd struct for debug

Parameters:
umd umd struct
fp file pointer
Returns:
null

void umd_free ( umd_t umd  ) 

free the umd struct resources, but not free ths struct

Parameters:
umd umd struct
Returns:
null

char* umd_get_author ( umd_t umd  ) 

get book author

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

int umd_get_chapter_n ( umd_t umd  ) 

get chapter count of a umd struct

Parameters:
umd umd struct
Returns:
int count

new allocated char string. Warning: need freed by user.

char* umd_get_content ( umd_t umd,
size_t *  lenp 
)

get book content

Parameters:
umd umd struct
lenp size_t pointer for save the string length
Returns:
new allocated char string. Warning: need freed by user.

umd_cover_t* umd_get_cover ( umd_t umd  ) 

get cover of a umd struct

Parameters:
umd umd struct
Returns:
umd_cover_t

char* umd_get_day ( umd_t umd  ) 

get book day

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

char* umd_get_month ( umd_t umd  ) 

get book month

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

umd_chapter_t* umd_get_nth_chapter ( umd_t umd,
size_t  id 
)

get chapter of a umd struct

Parameters:
umd umd struct
id chapter id
Returns:
umd_chapter_t

umd_page_t* umd_get_nth_page ( umd_t umd,
size_t  id 
)

get page of a umd struct

Parameters:
umd umd struct
id page id
Returns:
umd_page_t

int umd_get_page_n ( umd_t umd  ) 

get page count of a umd struct

Parameters:
umd umd struct
Returns:
int count

char* umd_get_publisher ( umd_t umd  ) 

get book publisher

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

char* umd_get_title ( umd_t umd  ) 

get book title

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

char* umd_get_type ( umd_t umd  ) 

get book type

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

char* umd_get_vendor ( umd_t umd  ) 

get book vendor

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

char* umd_get_year ( umd_t umd  ) 

get book year

Parameters:
umd umd struct
Returns:
new allocated char string. Warning: need freed by user.

umd_t* umd_new (  ) 

new a umd struct

Returns:
umd_t umd struct

umd_t* umd_new_from_file ( const char *  file  ) 

new a umd from a input file

Parameters:
file input file
Returns:
umd_t umd struct

void umd_page_free ( umd_page_t page  ) 

free a page

Parameters:
page umd page struct

int umd_page_get_content ( umd_page_t page,
char *  buf,
size_t  size 
)

get page content

Parameters:
page umd page struct
buf output buffer
size output buffer size
Returns:
content size

int umd_page_get_size ( umd_page_t page,
int *  px,
int *  py 
)

get page size

Parameters:
page umd_page_t struct
px width pointer
py height pointer
Returns:
0 on OK or < 0 on error

int umd_page_render ( umd_page_t page,
int  fromx,
int  fromy,
int  tox,
int  toy,
double  zm,
int  rot,
unsigned char *  buffer,
size_t  size 
)

render umd page to a gdk-pixbuf

Parameters:
page umd_page_t struct
fromx from x
fromy from y
tox to x
toy to y
zm zoom rate
rot weather rotation
buffer output buffer
size buffer size
Returns:
0 on OK or < 0 on error

int umd_parser_file ( umd_t umd,
const char *  file 
)

parser a umd file to umd struct

Parameters:
umd umd struct
file umd file name
Returns:
int return 0 on OK or < 0 on error

void umd_set_font_face ( umd_t umd,
const char *  face,
int  italic,
int  bold 
)

set render font face

Parameters:
umd umd struct
face font family, like 'Sans', 'serif', ...
italic weather font is italic
bold weather font is bold
Returns:
null

void umd_set_log ( umd_t umd,
int  loglevel,
umd_log  log,
void *  arg 
)

set umd log callback

Parameters:
umd umd struct
loglevel log level: 0, 1, or 2
log log callback function
arg user argument
Returns:
null

int* umd_write_file ( umd_t umd,
const char *  file 
)

write a umd_t to a file

Parameters:
umd umd struct
file output file name
Returns:
int

int* umd_write_fp ( umd_t umd,
FILE *  fp 
)

write a umd_t to a file descriptor

Parameters:
umd umd struct
fp output file descriptor
Returns:
int


Generated on Fri Jan 7 16:08:56 2011 for LibUMD by  doxygen 1.5.6