<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxPrintData</title>
</header>
<module>wxPrintData</module>
<modulesummary>Functions for wxPrintData class</modulesummary>
<description><p>This class holds a variety of information related to printers and printer device contexts. This class is used to create a <c>wxPrinterDC</c> (not implemented in wx) and a <seeerl marker="wxPostScriptDC"><c>wxPostScriptDC</c></seeerl>. It is also used as a data member of <seeerl marker="wxPrintDialogData"><c>wxPrintDialogData</c></seeerl> and <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl>, as part of the mechanism for transferring data between the print dialogs and the application.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_printing.html#overview_printing">Overview printing</url>, <seeerl marker="wxPrintDialog"><c>wxPrintDialog</c></seeerl>, <seeerl marker="wxPageSetupDialog"><c>wxPageSetupDialog</c></seeerl>, <seeerl marker="wxPrintDialogData"><c>wxPrintDialogData</c></seeerl>, <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_print">Overview cmndlg</url>, <c>wxPrinterDC</c> (not implemented in wx), <seeerl marker="wxPostScriptDC"><c>wxPostScriptDC</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_print_data.html">wxPrintData</url></p>
  </description>
<datatypes><datatype><name name="wxPrintData"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Copy constructor. </fsummary>
    <desc><p>Copy constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCollate" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if collation is on. </fsummary>
    <desc><p>Returns true if collation is on. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBin" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the current bin (papersource). </fsummary>
    <desc><p>Returns the current bin (papersource). 
      </p><p>By default, the system is left to select the bin (<c>wxPRINTBIN_DEFAULT</c> is returned).
      </p><p>See <seemfa marker="#setBin/2"><c>setBin/2</c></seemfa> for the full list of bin values. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if colour printing is on. </fsummary>
    <desc><p>Returns true if colour printing is on. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDuplex" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the duplex mode. </fsummary>
    <desc><p>Returns the duplex mode. 
      </p><p>One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL, wxDUPLEX_VERTICAL. 
      </p></desc>
  </func>
  
  <func>
    <name name="getNoCopies" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of copies requested by the user. </fsummary>
    <desc><p>Returns the number of copies requested by the user. 
      </p></desc>
  </func>
  
  <func>
    <name name="getOrientation" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the orientation. </fsummary>
    <desc><p>Gets the orientation. 
      </p><p>This can be wxLANDSCAPE or wxPORTRAIT. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPaperId" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the paper size id. </fsummary>
    <desc><p>Returns the paper size id. 
      </p><p>See: <seemfa marker="#setPaperId/2"><c>setPaperId/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getPrinterName" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the printer name. </fsummary>
    <desc><p>Returns the printer name. 
      </p><p>If the printer name is the empty string, it indicates that the default printer should be used. 
      </p></desc>
  </func>
  
  <func>
    <name name="getQuality" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the current print quality. </fsummary>
    <desc><p>Returns the current print quality. 
      </p><p>This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:
      </p><p>On input you should pass one of these identifiers, but on return you may get back a positive integer indicating the current resolution setting. 
      </p></desc>
  </func>
  
  <func>
    <name name="isOk" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the print data is valid for using in print dialogs. </fsummary>
    <desc><p>Returns true if the print data is valid for using in print dialogs. 
      </p><p>This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true. 
      </p></desc>
  </func>
  
  <func>
    <name name="setBin" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the current bin. </fsummary>
    <desc><p>Sets the current bin. 
      </p></desc>
  </func>
  
  <func>
    <name name="setCollate" arity="2" clause_i="1" since=""/>
    <fsummary>Sets collation to on or off. </fsummary>
    <desc><p>Sets collation to on or off. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets colour printing on or off. </fsummary>
    <desc><p>Sets colour printing on or off. 
      </p></desc>
  </func>
  
  <func>
    <name name="setDuplex" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the duplex mode. </fsummary>
    <desc><p>Returns the duplex mode. 
      </p><p>One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL, wxDUPLEX_VERTICAL. 
      </p></desc>
  </func>
  
  <func>
    <name name="setNoCopies" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default number of copies to be printed out. </fsummary>
    <desc><p>Sets the default number of copies to be printed out. 
      </p></desc>
  </func>
  
  <func>
    <name name="setOrientation" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the orientation. </fsummary>
    <desc><p>Sets the orientation. 
      </p><p>This can be wxLANDSCAPE or wxPORTRAIT. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPaperId" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the paper id. </fsummary>
    <desc><p>Sets the paper id. 
      </p><p>This indicates the type of paper to be used. For a mapping between paper id, paper size and string name, see wxPrintPaperDatabase in <c>"paper.h"</c> (not yet documented).
      </p><p>See: <c>SetPaperSize()</c> (not implemented in wx)
      </p></desc>
  </func>
  
  <func>
    <name name="setPrinterName" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the printer name. </fsummary>
    <desc><p>Sets the printer name. 
      </p><p>This can be the empty string to indicate that the default printer should be used. 
      </p></desc>
  </func>
  
  <func>
    <name name="setQuality" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the desired print quality. </fsummary>
    <desc><p>Sets the desired print quality. 
      </p><p>This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:
      </p><p>On input you should pass one of these identifiers, but on return you may get back a positive integer indicating the current resolution setting. 
      </p></desc>
  </func>
  </funcs>
</erlref>
