<?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>wxPrintDialogData</title>
</header>
<module>wxPrintDialogData</module>
<modulesummary>Functions for wxPrintDialogData class</modulesummary>
<description><p>This class holds information related to the visual characteristics of <seeerl marker="wxPrintDialog"><c>wxPrintDialog</c></seeerl>. It contains a <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object with underlying printing settings.
      </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>, <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_print">Overview cmndlg</url>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_print_dialog_data.html">wxPrintDialogData</url></p>
  </description>
<datatypes><datatype><name name="wxPrintDialogData"/></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="enableHelp" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the "Help" button. </fsummary>
    <desc><p>Enables or disables the "Help" button. 
      </p></desc>
  </func>
  
  <func>
    <name name="enablePageNumbers" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the "Page numbers" controls. </fsummary>
    <desc><p>Enables or disables the "Page numbers" controls. 
      </p></desc>
  </func>
  
  <func>
    <name name="enablePrintToFile" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the "Print to file" checkbox. </fsummary>
    <desc><p>Enables or disables the "Print to file" checkbox. 
      </p></desc>
  </func>
  
  <func>
    <name name="enableSelection" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the "Selection" radio button. </fsummary>
    <desc><p>Enables or disables the "Selection" radio button. 
      </p></desc>
  </func>
  
  <func>
    <name name="getAllPages" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the user requested that all pages be printed. </fsummary>
    <desc><p>Returns true if the user requested that all pages be printed. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCollate" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the user requested that the document(s) be collated. </fsummary>
    <desc><p>Returns true if the user requested that the document(s) be collated. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFromPage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the <c>from</c> page number, as entered by the user. </fsummary>
    <desc><p>Returns the <c>from</c> page number, as entered by the user. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMaxPage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the <c>maximum</c> page number. </fsummary>
    <desc><p>Returns the <c>maximum</c> page number. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMinPage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the <c>minimum</c> page number. </fsummary>
    <desc><p>Returns the <c>minimum</c> page number. 
      </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="getPrintData" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a reference to the internal <c>wxPrintData</c> object. </fsummary>
    <desc><p>Returns a reference to the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPrintToFile" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the user has selected printing to a file. </fsummary>
    <desc><p>Returns true if the user has selected printing to a file. 
      </p></desc>
  </func>
  
  <func>
    <name name="getSelection" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application). </fsummary>
    <desc><p>Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application). 
      </p></desc>
  </func>
  
  <func>
    <name name="getToPage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the <c>"print to"</c> page number, as entered by the user. </fsummary>
    <desc><p>Returns the <c>"print to"</c> page number, as entered by the user. 
      </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="setCollate" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the "Collate" checkbox to true or false. </fsummary>
    <desc><p>Sets the "Collate" checkbox to true or false. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFromPage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the <c>from</c> page number. </fsummary>
    <desc><p>Sets the <c>from</c> page number. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMaxPage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the <c>maximum</c> page number. </fsummary>
    <desc><p>Sets the <c>maximum</c> page number. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMinPage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the <c>minimum</c> page number. </fsummary>
    <desc><p>Sets the <c>minimum</c> page number. 
      </p></desc>
  </func>
  
  <func>
    <name name="setNoCopies" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default number of copies the user has requested to be printed out. </fsummary>
    <desc><p>Sets the default number of copies the user has requested to be printed out. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPrintData" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the internal <c>wxPrintData</c>. </fsummary>
    <desc><p>Sets the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPrintToFile" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the "Print to file" checkbox to true or false. </fsummary>
    <desc><p>Sets the "Print to file" checkbox to true or false. 
      </p></desc>
  </func>
  
  <func>
    <name name="setSelection" arity="2" clause_i="1" since=""/>
    <fsummary>Selects the "Selection" radio button. </fsummary>
    <desc><p>Selects the "Selection" radio button. 
      </p><p>The effect of printing the selection depends on how the application implements this command, if at all. 
      </p></desc>
  </func>
  
  <func>
    <name name="setToPage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the <c>"print to"</c> page number. </fsummary>
    <desc><p>Sets the <c>"print to"</c> page number. 
      </p></desc>
  </func>
  </funcs>
</erlref>
