<?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>wxPreviewFrame</title>
</header>
<module>wxPreviewFrame</module>
<modulesummary>Functions for wxPreviewFrame class</modulesummary>
<description><p>This class provides the default method of managing the print preview interface. Member functions may be overridden to replace functionality, or the class may be used without derivation.
      </p><p>See: <seeerl marker="wxPreviewCanvas"><c>wxPreviewCanvas</c></seeerl>, <seeerl marker="wxPreviewControlBar"><c>wxPreviewControlBar</c></seeerl>, <seeerl marker="wxPrintPreview"><c>wxPrintPreview</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxFrame"><c>wxFrame</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_preview_frame.html">wxPreviewFrame</url></p>
  </description>
<datatypes><datatype><name name="wxPreviewFrame"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Pass a print preview object plus other normal frame arguments. The print preview object will be destroyed by the frame when it closes. 
      </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="createControlBar" arity="1" clause_i="1" since=""/>
    <fsummary>Creates a <c>wxPreviewControlBar</c>. </fsummary>
    <desc><p>Creates a <seeerl marker="wxPreviewControlBar"><c>wxPreviewControlBar</c></seeerl>. 
      </p><p>Override this function to allow a user-defined preview control bar object to be created. 
      </p></desc>
  </func>
  
  <func>
    <name name="createCanvas" arity="1" clause_i="1" since=""/>
    <fsummary>Creates a <c>wxPreviewCanvas</c>. </fsummary>
    <desc><p>Creates a <seeerl marker="wxPreviewCanvas"><c>wxPreviewCanvas</c></seeerl>. 
      </p><p>Override this function to allow a user-defined preview canvas object to be created. 
      </p></desc>
  </func>
  
  <func>
    <name name="initialize" arity="1" clause_i="1" since=""/>
    <fsummary>Initializes the frame elements and prepares for showing it. </fsummary>
    <desc><p>Initializes the frame elements and prepares for showing it. 
      </p><p>Calling this method is equivalent to calling <c>InitializeWithModality()</c> (not implemented in wx) with wxPreviewFrame_AppModal argument, please see its documentation for more details.
      </p><p>Please notice that this function is virtual mostly for backwards compatibility only, there is no real need to override it as it's never called by wxWidgets itself. 
      </p></desc>
  </func>
  
  <func>
    <name name="onCloseWindow" arity="2" clause_i="1" since=""/>
    <fsummary>Enables any disabled frames in the application, and deletes the print preview object, implicitly deleting any printout objects associated with the print preview object. </fsummary>
    <desc><p>Enables any disabled frames in the application, and deletes the print preview object, implicitly deleting any printout objects associated with the print preview object. 
      </p></desc>
  </func>
  </funcs>
</erlref>
