summaryrefslogtreecommitdiff
path: root/doc/gutenprint/html/printers_8h.html
blob: 1f108f17c2b2bd91228152c1b24298b9b8fcd66f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgutenprint API Reference: include/gutenprint/printers.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>include/gutenprint/printers.h File Reference</h1>Printer functions. <a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="string-list_8h.html">gutenprint/string-list.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="list_8h.html">gutenprint/list.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="vars_8h.html">gutenprint/vars.h</a>&gt;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__printfuncs__t.html">stp_printfuncs_t</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__family.html">stp_family</a></td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct stp_printer&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The printer opaque data type (representation of printer model).  <a href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="structstp__family.html">stp_family</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g66a5e7cf2b1743a46bd78cb851e1d0a4">stp_family_t</a></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g6a76f8f76106eddd51af4b1593b4f3af">stp_printer_model_count</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of available printer models.  <a href="group__printer.html#g6a76f8f76106eddd51af4b1593b4f3af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g440501ca226e0a9ac1335c7e52ee55a6">stp_get_printer_by_index</a> (int idx)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model by its index number.  <a href="group__printer.html#g440501ca226e0a9ac1335c7e52ee55a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g6bd5abd876100c17fc9029659fed92f4">stp_get_printer_by_long_name</a> (const char *long_name)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model by its long (translated) name.  <a href="group__printer.html#g6bd5abd876100c17fc9029659fed92f4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ge45de9ef94fb609c2a54f1d80144552e">stp_get_printer_by_driver</a> (const char *driver)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model by its short name.  <a href="group__printer.html#ge45de9ef94fb609c2a54f1d80144552e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gdce65b83e3dd0ffcb75591ed3ba81155">stp_get_printer_by_device_id</a> (const char *device_id)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model by its IEEE 1284 device ID.  <a href="group__printer.html#gdce65b83e3dd0ffcb75591ed3ba81155"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gc649c4b3d0a93f26f99deb4b081305c1">stp_get_printer</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the printer model from a vars object.  <a href="group__printer.html#gc649c4b3d0a93f26f99deb4b081305c1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g41094e69b71eb930e770bd2cf8bbf795">stp_get_printer_index_by_driver</a> (const char *driver)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the printer index number from the printer model short (driver) name.  <a href="group__printer.html#g41094e69b71eb930e770bd2cf8bbf795"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g11804fb9b8d87ed1f2a3acbd39f5f85a">stp_printer_get_long_name</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model's long (translated) name.  <a href="group__printer.html#g11804fb9b8d87ed1f2a3acbd39f5f85a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gc345b8cf8cd78da98fdb4c6b2d9cf7ca">stp_printer_get_driver</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model's short (driver) name.  <a href="group__printer.html#gc345b8cf8cd78da98fdb4c6b2d9cf7ca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g7bbd6440baa533d99616eccb5f449354">stp_printer_get_device_id</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model's IEEE 1284 device ID, if known.  <a href="group__printer.html#g7bbd6440baa533d99616eccb5f449354"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g487b74bf101a842f30b5941b8db4769a">stp_printer_get_family</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model's family name.  <a href="group__printer.html#g487b74bf101a842f30b5941b8db4769a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gb99dd05c42aed848d1567f2b346fb4f4">stp_printer_get_manufacturer</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model's manufacturer's name.  <a href="group__printer.html#gb99dd05c42aed848d1567f2b346fb4f4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gae84d3fb263c4a171b7b63b6d93a940e">stp_printer_get_model</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a printer model's model number.  <a href="group__printer.html#gae84d3fb263c4a171b7b63b6d93a940e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g4f6859e0f21ed2062075d6b9f680a202">stp_printer_get_defaults</a> (const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the default vars for a particular printer model.  <a href="group__printer.html#g4f6859e0f21ed2062075d6b9f680a202"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gf5084888feed9878811ac491cb5313ee">stp_set_printer_defaults</a> (<a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a vars object to use a particular driver, and set the parameters to their defaults.  <a href="group__printer.html#gf5084888feed9878811ac491cb5313ee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gc2ed6f27e4db29ceaa74a1b9bd6a78cf">stp_set_printer_defaults_soft</a> (<a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const <a class="el" href="group__printer.html#gcddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a vars object to use a particular driver, and set any unset parameters to their defaults.  <a href="group__printer.html#gc2ed6f27e4db29ceaa74a1b9bd6a78cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g6065874cbb246875925e14d8801898cc">stp_print</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print the image.  <a href="group__printer.html#g6065874cbb246875925e14d8801898cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g31ef7bcc34dda5d3fd46b2d04fcb0c64">stp_start_job</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a print job.  <a href="group__printer.html#g31ef7bcc34dda5d3fd46b2d04fcb0c64"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ge61d056dd504facc72ff56d7f16eb23c">stp_end_job</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">End a print job.  <a href="group__printer.html#ge61d056dd504facc72ff56d7f16eb23c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="string-list_8h.html#5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gae7a50e6175eed1b84d2e20c924b33ca">stp_get_external_options</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve options that need to be passed to the underlying print system.  <a href="group__printer.html#gae7a50e6175eed1b84d2e20c924b33ca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g2057c5fcfc31d8b4cf7f3291cf3c0cf4">stp_get_model_id</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g5b5cb603c9432c03ea459b57a2039bdc">stp_verify_printer_params</a> (<a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g1c6d389f49a185ca24546107bd6f4993">stp_family_register</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *family)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g67e5c18254f7ad0b0fd77b4cc2265405">stp_family_unregister</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *family)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g381f3a4f132a00d6d2e2a9b54f9ed675">stp_initialize_printer_defaults</a> (void)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#g40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g09bf7aebf0385f7b5aac537a13b6e3ed">stp_printer_list_parameters</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g07bc634c85950526155b711aac42c6a0">stp_printer_describe_parameter</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const char *name, <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *description)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#g50b48bab8d6d1734c3a0f6622d65582e">stp_describe_output</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Printer functions. 
<p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 11 20:12:56 2010 for libgutenprint API Reference by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>