1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
\r
4 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">
\r
5 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
\r
6 <title>Xestia Scanner Server Documentation - Developer Documentation - 1.18 xestiascan_scan_preview</title>
\r
9 <div class="menubarback">
\r
10 <div class="menubar">
\r
11 <span class="apptitle">Xestia Scanner Server</span>
\r
12 <a href="index.html">Index</a> | <a href="user.html">User
\r
13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> |
\r
14 <a href="developer.html">Developer Documentation</a>
\r
17 <div class="pageinformation">
\r
18 <span class="pagetitle">1.18 xestiascan_scan_preview</span>
\r
20 xestiascan_scan_preview previews a document for scanning. It also prints out a form for changing the scanner settings.
\r
25 xestiascan_scan_preview(previewdocument, previewoptions);
\r
31 $previewoptions{ScannerID} = $form_data->{'scanner'};<br>
\r
32 $previewoptions{Brightness} = $form_data->{'brightness'};<br>
\r
33 $previewoptions{Contrast} = $form_data->{'contrast'};<br>
\r
34 $previewoptions{Rotate} = $form_data->{'rotate'};<br>
\r
35 $previewoptions{Colour} = $form_data->{'colourtype'};<br>
\r
36 $previewoptions{Resolution} = $form_data->{'imagedpi'};<br>
\r
37 $previewoptions{TopLeftX} = $form_data->{'topleftx'};<br>
\r
38 $previewoptions{TopLeftY} = $form_data->{'toplefty'};<br>
\r
39 $previewoptions{BottomRightX} = $form_data->{'bottomrightx'};<br>
\r
40 $previewoptions{BottomRightY} = $form_data->{'bottomrighty'};<br>
\r
42 $page_data = xestiascan_scan_preview(“off”, %previewoptions);<br>
\r
43 $page_data = xestiascan_scan_preview(“on”, %previewoptions);
\r
46 <i>previewdocument</i><br>
\r
47 Specifies if a preview of the document that is in the scanner should be scanned and displayed as a preview.
\r
49 <i>previewoptions</i><br>
\r
50 Specifies the following preview options as a hash.
\r
52 <table class="infotable">
\r
54 <td class="tableheading">Setting</td>
\r
55 <td class="tableheading">Value</td>
\r
58 <td class="tabledata">ScannerID</td>
\r
59 <td class="tabledata">Specifies the SANE Scanner ID to preview a document with.</td>
\r
62 <td class="tabledata">Brightness</td>
\r
63 <td class="tabledata">Specifies how bright the document should have.</td>
\r
66 <td class="tabledata">Contrast</td>
\r
67 <td class="tabledata">Specifies how much contrast the document have.</td>
\r
70 <td class="tabledata">Rotate</td>
\r
71 <td class="tabledata">Specifies the rotation of the document (0, 90, 180, or 270 degrees).</td>
\r
74 <td class="tabledata">Colour</td>
\r
75 <td class="tabledata">Specifies if the document should be grey or RGB.</td>
\r
78 <td class="tabledata">Resolution</td>
\r
79 <td class="tabledata">Specifies the resolution of the document.</td>
\r
82 <td class="tabledata">TopLeftX</td>
\r
83 <td class="tabledata">Specifies the top left X position of the document to scan from.</td>
\r
86 <td class="tabledata">TopLeftY</td>
\r
87 <td class="tabledata">Specifies the top left Y position of the document to scan from.</td>
\r
90 <td class="tabledata">BottomRightX</td>
\r
91 <td class="tabledata">Specifies the bottom right X position of the document to scan to.</td>
\r
94 <td class="tabledata">BottomRightY</td>
\r
95 <td class="tabledata">Specifies the bottom right Y position of the document to scan to.</td>
\r