<?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><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxPrinter</title>
</header>
<module>wxPrinter</module>
<modulesummary>Functions for wxPrinter class</modulesummary>
<description><p>This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.
      </p><p>Printing can also be achieved through using of lower functions and classes, but this and associated classes provide a more convenient and general method of printing.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_printing.html#overview_printing">Overview printing</url>, <c>wxPrinterDC</c> (not implemented in wx), <seeerl marker="wxPrintDialog"><c>wxPrintDialog</c></seeerl>, <seeerl marker="wxPrintout"><c>wxPrintout</c></seeerl>, <seeerl marker="wxPrintPreview"><c>wxPrintPreview</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_printer.html">wxPrinter</url></p>
  </description>
<datatypes><datatype><name name="wxPrinter"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>See: <c>new/1</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Pass an optional pointer to a block of print dialog data, which will be copied to the printer object's local data.
      </p><p>See: <seeerl marker="wxPrintDialogData"><c>wxPrintDialogData</c></seeerl>, <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl>
      </p></desc>
  </func>
  
  <func>
    <name name="createAbortWindow" arity="3" clause_i="1" since=""/>
    <fsummary>Creates the default printing abort window, with a cancel button. </fsummary>
    <desc><p>Creates the default printing abort window, with a cancel button. 
      </p></desc>
  </func>
  
  <func>
    <name name="getAbort" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the user has aborted the print job. </fsummary>
    <desc><p>Returns true if the user has aborted the print job. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLastError" arity="0" clause_i="1" since=""/>
    <fsummary>Return last error. </fsummary>
    <desc><p>Return last error. 
      </p><p>Valid after calling <seemfa marker="#print/4"><c>print/4</c></seemfa>, <seemfa marker="#printDialog/2"><c>printDialog/2</c></seemfa> or <seemfa marker="wxPrintPreview#print/2"><c>wxPrintPreview:print/2</c></seemfa>.
      </p><p>These functions set last error to <c>wxPRINTER_NO_ERROR</c> if no error happened.
      </p><p>Returned value is one of the following:
      </p></desc>
  </func>
  
  <func>
    <name name="getPrintDialogData" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the print data associated with the printer object. </fsummary>
    <desc><p>Returns the print data associated with the printer object. 
      </p></desc>
  </func>
  
  <func>
    <name name="print" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>print/4</c></fsummary>
  </func>
  
  <func>
    <name name="print" arity="4" clause_i="1" since=""/>
    <fsummary>Starts the printing process. </fsummary>
    <desc><p>Starts the printing process. 
      </p><p>Provide a parent window, a user-defined <seeerl marker="wxPrintout"><c>wxPrintout</c></seeerl> object which controls the printing of a document, and whether the print dialog should be invoked first.
      </p><p><seemfa marker="#print/4"><c>print/4</c></seemfa> could return false if there was a problem initializing the printer device context (current printer not set, for example) or the user cancelled printing. Call <seemfa marker="#getLastError/0"><c>getLastError/0</c></seemfa> to get detailed information about the kind of the error. 
      </p></desc>
  </func>
  
  <func>
    <name name="printDialog" arity="2" clause_i="1" since=""/>
    <fsummary>Invokes the print dialog. </fsummary>
    <desc><p>Invokes the print dialog. 
      </p><p>If successful (the user did not press Cancel and no error occurred), a suitable device context will be returned; otherwise NULL is returned; call <seemfa marker="#getLastError/0"><c>getLastError/0</c></seemfa> to get detailed information about the kind of the error.
      </p><p>Remark: The application must delete this device context to avoid a memory leak. 
      </p></desc>
  </func>
  
  <func>
    <name name="reportError" arity="4" clause_i="1" since=""/>
    <fsummary>Default error-reporting function. </fsummary>
    <desc><p>Default error-reporting function. 
      </p></desc>
  </func>
  
  <func>
    <name name="setup" arity="2" clause_i="1" since=""/>
    <fsummary>Invokes the print setup dialog. </fsummary>
    <desc><p>Invokes the print setup dialog. 
      </p><p>Deprecated: The setup dialog is obsolete, though retained for backward compatibility. 
      
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
