|
Data Structures |
struct | stp_raw_t |
| Raw parameter. More...
|
struct | stp_double_bound_t |
| double_bound (range) parameter. More...
|
struct | stp_int_bound_t |
| int_bound (range) parameter. More...
|
struct | stp_parameter_t |
| Parameter description. More...
|
Typedefs |
typedef stp_vars | stp_vars_t |
| The vars opaque data type.
|
typedef void * | stp_parameter_list_t |
| The parameter_list opaque data type.
|
typedef const void * | stp_const_parameter_list_t |
| The constant parameter_list opaque data type.
|
typedef void(* | stp_outfunc_t )(void *data, const char *buffer, size_t bytes) |
| Output function supplied by the calling application.
|
typedef void *(* | stp_copy_data_func_t )(void *) |
typedef void(* | stp_free_data_func_t )(void *) |
typedef stp_compdata | compdata_t |
Enumerations |
enum | stp_parameter_type_t {
STP_PARAMETER_TYPE_STRING_LIST,
STP_PARAMETER_TYPE_INT,
STP_PARAMETER_TYPE_BOOLEAN,
STP_PARAMETER_TYPE_DOUBLE,
STP_PARAMETER_TYPE_CURVE,
STP_PARAMETER_TYPE_FILE,
STP_PARAMETER_TYPE_RAW,
STP_PARAMETER_TYPE_ARRAY,
STP_PARAMETER_TYPE_DIMENSION,
STP_PARAMETER_TYPE_INVALID
} |
| Parameter types. More...
|
enum | stp_parameter_class_t { STP_PARAMETER_CLASS_FEATURE,
STP_PARAMETER_CLASS_OUTPUT,
STP_PARAMETER_CLASS_CORE,
STP_PARAMETER_CLASS_INVALID
} |
| Parameter class. More...
|
enum | stp_parameter_level_t {
STP_PARAMETER_LEVEL_BASIC,
STP_PARAMETER_LEVEL_ADVANCED,
STP_PARAMETER_LEVEL_ADVANCED1,
STP_PARAMETER_LEVEL_ADVANCED2,
STP_PARAMETER_LEVEL_ADVANCED3,
STP_PARAMETER_LEVEL_ADVANCED4,
STP_PARAMETER_LEVEL_INTERNAL,
STP_PARAMETER_LEVEL_EXTERNAL,
STP_PARAMETER_LEVEL_INVALID
} |
| Parameter level. More...
|
enum | stp_parameter_activity_t { STP_PARAMETER_INACTIVE,
STP_PARAMETER_DEFAULTED,
STP_PARAMETER_ACTIVE
} |
| Parameter activity. More...
|
enum | stp_parameter_verify_t { PARAMETER_BAD,
PARAMETER_OK,
PARAMETER_INACTIVE
} |
Functions |
stp_vars_t * | stp_vars_create (void) |
| Create a new vars object.
|
void | stp_vars_copy (stp_vars_t *dest, const stp_vars_t *source) |
| Copy a vars object.
|
stp_vars_t * | stp_vars_create_copy (const stp_vars_t *source) |
| Copy and allocate a vars object.
|
void | stp_vars_destroy (stp_vars_t *v) |
| Destroy a vars object.
|
void | stp_set_driver (stp_vars_t *v, const char *val) |
| Set the name of the printer driver.
|
void | stp_set_driver_n (stp_vars_t *v, const char *val, int bytes) |
| Set the name of the printer driver.
|
const char * | stp_get_driver (const stp_vars_t *v) |
| Get the name of the printer driver.
|
void | stp_set_color_conversion (stp_vars_t *v, const char *val) |
| Set the name of the color conversion routine, if not the default.
|
void | stp_set_color_conversion_n (stp_vars_t *v, const char *val, int bytes) |
| Set the name of the color conversion routine, if not the default.
|
const char * | stp_get_color_conversion (const stp_vars_t *v) |
| Get the name of the color conversion routine.
|
void | stp_set_left (stp_vars_t *v, int val) |
| Set the left edge of the image.
|
int | stp_get_left (const stp_vars_t *v) |
| Get the left edge of the image.
|
void | stp_set_top (stp_vars_t *v, int val) |
| Set the top edge of the image.
|
int | stp_get_top (const stp_vars_t *v) |
| Get the top edge of the image.
|
void | stp_set_width (stp_vars_t *v, int val) |
| Set the width of the image.
|
int | stp_get_width (const stp_vars_t *v) |
| Get the width edge of the image.
|
void | stp_set_height (stp_vars_t *v, int val) |
| Set the height of the image.
|
int | stp_get_height (const stp_vars_t *v) |
| Get the height of the image.
|
void | stp_set_page_width (stp_vars_t *v, int val) |
| Set the page width.
|
int | stp_get_page_width (const stp_vars_t *v) |
| Get the page width.
|
void | stp_set_page_height (stp_vars_t *v, int val) |
| Set the page height.
|
int | stp_get_page_height (const stp_vars_t *v) |
| Get the page height.
|
void | stp_set_outfunc (stp_vars_t *v, stp_outfunc_t val) |
| Set the function used to print output information.
|
stp_outfunc_t | stp_get_outfunc (const stp_vars_t *v) |
| Get the function used to print output information.
|
void | stp_set_errfunc (stp_vars_t *v, stp_outfunc_t val) |
| Set the function used to print error and diagnostic information.
|
stp_outfunc_t | stp_get_errfunc (const stp_vars_t *v) |
| Get the function used to print output information.
|
void | stp_set_outdata (stp_vars_t *v, void *val) |
| Set the output data.
|
void * | stp_get_outdata (const stp_vars_t *v) |
| Get the output data.
|
void | stp_set_errdata (stp_vars_t *v, void *val) |
| Set the error data.
|
void * | stp_get_errdata (const stp_vars_t *v) |
| Get the error data.
|
void | stp_merge_printvars (stp_vars_t *user, const stp_vars_t *print) |
| Merge defaults for a printer with user-chosen settings.
|
stp_parameter_list_t | stp_get_parameter_list (const stp_vars_t *v) |
| List the available parameters for the currently chosen settings.
|
size_t | stp_parameter_list_count (stp_const_parameter_list_t list) |
| List the number of available parameters for the currently chosen settings.
|
const stp_parameter_t * | stp_parameter_find (stp_const_parameter_list_t list, const char *name) |
| Find a parameter by its name.
|
const stp_parameter_t * | stp_parameter_list_param (stp_const_parameter_list_t list, size_t item) |
| Find a parameter by its index number.
|
void | stp_parameter_list_destroy (stp_parameter_list_t list) |
| Destroy a parameter_list.
|
stp_parameter_list_t | stp_parameter_list_create (void) |
| Create a parameter_list.
|
void | stp_parameter_list_add_param (stp_parameter_list_t list, const stp_parameter_t *item) |
| Add a parameter to a parameter_list.
|
stp_parameter_list_t | stp_parameter_list_copy (stp_const_parameter_list_t list) |
| Copy and allocate a parameter_list.
|
void | stp_parameter_list_append (stp_parameter_list_t list, stp_const_parameter_list_t append) |
| Append one parameter_list to another.
|
void | stp_describe_parameter (const stp_vars_t *v, const char *name, stp_parameter_t *description) |
| Describe a parameter in detail.
|
void | stp_parameter_description_destroy (stp_parameter_t *description) |
| Destroy a parameter description.
|
const stp_parameter_t * | stp_parameter_find_in_settings (const stp_vars_t *v, const char *name) |
| Find a parameter by its name from a vars object.
|
void | stp_set_string_parameter (stp_vars_t *v, const char *parameter, const char *value) |
| Set a string parameter.
|
void | stp_set_string_parameter_n (stp_vars_t *v, const char *parameter, const char *value, size_t bytes) |
| Set a string parameter.
|
void | stp_set_file_parameter (stp_vars_t *v, const char *parameter, const char *value) |
| Set a file parameter.
|
void | stp_set_file_parameter_n (stp_vars_t *v, const char *parameter, const char *value, size_t bytes) |
| Set a file parameter.
|
void | stp_set_float_parameter (stp_vars_t *v, const char *parameter, double value) |
| Set a float parameter.
|
void | stp_set_int_parameter (stp_vars_t *v, const char *parameter, int value) |
| Set an integer parameter.
|
void | stp_set_dimension_parameter (stp_vars_t *v, const char *parameter, int value) |
| Set a dimension parameter.
|
void | stp_set_boolean_parameter (stp_vars_t *v, const char *parameter, int value) |
| Set a boolean parameter.
|
void | stp_set_curve_parameter (stp_vars_t *v, const char *parameter, const stp_curve_t *value) |
| Set a curve parameter.
|
void | stp_set_array_parameter (stp_vars_t *v, const char *parameter, const stp_array_t *value) |
| Set an array parameter.
|
void | stp_set_raw_parameter (stp_vars_t *v, const char *parameter, const void *value, size_t bytes) |
| Set a raw parameter.
|
void | stp_scale_float_parameter (stp_vars_t *v, const char *parameter, double scale) |
| Multiply the value of a float parameter by a scaling factor.
|
void | stp_set_default_string_parameter (stp_vars_t *v, const char *parameter, const char *value) |
| Set a default string parameter.
|
void | stp_set_default_string_parameter_n (stp_vars_t *v, const char *parameter, const char *value, size_t bytes) |
| Set a default string parameter.
|
void | stp_set_default_file_parameter (stp_vars_t *v, const char *parameter, const char *value) |
| Set a default file parameter.
|
void | stp_set_default_file_parameter_n (stp_vars_t *v, const char *parameter, const char *value, size_t bytes) |
| Set a default file parameter.
|
void | stp_set_default_float_parameter (stp_vars_t *v, const char *parameter, double value) |
| Set a default float parameter.
|
void | stp_set_default_int_parameter (stp_vars_t *v, const char *parameter, int value) |
| Set a default integer parameter.
|
void | stp_set_default_dimension_parameter (stp_vars_t *v, const char *parameter, int value) |
| Set a default dimension parameter.
|
void | stp_set_default_boolean_parameter (stp_vars_t *v, const char *parameter, int value) |
| Set a default boolean parameter.
|
void | stp_set_default_curve_parameter (stp_vars_t *v, const char *parameter, const stp_curve_t *value) |
| Set a default curve parameter.
|
void | stp_set_default_array_parameter (stp_vars_t *v, const char *parameter, const stp_array_t *value) |
| Set a default array parameter.
|
void | stp_set_default_raw_parameter (stp_vars_t *v, const char *parameter, const void *value, size_t bytes) |
| Set a default raw parameter.
|
const char * | stp_get_string_parameter (const stp_vars_t *v, const char *parameter) |
| Get a string parameter.
|
const char * | stp_get_file_parameter (const stp_vars_t *v, const char *parameter) |
| Get a file parameter.
|
double | stp_get_float_parameter (const stp_vars_t *v, const char *parameter) |
| Get a float parameter.
|
int | stp_get_int_parameter (const stp_vars_t *v, const char *parameter) |
| Get an integer parameter.
|
int | stp_get_dimension_parameter (const stp_vars_t *v, const char *parameter) |
| Get a dimension parameter.
|
int | stp_get_boolean_parameter (const stp_vars_t *v, const char *parameter) |
| Get a boolean parameter.
|
const stp_curve_t * | stp_get_curve_parameter (const stp_vars_t *v, const char *parameter) |
| Get a curve parameter.
|
const stp_array_t * | stp_get_array_parameter (const stp_vars_t *v, const char *parameter) |
| Get an array parameter.
|
const stp_raw_t * | stp_get_raw_parameter (const stp_vars_t *v, const char *parameter) |
| Get a raw parameter.
|
void | stp_clear_string_parameter (stp_vars_t *v, const char *parameter) |
| Clear a string parameter.
|
void | stp_clear_file_parameter (stp_vars_t *v, const char *parameter) |
| Clear a file parameter.
|
void | stp_clear_float_parameter (stp_vars_t *v, const char *parameter) |
| Clear (remove) a float parameter.
|
void | stp_clear_int_parameter (stp_vars_t *v, const char *parameter) |
| Clear (remove) an integer parameter.
|
void | stp_clear_dimension_parameter (stp_vars_t *v, const char *parameter) |
| Clear (remove) a dimension parameter.
|
void | stp_clear_boolean_parameter (stp_vars_t *v, const char *parameter) |
| Clear (remove) a boolean parameter.
|
void | stp_clear_curve_parameter (stp_vars_t *v, const char *parameter) |
| Clear a curve parameter.
|
void | stp_clear_array_parameter (stp_vars_t *v, const char *parameter) |
| Clear an array parameter.
|
void | stp_clear_raw_parameter (stp_vars_t *v, const char *parameter) |
| Clear a raw parameter.
|
void | stp_set_string_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a string parameter.
|
void | stp_set_file_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a file parameter.
|
void | stp_set_float_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a float parameter.
|
void | stp_set_int_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of an integer parameter.
|
void | stp_set_dimension_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a dimension parameter.
|
void | stp_set_boolean_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a boolean parameter.
|
void | stp_set_curve_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a curveparameter.
|
void | stp_set_array_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of an array parameter.
|
void | stp_set_raw_parameter_active (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Set the activity of a raw parameter.
|
int | stp_check_string_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a string parameter is set.
|
int | stp_check_file_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a file parameter is set.
|
int | stp_check_float_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a float parameter is set.
|
int | stp_check_int_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if an integer parameter is set.
|
int | stp_check_dimension_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a dimension parameter is set.
|
int | stp_check_boolean_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a boolean parameter is set.
|
int | stp_check_curve_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a curve parameter is set.
|
int | stp_check_array_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if an array parameter is set.
|
int | stp_check_raw_parameter (const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active) |
| Check if a raw parameter is set.
|
stp_parameter_activity_t | stp_get_string_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a string parameter.
|
stp_parameter_activity_t | stp_get_file_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a file parameter.
|
stp_parameter_activity_t | stp_get_float_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a float parameter.
|
stp_parameter_activity_t | stp_get_int_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of an integer parameter.
|
stp_parameter_activity_t | stp_get_dimension_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a dimension parameter.
|
stp_parameter_activity_t | stp_get_boolean_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a boolean parameter.
|
stp_parameter_activity_t | stp_get_curve_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a curve parameter.
|
stp_parameter_activity_t | stp_get_array_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of an array parameter.
|
stp_parameter_activity_t | stp_get_raw_parameter_active (const stp_vars_t *v, const char *parameter) |
| Get the activity status of a raw parameter.
|
void | stp_get_media_size (const stp_vars_t *v, int *width, int *height) |
| Get the media (paper) size.
|
void | stp_get_imageable_area (const stp_vars_t *v, int *left, int *right, int *bottom, int *top) |
| Get the imagable area of the page.
|
void | stp_get_size_limit (const stp_vars_t *v, int *max_width, int *max_height, int *min_width, int *min_height) |
| Get the media size limits.
|
void | stp_describe_resolution (const stp_vars_t *v, int *x, int *y) |
| Retrieve the printing resolution of the selected resolution.
|
int | stp_verify (stp_vars_t *v) |
| Verify parameters.
|
const stp_vars_t * | stp_default_settings (void) |
| Get default global settings.
|
void | stp_allocate_component_data (stp_vars_t *v, const char *name, stp_copy_data_func_t copyfunc, stp_free_data_func_t freefunc, void *data) |
void | stp_destroy_component_data (stp_vars_t *v, const char *name) |
void * | stp_get_component_data (const stp_vars_t *v, const char *name) |
stp_parameter_verify_t | stp_verify_parameter (const stp_vars_t *v, const char *parameter, int quiet) |
int | stp_get_verified (const stp_vars_t *v) |
void | stp_set_verified (stp_vars_t *v, int value) |
void | stp_copy_options (stp_vars_t *vd, const stp_vars_t *vs) |
void | stp_fill_parameter_settings (stp_parameter_t *desc, const stp_parameter_t *param) |
Most of these job options are expressed as parameters which vary according to the model and other options selected.
The representation of printer settings has changed dramatically from 4.2. All (well most, anyway) settings outside of basics such as the printer model and sizing settings are now typed parameters.