Documentation from print.h

Introduction	[top]

ROV - Easy applications from C

Copyright - © Jason Tribbeck / 7th ARM 1994-2001

Contributing authors - Jason Tribbeck

File - print.h

Type - subsystem

Description

The print subsystem is used for interfacing to printers.

print_pagesizestr (type definition)	[top]

Definition of a page size.

Fields:

 - int x_size - the width of the page.
 - int y_size - the height of the page.
 - int left - the left hand margin.
 - int bottom - the bottom margin.
 - int right - the right hand margin.
 - int top - the top margin.

typedef struct {
  int x_size;
  int y_size;
  int left;
  int bottom;
  int right;
  int top;
} print_pagesizestr;

print_plotrectangle (type definition)	[top]

Definition of a plot rectangle.

Fields:

 - int x0 - the left hand side.
 - int y0 - the bottom.
 - int x1 - the right hand side.
 - int y1 - the top.

typedef struct {
  int x0;
  int y0;
  int x1;
  int y1;
} print_plotrectangle;

print_transform (type definition)	[top]

Definition of a print transformation.

Fields:

 - int a - the first part of the matrix.
 - int b - the second part of the matrix.
 - int c - the third part of the matrix.
 - int d - the fourth part of the matrix.

typedef struct {
  int a;
  int b;
  int c;
  int d;
} print_transform;

print_offset (type definition)	[top]

Defintion of a print offset.

Fields:

 - int ox - the x offset.
 - int oy - the y offset.

typedef struct {
  int ox;
  int oy;
} print_offset;

print_update (function pointer)	[top]

Definition of a print rectangle.

Parameters:

 - int job - the job number.
 - print_plotrectangle *rect - the rectangle to print.

typedef void (* print_update)(int job,
			      print_plotrectangle *rect);

print_getprintername	[top]

Get the name of the printer.

Returns:

 -  the name of the printer, or NULL if no printer driver loaded.

char *print_getprintername(void);

print_getfeatures	[top]

Get the printer features.

Returns:

 -  the printer features.

int print_getfeatures(void);

print_pagesize	[top]

Get the page size

Parameters:

 - print_pagesizestr *page_size - the buffer to hold the page size.

void print_pagesize(print_pagesizestr *page_size);

print_selectjob	[top]

Makes a print job the current job.

Parameters:

 - int job - the job to use.
 - char *text - the page text. ???

Returns:

 -  non-zero for success.

int print_selectjob(int job,
		    char * text);

print_currentjob	[top]

Get the current print job.

Returns:

 -  the current print job.

int print_currentjob(void);

print_endjob	[top]

End a print job.

Parameters:

 - int job - the job to end.

void print_endjob(int job);

print_abortjob	[top]

Abort a print job.

Parameters:

 - int job - the job to abort.

void print_abortjob(int job);

print_giverectangle	[top]

Give a print rectangle to a job.

Parameters:

 - int job - the job.
 - print_plotrectangle *rect - the print rectangle.
 - print_transform *xform - the print transform.
 - print_offset *offset - the print offset.
 - int page - the page number. ???

void print_giverectangle(int job,
			 print_plotrectangle *rect,
			 print_transform *xform,
			 print_offset *offset,
			 int page);

print_print	[top]

Start printing.

Parameters:

 - int job - the job to print.
 - int page - the page to print. ???
 - char *title - the job title.
 - print_update update - the print update handler.

Returns:

 -  an error, or NULL if no error has occurred.

_kernel_oserror * print_print(int job,
			      int page,
			      char *title,
			      print_update update);

print_canceljob	[top]

Cancel a job.

Parameters:

 - int job - the job to cancel.

void print_canceljob(int job);

See also: print_canceljobwitherror()

print_canceljobwitherror	[top]

Cancel a job with an error.

Parameters:

 - int job - the job to cancel.

void print_canceljobwitherror(int job);

See also: print_canceljob()

print_declarefont	[top]

Declare a font before printing.

Parameters:

 - int job - the print job.
 - char *font - the font name.
 - int size - the font size.???

void print_declarefont(int job,
		       char *font,
		       int size);

print_openfile	[top]

Open a file.

Parameters:

 - char *file_name - the name of the file.

Returns:

 -  the file handle.

int print_openfile(char * file_name);

See also: print_closefile()

print_closefile	[top]

Close a file.

Parameters:

 - int handle - the file handle.

void print_closefile(int handle);

See also: print_openfile()

Generated Thu Feb 7 23:22:52 2002