CAPS Universe documentation  1.0.4
All you need to know to be successful
Macros
dbus-transport.h File Reference

Some DBUS related definitions used internally only. More...

Go to the source code of this file.

Macros

#define CAPS_PRINTING_SERVICE   "org.caps.printing"
 
#define CAPS_PRINTING_COORDINATOR_OBJECT_PATH   "/org/caps/printing/coordinator"
 
#define CAPS_PRINTING_COORDINATOR_INTERFACE   "org.caps.printing.coordinator"
 
#define CAPS_PRINTING_CLIENT_OBJECT_PATH   "/org/caps/printing/client"
 
#define CAPS_PRINTING_CLIENT_INTERFACE   "org.caps.printing.client"
 
#define RETRIEVE_PR_RELEASE   "RetrievePrRelease"
 
#define RETRIEVE_PR_RELEASE_XML
 
#define CREATE_PR_ID_METHOD   "CreatePrinterId"
 
#define CREATE_PR_ID_XML    "<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n"
 
#define FREE_PR_ID_METHOD   "FreePrinterId"
 
#define FREE_PR_ID_XML
 
#define SET_PRINTER_STATE_METHOD   "SetPrinterState"
 
#define SET_PRINTER_STATE_XML
 
#define SET_PRINTER_INFO_METHOD   "SetPrinterInfo"
 
#define SET_PRINTER_INFO_XML
 
#define GET_JOB_ID_METHOD   "GetJobId"
 
#define GET_JOB_ID_XML
 
#define GET_JOB_METHOD   "GetJob"
 
#define GET_JOB_XML
 
#define JOB_SET_PROGRESSION_METHOD   "JobSetProgression"
 
#define JOB_SET_PROGRESSION_XML
 
#define JOB_FINISHED_METHOD   "JobFinished"
 
#define JOB_FINISHED_XML
 
#define SET_PPD_DEFINITION_METHOD   "SetPPDDefinition"
 
#define SET_PPD_DEFINITION_XML
 
#define SET_JOB_STATE_METHOD   "JobSetState"
 
#define SET_JOB_STATE_XML
 
#define CL_INTRODUCTION_METHOD   "ClIntroduction"
 
#define CL_INTRODUCTION_XML
 
#define GET_PRINTER_LIST_METHOD   "GetPrinterList"
 
#define GET_PRINTER_LIST_XML    "<arg name=\"list\" type=\"ax\" direction=\"out\"/>\n"
 
#define GET_PRINTERS_INFO_METHOD   "GetPrintersInfo"
 
#define GET_PRINTERS_INFO_XML
 
#define GET_PRINTERS_STATE_METHOD   "GetPrintersState"
 
#define GET_PRINTERS_STATE_XML
 
#define GET_PRINTERS_PPD_METHOD   "GetPrintersPPD"
 
#define GET_PRINTERS_PPD_XML
 
#define COMMIT_PRINTING_JOB_METHOD   "CommitPrintingJob"
 
#define COMMIT_PRINTING_JOB_METHOD_XML
 
#define GET_PRINTING_JOB_STATE_METHOD   "GetPrintingJobState"
 
#define GET_PRINTING_JOB_STATE_XML
 
#define GET_PRINTING_JOB_PROGRESSION_METHOD   "GetPrintingJobProgression"
 
#define GET_PRINTING_JOB_PROGRESSION_XML
 
#define CANCEL_PRINTING_JOB_METHOD   "CancelPrintingJob"
 
#define CANCEL_PRINTING_JOB_XML
 
#define SEND_JOB_CHANGE_NOTIFIER_METHOD   "JobChange"
 
#define SEND_JOB_CHANGE_NOTIFIER_XML
 
#define SEND_PROVIDER_CHANGE_NOTIFIER_METHOD   "ProviderChange"
 
#define SEND_PROVIDER_CHANGE_NOTIFIER_XML
 

Detailed Description

Copyright
GNU Lesser General Public License 2.1
Author
Jürgen Borleis
Warning
Use as experimental

Macro Definition Documentation

◆ CAPS_PRINTING_SERVICE

