libcapsppcommon.h File Reference

Common definitions used by printing coordinator components (libcapsclient and libcapsprovider) More...

Go to the source code of this file.

Data Structures
struct	caps_supported_mime_list
struct	caps_job_progression
	Information collection for printing progression report. More...

Enumerations
enum	caps_printing_provider_state {   LIBCAPS_PP_STATE_UNKNOWN = 0 ,   LIBCAPS_PP_STATE_INVISIBLE ,   LIBCAPS_PP_STATE_STOPPED ,   LIBCAPS_PP_STATE_IDLE ,   LIBCAPS_PP_STATE_PREPARING ,   LIBCAPS_PP_STATE_PROCESSING ,   LIBCAPS_PP_STATE_PRINTING ,   LIBCAPS_PP_STATE_SHUTDOWN ,   LIBCAPS_PP_STATE_OFFLINE }
enum	caps_printing_provider_reason {   LIBCAPS_PP_REASON_NONE = 0x10U ,   LIBCAPS_PP_REASON_ATTENTION ,   LIBCAPS_PP_REASON_MEDIA_NEEDED ,   LIBCAPS_PP_REASON_MEDIA_JAM ,   LIBCAPS_PP_REASON_SHUTDOWN }
enum	caps_printing_job_state {   LIBCAPS_PJ_STATE_UNKNOWN = 0 ,   LIBCAPS_PJ_STATE_RECEIVING ,   LIBCAPS_PJ_STATE_QUEUED ,   LIBCAPS_PJ_STATE_PREPARED ,   LIBCAPS_PJ_STATE_PROCESSING ,   LIBCAPS_PJ_STATE_PROCESSING_STOPPED ,   LIBCAPS_PJ_STATE_CANCELED = 7 ,   LIBCAPS_PJ_STATE_ABORTED = 8 ,   LIBCAPS_PJ_STATE_COMPLETED = 9 }
	The processing states a job can be in. More...
enum	caps_printing_job_reason {   LIBCAPS_PJ_REASON_NONE = 0 ,   LIBCAPS_PJ_REASON_DATA_FORMAT ,   LIBCAPS_PJ_REASON_DATA_CONTENT ,   LIBCAPS_PJ_REASON_CANCELED_BY_DRIVER ,   LIBCAPS_PJ_REASON_CANCELED_BY_USER ,   LIBCAPS_PJ_REASON_CANCELED_BY_SYSTEM ,   LIBCAPS_PJ_REASON_COMPLETED_SUCCESSFULLY }
	The more detailed state description a printing job can be in. More...
enum	caps_user_class {   CAPS_CLSS_COORDINATOR = 0 ,   CAPS_CLSS_SERVICE ,   CAPS_CLSS_DRIVER }

Detailed Description

Copyright

GNU Lesser General Public License 2.1

Author

Jürgen Borleis

Warning

Use as experimental

Bad and wrong file name. This is common to the printing coordinator - and nothing else!!

Enumeration Type Documentation

caps_user_class

enum caps_user_class

Class of user of the libcapsprovider and libcapsclient

Used in caps_pp_instance_runtime_prepare() to select a base INI for global default settings for all types of these user classes.

Main usage is to define the set of INI files which are read-in at the program's start up to to configure it.

Todo:

Add references to the corresponding INI files runtime_configuration_class_merge_in()

Enumerator
CAPS_CLSS_COORDINATOR	Belongs to the printing coordinator
CAPS_CLSS_SERVICE	Belongs to a service like the IPP service
CAPS_CLSS_DRIVER	Belongs to a printer driver