Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

ioapi.h File Reference

#include "scconfig.h"

Include dependency graph for ioapi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  zlib_filefunc_def_s

Defines

#define ZLIB_FILEFUNC_SEEK_CUR   (1)
#define ZLIB_FILEFUNC_SEEK_END   (2)
#define ZLIB_FILEFUNC_SEEK_SET   (0)
#define ZLIB_FILEFUNC_MODE_READ   (1)
#define ZLIB_FILEFUNC_MODE_WRITE   (2)
#define ZLIB_FILEFUNC_MODE_READWRITEFILTER   (3)
#define ZLIB_FILEFUNC_MODE_EXISTING   (4)
#define ZLIB_FILEFUNC_MODE_CREATE   (8)
#define ZCALLBACK
#define ZREAD(filefunc, filestream, buf, size)   ((*((filefunc).zread_file))((filefunc).opaque,filestream,buf,size))
#define ZWRITE(filefunc, filestream, buf, size)   ((*((filefunc).zwrite_file))((filefunc).opaque,filestream,buf,size))
#define ZTELL(filefunc, filestream)   ((*((filefunc).ztell_file))((filefunc).opaque,filestream))
#define ZSEEK(filefunc, filestream, pos, mode)   ((*((filefunc).zseek_file))((filefunc).opaque,filestream,pos,mode))
#define ZCLOSE(filefunc, filestream)   ((*((filefunc).zclose_file))((filefunc).opaque,filestream))
#define ZERROR(filefunc, filestream)   ((*((filefunc).zerror_file))((filefunc).opaque,filestream))

Typedefs

typedef const char * filename
typedef const char int mode
typedef voidpf stream
typedef voidpf void * buf
typedef voidpf void uLong size
typedef voidpf uLong offset
typedef voidpf uLong int origin
typedef struct zlib_filefunc_def_s zlib_filefunc_def

Functions

typedef voidpf (ZCALLBACK *open_file_func) OF((voidpf opaque
typedef uLong (ZCALLBACK *read_file_func) OF((voidpf opaque
typedef long (ZCALLBACK *tell_file_func) OF((voidpf opaque
typedef int (ZCALLBACK *close_file_func) OF((voidpf opaque
void fill_fopen_filefunc OF ((zlib_filefunc_def *pzlib_filefunc_def))


Define Documentation

#define ZCALLBACK

Definition at line 38 of file ioapi.h.

#define ZCLOSE ( filefunc,
filestream   )     ((*((filefunc).zclose_file))((filefunc).opaque,filestream))

Definition at line 74 of file ioapi.h.

#define ZERROR ( filefunc,
filestream   )     ((*((filefunc).zerror_file))((filefunc).opaque,filestream))

Definition at line 75 of file ioapi.h.

#define ZLIB_FILEFUNC_MODE_CREATE   (8)

Definition at line 30 of file ioapi.h.

#define ZLIB_FILEFUNC_MODE_EXISTING   (4)

Definition at line 29 of file ioapi.h.

#define ZLIB_FILEFUNC_MODE_READ   (1)

Definition at line 25 of file ioapi.h.

#define ZLIB_FILEFUNC_MODE_READWRITEFILTER   (3)

Definition at line 27 of file ioapi.h.

#define ZLIB_FILEFUNC_MODE_WRITE   (2)

Definition at line 26 of file ioapi.h.

#define ZLIB_FILEFUNC_SEEK_CUR   (1)

Definition at line 21 of file ioapi.h.

#define ZLIB_FILEFUNC_SEEK_END   (2)

Definition at line 22 of file ioapi.h.

#define ZLIB_FILEFUNC_SEEK_SET   (0)

Definition at line 23 of file ioapi.h.

#define ZREAD ( filefunc,
filestream,
buf,
size   )     ((*((filefunc).zread_file))((filefunc).opaque,filestream,buf,size))

Definition at line 70 of file ioapi.h.

#define ZSEEK ( filefunc,
filestream,
pos,
mode   )     ((*((filefunc).zseek_file))((filefunc).opaque,filestream,pos,mode))

Definition at line 73 of file ioapi.h.

#define ZTELL ( filefunc,
filestream   )     ((*((filefunc).ztell_file))((filefunc).opaque,filestream))

Definition at line 72 of file ioapi.h.

#define ZWRITE ( filefunc,
filestream,
buf,
size   )     ((*((filefunc).zwrite_file))((filefunc).opaque,filestream,buf,size))

Definition at line 71 of file ioapi.h.


Typedef Documentation

typedef voidpf const void * buf

Definition at line 47 of file ioapi.h.

typedef const char* filename

Definition at line 46 of file ioapi.h.

typedef const char int mode

Definition at line 46 of file ioapi.h.

typedef voidpf uLong offset

Definition at line 50 of file ioapi.h.

typedef voidpf uLong int origin

Definition at line 50 of file ioapi.h.

typedef voidpf const void uLong size

Definition at line 47 of file ioapi.h.

typedef voidpf stream

Definition at line 47 of file ioapi.h.


Function Documentation

typedef int ( ZCALLBACK *  close_file_func  ) 

typedef long ( ZCALLBACK *  tell_file_func  ) 

void fill_fopen_filefunc OF ( (zlib_filefunc_def *pzlib_filefunc_def)   ) 

typedef uLong ( ZCALLBACK *  read_file_func  ) 

Referenced by CompressArray(), and CompressStr().

typedef voidpf ( ZCALLBACK *  open_file_func  ) 

Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.