CAPS Universe documentation  1.0.4
All you need to know to be successful
dbus-transport.h
Go to the documentation of this file.
1#pragma once
2
3/*
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 * (c) 2021 Juergen Borleis <projects@caps-printing.org>
7 *
8 * This library is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License 2.1 as published by the Free
10 * Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
15 */
30#define CAPS_PRINTING_SERVICE "org.caps.printing"
37#define CAPS_PRINTING_COORDINATOR_OBJECT_PATH "/org/caps/printing/coordinator"
44#define CAPS_PRINTING_COORDINATOR_INTERFACE "org.caps.printing.coordinator"
51#define CAPS_PRINTING_CLIENT_OBJECT_PATH "/org/caps/printing/client"
58#define CAPS_PRINTING_CLIENT_INTERFACE "org.caps.printing.client"
59
65#define RETRIEVE_PR_RELEASE "RetrievePrRelease"
66#define RETRIEVE_PR_RELEASE_XML \
67 "<arg name=\"major\" type=\"i\" direction=\"out\"/>\n" \
68 "<arg name=\"minor\" type=\"i\" direction=\"out\"/>\n" \
69 "<arg name=\"micro\" type=\"i\" direction=\"out\"/>\n"
70
74#define CREATE_PR_ID_METHOD "CreatePrinterId"
78#define CREATE_PR_ID_XML \
79 "<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n"
80
84#define FREE_PR_ID_METHOD "FreePrinterId"
88#define FREE_PR_ID_XML \
89 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
90 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
91
95#define SET_PRINTER_STATE_METHOD "SetPrinterState"
99#define SET_PRINTER_STATE_XML \
100 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
101 "<arg name=\"stateid\" type=\"i\" direction=\"in\"/>\n" \
102 "<arg name=\"reasonid\" type=\"i\" direction=\"in\"/>\n" \
103 "<arg name=\"message\" type=\"s\" direction=\"in\"/>\n" \
104 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
105
109#define SET_PRINTER_INFO_METHOD "SetPrinterInfo"
113#define SET_PRINTER_INFO_XML \
114 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
115 "<arg name=\"prname\" type=\"s\" direction=\"in\"/>\n" \
116 "<arg name=\"prinfo\" type=\"s\" direction=\"in\"/>\n" \
117 "<arg name=\"prlocation\" type=\"s\" direction=\"in\"/>\n" \
118 "<arg name=\"pvendor\" type=\"s\" direction=\"in\"/>\n" \
119 "<arg name=\"pmodel\" type=\"s\" direction=\"in\"/>\n" \
120 "<arg name=\"mimes\" type=\"as\" direction=\"in\"/>\n" \
121 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
122
126#define GET_JOB_ID_METHOD "GetJobId"
130#define GET_JOB_ID_XML \
131 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
132 "<arg name=\"jobid\" type=\"x\" direction=\"out\"/>\n"
133
137#define GET_JOB_METHOD "GetJob"
141#define GET_JOB_XML \
142 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
143 "<arg name=\"jobid\" type=\"x\" direction=\"in\"/>\n" \
144 "<arg name=\"jfh\" type=\"h\" direction=\"out\"/>\n" \
145 "<arg name=\"parameter\" type=\"s\" direction=\"out\"/>\n"
146
150#define JOB_SET_PROGRESSION_METHOD "JobSetProgression"
154#define JOB_SET_PROGRESSION_XML \
155 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
156 "<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
157 "<arg name=\"flags\" type=\"u\" direction=\"in\"/>\n" \
158 "<arg name=\"cpy\" type=\"u\" direction=\"in\"/>\n" \
159 "<arg name=\"cpg\" type=\"u\" direction=\"in\"/>\n" \
160 "<arg name=\"dmedia\" type=\"u\" direction=\"in\"/>\n" \
161 "<arg name=\"fmedia\" type=\"u\" direction=\"in\"/>\n" \
162 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
163
167#define JOB_FINISHED_METHOD "JobFinished"
171#define JOB_FINISHED_XML \
172 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
173 "<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
174 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
175
179#define SET_PPD_DEFINITION_METHOD "SetPPDDefinition"
183#define SET_PPD_DEFINITION_XML \
184 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
185 "<arg name=\"ppdfh\" type=\"h\" direction=\"in\"/>\n" \
186 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
187
191#define SET_JOB_STATE_METHOD "JobSetState"
195#define SET_JOB_STATE_XML \
196 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
197 "<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
198 "<arg name=\"stateid\" type=\"i\" direction=\"in\"/>\n" \
199 "<arg name=\"reasonid\" type=\"i\" direction=\"in\"/>\n" \
200 "<arg name=\"message\" type=\"s\" direction=\"in\"/>\n" \
201 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
202
208#define CL_INTRODUCTION_METHOD "ClIntroduction"
212#define CL_INTRODUCTION_XML \
213 "<arg name=\"major\" type=\"i\" direction=\"in\"/>\n" \
214 "<arg name=\"minor\" type=\"i\" direction=\"in\"/>\n" \
215 "<arg name=\"micro\" type=\"i\" direction=\"in\"/>\n"
216
220#define GET_PRINTER_LIST_METHOD "GetPrinterList"
224#define GET_PRINTER_LIST_XML \
225 "<arg name=\"list\" type=\"ax\" direction=\"out\"/>\n"
226
230#define GET_PRINTERS_INFO_METHOD "GetPrintersInfo"
234#define GET_PRINTERS_INFO_XML \
235 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
236 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n" \
237 "<arg name=\"name\" type=\"s\" direction=\"out\"/>\n" \
238 "<arg name=\"descript\" type=\"s\" direction=\"out\"/>\n" \
239 "<arg name=\"location\" type=\"s\" direction=\"out\"/>\n" \
240 "<arg name=\"mimes\" type=\"as\" direction=\"out\"/>\n"
241
245#define GET_PRINTERS_STATE_METHOD "GetPrintersState"
249#define GET_PRINTERS_STATE_XML \
250 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
251 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n" \
252 "<arg name=\"stateid\" type=\"i\" direction=\"out\"/>\n" \
253 "<arg name=\"reasonid\" type=\"i\" direction=\"out\"/>\n" \
254 "<arg name=\"message\" type=\"s\" direction=\"out\"/>\n"
255
259#define GET_PRINTERS_PPD_METHOD "GetPrintersPPD"
263#define GET_PRINTERS_PPD_XML \
264 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
265 "<arg name=\"ppdfh\" type=\"h\" direction=\"out\"/>\n"
266
270#define COMMIT_PRINTING_JOB_METHOD "CommitPrintingJob"
274#define COMMIT_PRINTING_JOB_METHOD_XML \
275 "<arg name=\"prid\" type=\"x\" direction=\"in\"/>\n" \
276 "<arg name=\"jobfh\" type=\"h\" direction=\"out\"/>\n" \
277 "<arg name=\"ippparm\" type=\"s\" direction=\"out\"/>\n" \
278 "<arg name=\"jid\" type=\"x\" direction=\"out\"/>\n"
279
283#define GET_PRINTING_JOB_STATE_METHOD "GetPrintingJobState"
287#define GET_PRINTING_JOB_STATE_XML \
288 "<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
289 "<arg name=\"state\" type=\"i\" direction=\"out\"/>\n" \
290 "<arg name=\"reason\" type=\"i\" direction=\"out\"/>\n" \
291 "<arg name=\"message\" type=\"s\" direction=\"out\"/>\n" \
292 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
293
294#define GET_PRINTING_JOB_PROGRESSION_METHOD "GetPrintingJobProgression"
298#define GET_PRINTING_JOB_PROGRESSION_XML \
299 "<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
300 "<arg name=\"flags\" type=\"u\" direction=\"out\"/>\n" \
301 "<arg name=\"cpy\" type=\"u\" direction=\"out\"/>\n" \
302 "<arg name=\"cpg\" type=\"u\" direction=\"out\"/>\n" \
303 "<arg name=\"dmedia\" type=\"u\" direction=\"out\"/>\n" \
304 "<arg name=\"fmedia\" type=\"u\" direction=\"out\"/>\n" \
305 "<arg name=\"result\" type=\"i\" direction=\"out\"/>\n"
309#define CANCEL_PRINTING_JOB_METHOD "CancelPrintingJob"
313#define CANCEL_PRINTING_JOB_XML \
314 "<arg name=\"jid\" type=\"x\" direction=\"in\"/>\n" \
315 "<arg name=\"status\" type=\"i\" direction=\"out\"/>\n"
316
321#define SEND_JOB_CHANGE_NOTIFIER_METHOD "JobChange"
325#define SEND_JOB_CHANGE_NOTIFIER_XML \
326 "<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n" \
327 "<arg name=\"jid\" type=\"x\" direction=\"out\" />\n" \
328 "<arg name=\"stateid\" type=\"i\" direction=\"out\"/>\n" \
329 "<arg name=\"reasonid\" type=\"i\" direction=\"out\"/>\n" \
330 "<arg name=\"message\" type=\"s\" direction=\"out\"/>\n" \
331 "<arg name=\"flags\" type=\"u\" direction=\"out\"/>\n" \
332 "<arg name=\"copy\" type=\"u\" direction=\"out\"/>\n" \
333 "<arg name=\"cpage\" type=\"u\" direction=\"out\"/>\n" \
334 "<arg name=\"dmedia\" type=\"u\" direction=\"out\"/>\n" \
335 "<arg name=\"fmedia\" type=\"u\" direction=\"out\"/>\n"
336
340#define SEND_PROVIDER_CHANGE_NOTIFIER_METHOD "ProviderChange"
344#define SEND_PROVIDER_CHANGE_NOTIFIER_XML \
345 "<arg name=\"prid\" type=\"x\" direction=\"out\"/>\n" \
346 "<arg name=\"stateid\" type=\"i\" direction=\"out\"/>\n" \
347 "<arg name=\"reasonid\" type=\"i\" direction=\"out\"/>\n" \
348 "<arg name=\"message\" type=\"s\" direction=\"out\"/>\n"
The total CAPS universe documentation - Generated by doxygen