#define CAPS_PRINTING_SERVICE   "org.caps.printing"

Which process/program/application you are talking to

The dot is the separator

Note
Max length is #DBUS_MAXIMUM_NAME_LENGTH

◆ CAPS_PRINTING_COORDINATOR_OBJECT_PATH

#define CAPS_PRINTING_COORDINATOR_OBJECT_PATH   "/org/caps/printing/coordinator"

Which resource you are talking about

The slash is the separator

Note
Max length is #DBUS_MAXIMUM_NAME_LENGTH

◆ CAPS_PRINTING_COORDINATOR_INTERFACE

#define CAPS_PRINTING_COORDINATOR_INTERFACE   "org.caps.printing.coordinator"

Which interface you are talking to (as a printing provider)

The dot is the separator

Note
Max length is #DBUS_MAXIMUM_NAME_LENGTH

◆ CAPS_PRINTING_CLIENT_OBJECT_PATH

#define CAPS_PRINTING_CLIENT_OBJECT_PATH   "/org/caps/printing/client"

Which resource you are talking about

The slash is the separator

Note
Max length is #DBUS_MAXIMUM_NAME_LENGTH

◆ CAPS_PRINTING_CLIENT_INTERFACE

#define CAPS_PRINTING_CLIENT_INTERFACE   "org.caps.printing.client"

Which interface you are talking to (as a printing client)

The dot is the separator

Note
Max length is #DBUS_MAXIMUM_NAME_LENGTH

◆ RETRIEVE_PR_RELEASE

#define RETRIEVE_PR_RELEASE   "RetrievePrRelease"

Provider method to retrieve the release value

@TODO Implement function

◆ RETRIEVE_PR_RELEASE_XML

#define RETRIEVE_PR_RELEASE_XML
Value:
"<arg name=\"major\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"minor\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"micro\" type=\"i\" direction=\"out\"/>\n"

◆ CREATE_PR_ID_METHOD

#define CREATE_PR_ID_METHOD   "CreatePrinterId"

Provider method name to register a unique printer identifier

◆ CREATE_PR_ID_XML

#define CREATE_PR_ID_XML    "<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n"

Introspection parameter for CREATE_PR_ID_METHOD

◆ FREE_PR_ID_METHOD

#define FREE_PR_ID_METHOD   "FreePrinterId"

Provider method name to unregister a printer identifier

◆ FREE_PR_ID_XML

#define FREE_PR_ID_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for FREE_PR_ID_METHOD

◆ SET_PRINTER_STATE_METHOD

#define SET_PRINTER_STATE_METHOD   "SetPrinterState"

Provider method name to set the current printer state

◆ SET_PRINTER_STATE_XML

#define SET_PRINTER_STATE_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"stateid\" type=\"i\" direction=\"in\"/>\n" \
"<arg name=\"reasonid\" type=\"i\" direction=\"in\"/>\n" \
"<arg name=\"message\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for SET_PRINTER_STATE_METHOD

◆ SET_PRINTER_INFO_METHOD

#define SET_PRINTER_INFO_METHOD   "SetPrinterInfo"

Provider method name to set the printer information (one time!)

◆ SET_PRINTER_INFO_XML

#define SET_PRINTER_INFO_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"prname\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"prinfo\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"prlocation\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"pvendor\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"pmodel\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"mimes\" type=\"as\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for SET_PRINTER_INFO_METHOD

◆ GET_JOB_ID_METHOD

#define GET_JOB_ID_METHOD   "GetJobId"

Provider method name to query for a printer's job

◆ GET_JOB_ID_XML

#define GET_JOB_ID_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jobid\" type=\"x\" direction=\"out\"/>\n"

Introspection parameter for GET_JOB_ID_METHOD

◆ GET_JOB_METHOD

#define GET_JOB_METHOD   "GetJob"

Provider method name to get a specific job from the printer's queue

◆ GET_JOB_XML

#define GET_JOB_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jobid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jfh\" type=\"h\" direction=\"out\"/>\n" \
"<arg name=\"parameter\" type=\"s\" direction=\"out\"/>\n"

