document_desc Struct Reference

Parameter description for the to be processed print job. More...

Data Fields
int	fh
const char *	mime_type
unsigned	copies
unsigned	collate:1
unsigned	duplex_long_edge:1
unsigned	duplex_short_edge:1
unsigned	fidelity:1
unsigned	rotation_auto:1
enum caps_rstr_orientation	orientation
unsigned	fit_auto:1
unsigned	fit_to_medium:1
unsigned	fit_to_imageable_area:1
enum caps_rstr_alignment	alignment
struct caps_ppd_resolution	resolution
struct caps_ppd_options_table *	ppd_options
struct doc_page_range	page_range_info
struct rstr_print_state	state
struct caps_rstr_page_desc	pg_desc
struct caps_job_progression	prog_info

Detailed Description

Filled in by the framework. All known and default settings and modifiable by the user

All values start with a default. Then the user settings are processed and modify the entries accordingly.

Field Documentation

fh

int fh

file handle to access the job's content

mime_type

const char* mime_type

The MIME type of the document

copies

unsigned copies

Media copy count, -> caps_rstr_job_copies_get()

collate

unsigned collate

non-collating job = 0, else collating job, -> caps_rstr_job_is_collating()

duplex_long_edge

unsigned duplex_long_edge

'1' = Duplex print, flip over long medium edge, related to printing parameter 'sides=two-sided-long-edge', -> caps_rstr_job_is_duplex()

duplex_short_edge

unsigned duplex_short_edge

'1' = Duplex print, flip over short medium edge, related to printing parameter 'sides=two-sided-short-edge' -> caps_rstr_job_is_duplex()

fidelity

unsigned fidelity

User wants fidelity, refer ipp_get_fidelity_value()

rotation_auto

unsigned rotation_auto

'1' by default, we should do our best to guess the correct rotation on demand

orientation

enum caps_rstr_orientation orientation

JOB_ORIENTATION_UNSET is the default to not change the orientation, I need a value for don't touch source orientation -> rotation_auto == 0 and orientation = 0°?

fit_auto

unsigned fit_auto

Favour the media settings to print the document.

fit_to_medium

unsigned fit_to_medium

'1' if to scale (up or down) the document to fit to the print medium

fit_to_imageable_area

unsigned fit_to_imageable_area

'1' if to scale (up or down) the document to fit to the print medium and its imageable area

alignment

enum caps_rstr_alignment alignment

Alignment of the document content to a larger print medium

resolution

struct caps_ppd_resolution resolution

Print resolution [DPI], related to printing parameter 'printer-resolution=somevalue', -> caps_rstr_job_resolution_get()

ppd_options

struct caps_ppd_options_table* ppd_options

current PPD settings, with all PPD related printing parameters applied to

page_range_info

struct doc_page_range page_range_info

state

struct rstr_print_state state

keep track of the printing precedure

pg_desc

struct caps_rstr_page_desc pg_desc

Information collection for the printer driver of the current page to print

prog_info

struct caps_job_progression prog_info

Internal track of printing progression

---

The documentation for this struct was generated from the following file:

• libcapsraster/src/libcapsraster-local.h