<?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>wxPageSetupDialogData</title>
</header>
<module>wxPageSetupDialogData</module>
<modulesummary>Functions for wxPageSetupDialogData class</modulesummary>
<description><p>This class holds a variety of information related to <seeerl marker="wxPageSetupDialog"><c>wxPageSetupDialog</c></seeerl>.
      </p><p>It contains a <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> member which is used to hold basic printer configuration data (as opposed to the user-interface configuration settings stored by <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl>).
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_printing.html#overview_printing">Overview printing</url>, <seeerl marker="wxPageSetupDialog"><c>wxPageSetupDialog</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_page_setup_dialog_data.html">wxPageSetupDialogData</url></p>
  </description>
<datatypes><datatype><name name="wxPageSetupDialogData"/></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>Construct an object from a print data object. </fsummary>
    <desc><p>Construct an object from a print data object. 
      </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 (Windows only). </fsummary>
    <desc><p>Enables or disables the "Help" button (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="enableMargins" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the margin controls (Windows only). </fsummary>
    <desc><p>Enables or disables the margin controls (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="enableOrientation" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the orientation control (Windows only). </fsummary>
    <desc><p>Enables or disables the orientation control (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="enablePaper" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the paper size control (Windows only). </fsummary>
    <desc><p>Enables or disables the paper size control (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="enablePrinter" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables the "Printer" button, which invokes a printer setup dialog. </fsummary>
    <desc><p>Enables or disables the "Printer" button, which invokes a printer setup dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDefaultMinMargins" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). </fsummary>
    <desc><p>Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="getEnableMargins" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the margin controls are enabled (Windows only). </fsummary>
    <desc><p>Returns true if the margin controls are enabled (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="getEnableOrientation" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the orientation control is enabled (Windows only). </fsummary>
    <desc><p>Returns true if the orientation control is enabled (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="getEnablePaper" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the paper size control is enabled (Windows only). </fsummary>
    <desc><p>Returns true if the paper size control is enabled (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="getEnablePrinter" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the printer setup button is enabled. </fsummary>
    <desc><p>Returns true if the printer setup button is enabled. 
      </p></desc>
  </func>
  
  <func>
    <name name="getEnableHelp" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the printer setup button is enabled. </fsummary>
    <desc><p>Returns true if the printer setup button is enabled. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDefaultInfo" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). </fsummary>
    <desc><p>Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="getMarginTopLeft" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the left (x) and top (y) margins in millimetres. </fsummary>
    <desc><p>Returns the left (x) and top (y) margins in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMarginBottomRight" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the right (x) and bottom (y) margins in millimetres. </fsummary>
    <desc><p>Returns the right (x) and bottom (y) margins in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMinMarginTopLeft" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the left (x) and top (y) minimum margins the user can enter (Windows only). </fsummary>
    <desc><p>Returns the left (x) and top (y) minimum margins the user can enter (Windows only). 
      </p><p>Units are in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMinMarginBottomRight" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). </fsummary>
    <desc><p>Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). 
      </p><p>Units are in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPaperId" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the paper id (stored in the internal <c>wxPrintData</c> object). </fsummary>
    <desc><p>Returns the paper id (stored in the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object). 
      </p><p>See: <seemfa marker="wxPrintData#setPaperId/2"><c>wxPrintData:setPaperId/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getPaperSize" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the paper size in millimetres. </fsummary>
    <desc><p>Returns the paper size in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPrintData" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="isOk" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the print data associated with the dialog data is valid. </fsummary>
    <desc><p>Returns true if the print data associated with the dialog data is valid. 
      </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="setDefaultInfo" arity="2" clause_i="1" since=""/>
    <fsummary>Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). </fsummary>
    <desc><p>Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). 
      </p></desc>
  </func>
  
  <func>
    <name name="setDefaultMinMargins" arity="2" clause_i="1" since=""/>
    <fsummary>Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). </fsummary>
    <desc><p>Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). 
      </p><p>Units are in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMarginTopLeft" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the left (x) and top (y) margins in millimetres. </fsummary>
    <desc><p>Sets the left (x) and top (y) margins in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMarginBottomRight" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the right (x) and bottom (y) margins in millimetres. </fsummary>
    <desc><p>Sets the right (x) and bottom (y) margins in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMinMarginTopLeft" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the left (x) and top (y) minimum margins the user can enter (Windows only). </fsummary>
    <desc><p>Sets the left (x) and top (y) minimum margins the user can enter (Windows only). 
      </p><p>Units are in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMinMarginBottomRight" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). </fsummary>
    <desc><p>Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). 
      </p><p>Units are in millimetres. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPaperId" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the paper size id. </fsummary>
    <desc><p>Sets the paper size id. 
      </p><p>Calling this function overrides the explicit paper dimensions passed in <seemfa marker="#setPaperSize/2"><c>setPaperSize/2</c></seemfa>.
      </p><p>See: <seemfa marker="wxPrintData#setPaperId/2"><c>wxPrintData:setPaperId/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setPaperSize" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the paper size in millimetres. </fsummary>
    <desc><p>Sets the paper size in millimetres. 
      </p><p>If a corresponding paper id is found, it will be set in the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object, otherwise the paper size overrides the paper id. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPrintData" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the print data associated with this object. </fsummary>
    <desc><p>Sets the print data associated with this object. 
      </p></desc>
  </func>
  </funcs>
</erlref>