Introspection parameter for GET_JOB_METHOD

◆ JOB_SET_PROGRESSION_METHOD

#define JOB_SET_PROGRESSION_METHOD   "JobSetProgression"

Provider method name to report printing progression

◆ JOB_SET_PROGRESSION_XML

#define JOB_SET_PROGRESSION_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"flags\" type=\"u\" direction=\"in\"/>\n" \
"<arg name=\"cpy\" type=\"u\" direction=\"in\"/>\n" \
"<arg name=\"cpg\" type=\"u\" direction=\"in\"/>\n" \
"<arg name=\"dmedia\" type=\"u\" direction=\"in\"/>\n" \
"<arg name=\"fmedia\" type=\"u\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for JOB_SET_PROGRESSION_METHOD

◆ JOB_FINISHED_METHOD

#define JOB_FINISHED_METHOD   "JobFinished"

Provider method name to report a job is finished

◆ JOB_FINISHED_XML

#define JOB_FINISHED_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for JOB_FINISHED_METHOD

◆ SET_PPD_DEFINITION_METHOD

#define SET_PPD_DEFINITION_METHOD   "SetPPDDefinition"

Provider method name to setup the printer's PPD

◆ SET_PPD_DEFINITION_XML

#define SET_PPD_DEFINITION_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"ppdfh\" type=\"h\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for SET_PPD_DEFINITION_METHOD

◆ SET_JOB_STATE_METHOD

#define SET_JOB_STATE_METHOD   "JobSetState"

Provider method name to set a job's state

◆ SET_JOB_STATE_XML

#define SET_JOB_STATE_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"stateid\" type=\"i\" direction=\"in\"/>\n" \
"<arg name=\"reasonid\" type=\"i\" direction=\"in\"/>\n" \
"<arg name=\"message\" type=\"s\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for SET_JOB_STATE_METHOD

◆ CL_INTRODUCTION_METHOD

#define CL_INTRODUCTION_METHOD   "ClIntroduction"
Todo:
missing provider methods job control: cancel a job

Client method to introduce itself

◆ CL_INTRODUCTION_XML

#define CL_INTRODUCTION_XML
Value:
"<arg name=\"major\" type=\"i\" direction=\"in\"/>\n" \
"<arg name=\"minor\" type=\"i\" direction=\"in\"/>\n" \
"<arg name=\"micro\" type=\"i\" direction=\"in\"/>\n"

Introspection parameter for CL_INTRODUCTION_METHOD

◆ GET_PRINTER_LIST_METHOD

#define GET_PRINTER_LIST_METHOD   "GetPrinterList"

Client method name to get a printing identifier list

◆ GET_PRINTER_LIST_XML

#define GET_PRINTER_LIST_XML    "<arg name=\"list\" type=\"ax\" direction=\"out\"/>\n"

Introspection parameter for GET_PRINTER_LIST_METHOD

◆ GET_PRINTERS_INFO_METHOD

#define GET_PRINTERS_INFO_METHOD   "GetPrintersInfo"

Client method name to get the information about a specific printer

◆ GET_PRINTERS_INFO_XML

#define GET_PRINTERS_INFO_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"name\" type=\"s\" direction=\"out\"/>\n" \
"<arg name=\"descript\" type=\"s\" direction=\"out\"/>\n" \
"<arg name=\"location\" type=\"s\" direction=\"out\"/>\n" \
"<arg name=\"mimes\" type=\"as\" direction=\"out\"/>\n"

Introspection parameter for GET_PRINTERS_INFO_METHOD

◆ GET_PRINTERS_STATE_METHOD

#define GET_PRINTERS_STATE_METHOD   "GetPrintersState"

Client method name to get the printer's state

◆ GET_PRINTERS_STATE_XML

#define GET_PRINTERS_STATE_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"stateid\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"reasonid\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"message\" type=\"s\" direction=\"out\"/>\n"

Introspection parameter for GET_PRINTERS_STATE_METHOD

◆ GET_PRINTERS_PPD_METHOD

