papersize

The papersize describes the dimensions of a paper. More...

Data Structures

struct  stp_papersize_t
 The papersize data type. More...

Enumerations

enum  stp_papersize_unit_t { PAPERSIZE_ENGLISH_STANDARD, PAPERSIZE_METRIC_STANDARD, PAPERSIZE_ENGLISH_EXTENDED, PAPERSIZE_METRIC_EXTENDED }
 Units of measurement. More...

Functions

int stp_known_papersizes (void)
 Get the number of available papersizes.
const stp_papersize_tstp_get_papersize_by_name (const char *name)
 Get a papersize by name.
const stp_papersize_tstp_get_papersize_by_size (int length, int width)
 Get a papersize by size.
const stp_papersize_tstp_get_papersize_by_index (int idx)
 Get a papersize by its index number.
void stp_default_media_size (const stp_vars_t *v, int *width, int *height)

Detailed Description

The papersize describes the dimensions of a paper.


Enumeration Type Documentation

enum stp_papersize_unit_t

Units of measurement.

Enumerator:
PAPERSIZE_ENGLISH_STANDARD  English/Imperial units.

PAPERSIZE_METRIC_STANDARD  Metric units.

PAPERSIZE_ENGLISH_EXTENDED  English/Imperial units (optional paper, not displayed by default).

PAPERSIZE_METRIC_EXTENDED  Metric units (optional paper, not displayed by default).


Function Documentation

void stp_default_media_size ( const stp_vars_t v,
int *  width,
int *  height 
)

const stp_papersize_t* stp_get_papersize_by_index ( int  idx  ) 

Get a papersize by its index number.

Parameters:
idx the index number. This must not be greater than (total number of papers - 1).
Returns:
a pointer to the papersize, or NULL on failure. The pointer should not be freed.

const stp_papersize_t* stp_get_papersize_by_name ( const char *  name  ) 

Get a papersize by name.

Parameters:
name the short unique name of the paper.
Returns:
a pointer to the papersize, or NULL on failure. The pointer should not be freed.

const stp_papersize_t* stp_get_papersize_by_size ( int  length,
int  width 
)

Get a papersize by size.

The nearest available size to the size requested will be found.

Parameters:
length the length of the paper.
width the width of the paper
Returns:
a pointer to the papersize, or NULL on failure. The pointer should not be freed.

int stp_known_papersizes ( void   ) 

Get the number of available papersizes.

Returns:
the number of papersizes.


Generated on Sun Jun 17 10:42:00 2007 for libgutenprint API Reference by  doxygen 1.5.2