]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/api-ppd.html
projects / thirdparty / cups.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge changes from CUPS 1.4svn-r8606.
[thirdparty/cups.git] / doc / help / api-ppd.html
diff --git a/doc/help/api-ppd.html b/doc/help/api-ppd.html
index 3da1d965ec0754232b9a1a61b731d588f53a6098..56cd2abd0e177eb4d5185e3b01ebeac41688513c 100644 (file)
--- a/doc/help/api-ppd.html
+++ b/doc/help/api-ppd.html
@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <!-- SECTION: Programming -->
 <head>
@@ -27,6 +27,10 @@ PRE.command {
   margin-left: 36pt;
 }
 
+P.compact {
+  margin: 0;
+}
+
 P.example {
   font-style: italic;
   margin-left: 36pt;
@@ -375,6 +379,7 @@ div.contents ul.subcontents li {
 <li><a href="#ATTRIBUTES">Attributes</a></li>
 </ul></li>
 <li><a href="#FUNCTIONS">Functions</a><ul class="code">
+<li><a href="#cupsGetConflicts" title="Get a list of conflicting options in a marked PPD.">cupsGetConflicts</a></li>
 <li><a href="#cupsMarkOptions" title="Mark command-line options in a PPD file.">cupsMarkOptions</a></li>
 <li><a href="#cupsResolveConflicts" title="Resolve conflicts in a marked PPD.">cupsResolveConflicts</a></li>
 <li><a href="#ppdClose" title="Free all memory used by the PPD file.">ppdClose</a></li>
@@ -443,7 +448,7 @@ conflicts.">ppdMarkOption</a></li>
        <li><a href="#ppd_profile_t" title="sRGB Color Profiles">ppd_profile_t</a></li>
        <li><a href="#ppd_section_t" title="Order dependency sections">ppd_section_t</a></li>
        <li><a href="#ppd_size_t" title="Page Sizes">ppd_size_t</a></li>
-       <li><a href="#ppd_status_t" title="Types and structures...">ppd_status_t</a></li>
+       <li><a href="#ppd_status_t" title="Status Codes ">ppd_status_t</a></li>
        <li><a href="#ppd_ui_t" title="UI Types">ppd_ui_t</a></li>
 </ul></li>
 <li><a href="#STRUCTURES">Structures</a><ul class="code">
@@ -464,11 +469,11 @@ conflicts.">ppdMarkOption</a></li>
        <li><a href="#ppd_cpvalue_u" title="Custom Parameter Value ">ppd_cpvalue_u</a></li>
 </ul></li>
 <li><a href="#ENUMERATIONS">Constants</a><ul class="code">
-       <li><a href="#ppd_conform_e" title="">ppd_conform_e</a></li>
+       <li><a href="#ppd_conform_e" title="Conformance Levels ">ppd_conform_e</a></li>
        <li><a href="#ppd_cptype_e" title="Custom Parameter Type ">ppd_cptype_e</a></li>
        <li><a href="#ppd_cs_e" title="Colorspaces">ppd_cs_e</a></li>
        <li><a href="#ppd_section_e" title="Order dependency sections">ppd_section_e</a></li>
-       <li><a href="#ppd_status_e" title="Types and structures...">ppd_status_e</a></li>
+       <li><a href="#ppd_status_e" title="Status Codes ">ppd_status_e</a></li>
        <li><a href="#ppd_ui_e" title="UI Types">ppd_ui_e</a></li>
 </ul></li>
 <!--
@@ -689,6 +694,39 @@ for (attr = <a href="#ppdFindAttr">ppdFindAttr</a>(ppd, "Product", NULL);
   puts(attr->value);
 </pre>
 <h2 class="title"><a name="FUNCTIONS">Functions</a></h2>
+<h3 class="function"><span class="info">&nbsp;CUPS 1.4&nbsp;</span><a name="cupsGetConflicts">cupsGetConflicts</a></h3>
+<p class="description">Get a list of conflicting options in a marked PPD.</p>
+<p class="code">
+int cupsGetConflicts (<br>
+&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
+&nbsp;&nbsp;&nbsp;&nbsp;const char *option,<br>
+&nbsp;&nbsp;&nbsp;&nbsp;const char *choice,<br>
+&nbsp;&nbsp;&nbsp;&nbsp;cups_option_t **options<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>ppd</dt>
+<dd class="description">PPD file</dd>
+<dt>option</dt>
+<dd class="description">Option to test</dd>
+<dt>choice</dt>
+<dd class="description">Choice to test</dd>
+<dt>options</dt>
+<dd class="description">Conflicting options</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Number of conflicting options</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">This function gets a list of options that would conflict if &quot;option&quot; and
+&quot;choice&quot; were marked in the PPD.  You would typically call this function
+after marking the currently selected options in the PPD in order to
+determine whether a new option selection would cause a conflict.<br>
+<br>
+The number of conflicting options are returned with &quot;options&quot; pointing to
+the conflicting options.  The returned option array must be freed using
+<a href="#cupsFreeOptions"><code>cupsFreeOptions</code></a>.
+
+</p>
 <h3 class="function"><a name="cupsMarkOptions">cupsMarkOptions</a></h3>
 <p class="description">Mark command-line options in a PPD file.</p>
 <p class="code">
@@ -1591,8 +1629,8 @@ typedef enum <a href="#ppd_section_e">ppd_section_e</a> ppd_section_t;
 <p class="code">
 typedef struct <a href="#ppd_size_s">ppd_size_s</a> ppd_size_t;
 </p>
-<h3 class="typedef"><a name="ppd_status_t">ppd_status_t</a></h3>
-<p class="description">Types and structures...</p>
+<h3 class="typedef"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_status_t">ppd_status_t</a></h3>
+<p class="description">Status Codes </p>
 <p class="code">
 typedef enum <a href="#ppd_status_e">ppd_status_e</a> ppd_status_t;
 </p>
@@ -2031,8 +2069,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t;
 <dd class="description">String value</dd>
 </dl>
 <h2 class="title"><a name="ENUMERATIONS">Constants</a></h2>
-<h3 class="enumeration"><a name="ppd_conform_e">ppd_conform_e</a></h3>
-<p class="description"></p>
+<h3 class="enumeration"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_conform_e">ppd_conform_e</a></h3>
+<p class="description">Conformance Levels </p>
 <h4 class="constants">Constants</h4>
 <dl>
 <dt>PPD_CONFORM_RELAXED </dt>
@@ -2095,8 +2133,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t;
 <dt>PPD_ORDER_PROLOG </dt>
 <dd class="description">... must be in the Prolog section</dd>
 </dl>
-<h3 class="enumeration"><a name="ppd_status_e">ppd_status_e</a></h3>
-<p class="description">Types and structures...</p>
+<h3 class="enumeration"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_status_e">ppd_status_e</a></h3>
+<p class="description">Status Codes </p>
 <h4 class="constants">Constants</h4>
 <dl>
 <dt>PPD_ALLOC_ERROR </dt>
Unnamed repository; edit this file 'description' to name the repository.