<?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>wxHtmlEasyPrinting</title>
</header>
<module>wxHtmlEasyPrinting</module>
<modulesummary>Functions for wxHtmlEasyPrinting class</modulesummary>
<description><p>This class provides very simple interface to printing architecture. It allows you to print HTML documents using only a few commands.
      </p><p>Note: Do not create this class on the stack only. You should create an instance on app startup and use this instance for all printing operations. The reason is that this class stores various settings in it.
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_html_easy_printing.html">wxHtmlEasyPrinting</url></p>
  </description>
<datatypes><datatype><name name="wxHtmlEasyPrinting"/></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></desc>
  </func>
  
  <func>
    <name name="getPrintData" arity="1" clause_i="1" since=""/>
    <fsummary>Returns pointer to <c>wxPrintData</c> instance used by this class. </fsummary>
    <desc><p>Returns pointer to <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> instance used by this class. 
      </p><p>You can set its parameters (via SetXXXX methods). 
      </p></desc>
  </func>
  
  <func>
    <name name="getPageSetupData" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a pointer to <c>wxPageSetupDialogData</c> instance used by this class. </fsummary>
    <desc><p>Returns a pointer to <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl> instance used by this class. 
      </p><p>You can set its parameters (via SetXXXX methods). 
      </p></desc>
  </func>
  
  <func>
    <name name="previewFile" arity="2" clause_i="1" since=""/>
    <fsummary>Preview HTML file. </fsummary>
    <desc><p>Preview HTML file. 
      </p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error. 
      </p></desc>
  </func>
  
  <func>
    <name name="previewText" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>previewText/3</c></fsummary>
  </func>
  
  <func>
    <name name="previewText" arity="3" clause_i="1" since=""/>
    <fsummary>Preview HTML text (not file!). </fsummary>
    <desc><p>Preview HTML text (not file!). 
      </p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error.
      </p></desc>
  </func>
  
  <func>
    <name name="printFile" arity="2" clause_i="1" since=""/>
    <fsummary>Print HTML file. </fsummary>
    <desc><p>Print HTML file. 
      </p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error. 
      </p></desc>
  </func>
  
  <func>
    <name name="printText" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>printText/3</c></fsummary>
  </func>
  
  <func>
    <name name="printText" arity="3" clause_i="1" since=""/>
    <fsummary>Print HTML text (not file!). </fsummary>
    <desc><p>Print HTML text (not file!). 
      </p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error.
      </p></desc>
  </func>
  
  <func>
    <name name="pageSetup" arity="1" clause_i="1" since=""/>
    <fsummary>Display page setup dialog and allows the user to modify settings. </fsummary>
    <desc><p>Display page setup dialog and allows the user to modify settings. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFonts" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>setFonts/4</c></fsummary>
  </func>
  
  <func>
    <name name="setFonts" arity="4" clause_i="1" since=""/>
    <fsummary>Sets fonts. </fsummary>
    <desc><p>Sets fonts. 
      </p><p>See <c>wxHtmlDCRenderer::SetFonts</c> (not implemented in wx) for detailed description. 
      </p></desc>
  </func>
  
  <func>
    <name name="setHeader" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setHeader/3</c></fsummary>
  </func>
  
  <func>
    <name name="setHeader" arity="3" clause_i="1" since=""/>
    <fsummary>Set page header. </fsummary>
    <desc><p>Set page header. 
      </p><p>The following macros can be used inside it:
      </p></desc>
  </func>
  
  <func>
    <name name="setFooter" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setFooter/3</c></fsummary>
  </func>
  
  <func>
    <name name="setFooter" arity="3" clause_i="1" since=""/>
    <fsummary>Set page footer. </fsummary>
    <desc><p>Set page footer. 
      </p><p>The following macros can be used inside it: @DATE@ is replaced by the current date in default format @PAGENUM@ is replaced by page number @PAGESCNT@ is replaced by total number of pages @TIME@ is replaced by the current time in default format @TITLE@ is replaced with the title of the document
      </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>
