summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxPreviewFrame.xml
blob: fc376ad716b2f6636d31ef2c0a0c0d6d8f1971f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?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>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </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>