libgutenprint API Reference  5.3.1
Typedefs | Functions
printers.h File Reference

Printer functions. More...

#include <gutenprint/types.h>
#include <gutenprint/string-list.h>
#include <gutenprint/list.h>
#include <gutenprint/vars.h>

Typedefs

typedef struct stp_printer stp_printer_t
 The printer opaque data type (representation of printer model). More...
 

Functions

int stp_printer_model_count (void)
 Get the number of available printer models. More...
 
const stp_printer_tstp_get_printer_by_index (int idx)
 Get a printer model by its index number. More...
 
const stp_printer_tstp_get_printer_by_long_name (const char *long_name)
 Get a printer model by its long (translated) name. More...
 
const stp_printer_tstp_get_printer_by_driver (const char *driver)
 Get a printer model by its short name. More...
 
const stp_printer_tstp_get_printer_by_device_id (const char *device_id)
 Get a printer model by its IEEE 1284 device ID. More...
 
const stp_printer_tstp_get_printer (const stp_vars_t *v)
 Get the printer model from a vars object. More...
 
int stp_get_printer_index_by_driver (const char *driver)
 Get the printer index number from the printer model short (driver) name. More...
 
const char * stp_printer_get_long_name (const stp_printer_t *p)
 Get a printer model's long (translated) name. More...
 
const char * stp_printer_get_driver (const stp_printer_t *p)
 Get a printer model's short (driver) name. More...
 
const char * stp_printer_get_device_id (const stp_printer_t *p)
 Get a printer model's IEEE 1284 device ID, if known. More...
 
const char * stp_printer_get_family (const stp_printer_t *p)
 Get a printer model's family name. More...
 
const char * stp_printer_get_manufacturer (const stp_printer_t *p)
 Get a printer model's manufacturer's name. More...
 
const char * stp_printer_get_comment (const stp_printer_t *p)
 Get a printer model's comment string. More...
 
int stp_printer_get_model (const stp_printer_t *p)
 Get a printer model's model number. More...
 
const stp_vars_tstp_printer_get_defaults (const stp_printer_t *p)
 Get the default vars for a particular printer model. More...
 
void stp_set_printer_defaults (stp_vars_t *v, const stp_printer_t *p)
 Set a vars object to use a particular driver, and set the parameters to their defaults. More...
 
void stp_set_printer_defaults_soft (stp_vars_t *v, const stp_printer_t *p)
 Set a vars object to use a particular driver, and set any unset parameters to their defaults. More...
 
int stp_print (const stp_vars_t *v, stp_image_t *image)
 Print the image. More...
 
int stp_start_job (const stp_vars_t *v, stp_image_t *image)
 Start a print job. More...
 
int stp_end_job (const stp_vars_t *v, stp_image_t *image)
 End a print job. More...
 
stp_string_list_tstp_get_external_options (const stp_vars_t *v)
 Retrieve options that need to be passed to the underlying print system. More...
 
int stp_get_model_id (const stp_vars_t *v)
 
int stp_verify_printer_params (stp_vars_t *v)
 
void stp_initialize_printer_defaults (void)
 
stp_parameter_list_t stp_printer_list_parameters (const stp_vars_t *v)
 
void stp_printer_describe_parameter (const stp_vars_t *v, const char *name, stp_parameter_t *description)
 
const char * stp_describe_output (const stp_vars_t *v)
 

Detailed Description

Printer functions.