#define GET_PRINTERS_PPD_METHOD   "GetPrintersPPD"

Client method name to get a printers PPD

◆ GET_PRINTERS_PPD_XML

#define GET_PRINTERS_PPD_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"ppdfh\" type=\"h\" direction=\"out\"/>\n"

Introspection parameter for GET_PRINTERS_PPD_METHOD

◆ COMMIT_PRINTING_JOB_METHOD

#define COMMIT_PRINTING_JOB_METHOD   "CommitPrintingJob"

Client method name to commit a printing job

◆ COMMIT_PRINTING_JOB_METHOD_XML

#define COMMIT_PRINTING_JOB_METHOD_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"jobfh\" type=\"h\" direction=\"out\"/>\n" \
"<arg name=\"ippparm\" type=\"s\" direction=\"out\"/>\n" \
"<arg name=\"jid\" type=\"x\" direction=\"out\"/>\n"

Introspection parameter for COMMIT_PRINTING_JOB_METHOD

◆ GET_PRINTING_JOB_STATE_METHOD

#define GET_PRINTING_JOB_STATE_METHOD   "GetPrintingJobState"

Client method name to get state information about a printing job

◆ GET_PRINTING_JOB_STATE_XML

#define GET_PRINTING_JOB_STATE_XML
Value:
"<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"state\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"reason\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"message\" type=\"s\" direction=\"out\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for GET_PRINTING_JOB_STATE_METHOD

◆ GET_PRINTING_JOB_PROGRESSION_METHOD

#define GET_PRINTING_JOB_PROGRESSION_METHOD   "GetPrintingJobProgression"

◆ GET_PRINTING_JOB_PROGRESSION_XML

#define GET_PRINTING_JOB_PROGRESSION_XML
Value:
"<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"flags\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"cpy\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"cpg\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"dmedia\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"fmedia\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for GET_PRINTING_JOB_PROGRESSION_METHOD

◆ CANCEL_PRINTING_JOB_METHOD

#define CANCEL_PRINTING_JOB_METHOD   "CancelPrintingJob"

Client method name to cancel a printing job

◆ CANCEL_PRINTING_JOB_XML

#define CANCEL_PRINTING_JOB_XML
Value:
"<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
"<arg name=\"status\" type=\"i\" direction=\"out\"/>\n"

Introspection parameter for CANCEL_PRINTING_JOB_METHOD

◆ SEND_JOB_CHANGE_NOTIFIER_METHOD

#define SEND_JOB_CHANGE_NOTIFIER_METHOD   "JobChange"

Signal triggered by printing clients and send out to the printing providers (if clients add new printing jobs) Signal triggered by printing providers and send out to the printing clients (if providers processing printing jobs)

◆ SEND_JOB_CHANGE_NOTIFIER_XML

#define SEND_JOB_CHANGE_NOTIFIER_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n" \
"<arg name=\"jid\" type=\"x\" direction=\"out\" />\n" \
"<arg name=\"stateid\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"reasonid\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"message\" type=\"s\" direction=\"out\"/>\n" \
"<arg name=\"flags\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"copy\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"cpage\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"dmedia\" type=\"u\" direction=\"out\"/>\n" \
"<arg name=\"fmedia\" type=\"u\" direction=\"out\"/>\n"

Introspection parameter for SEND_JOB_CHANGE_NOTIFIER_METHOD

◆ SEND_PROVIDER_CHANGE_NOTIFIER_METHOD

#define SEND_PROVIDER_CHANGE_NOTIFIER_METHOD   "ProviderChange"

Signal triggered by printing providers and send out to the printing clients

◆ SEND_PROVIDER_CHANGE_NOTIFIER_XML

#define SEND_PROVIDER_CHANGE_NOTIFIER_XML
Value:
"<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n" \
"<arg name=\"stateid\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"reasonid\" type=\"i\" direction=\"out\"/>\n" \
"<arg name=\"message\" type=\"s\" direction=\"out\"/>\n"

Introspection parameter for SEND_PROVIDER_CHANGE_NOTIFIER_METHOD

The total CAPS universe documentation - Generated by doxygen