summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxPageSetupDialog.xml
blob: 2187fac6cde55fbdd714ce2def564497f4f00a19 (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
<?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>wxPageSetupDialog</title>
</header>
<module>wxPageSetupDialog</module>
<modulesummary>Functions for wxPageSetupDialog class</modulesummary>
<description><p>This class represents the page setup common dialog.
      </p><p>The page setup dialog contains controls for paper size (letter, A4, A5 etc.), orientation (landscape or portrait), and, only under Windows currently, controls for setting left, top, right and bottom margin sizes in millimetres.
      </p><p>The exact appearance of this dialog varies among the platforms as a native dialog is used when available (currently the case for all major platforms).
      </p><p>When the dialog has been closed, you need to query the <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl> object associated with the dialog.
      </p><p>Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the application.
      </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>, <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_page_setup_dialog.html">wxPageSetupDialog</url></p>
  </description>
<datatypes><datatype><name name="wxPageSetupDialog"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Pass a parent window, and optionally a pointer to a block of page setup data, which will be copied to the print dialog's internal data. 
      </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="getPageSetupData" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the <c>wxPageSetupDialogData</c> object associated with the dialog. </fsummary>
    <desc><p>Returns the <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl> object associated with the dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="showModal" arity="1" clause_i="1" since=""/>
    <fsummary>Shows the dialog, returning <c>wxID_OK</c> if the user pressed OK, and <c>wxID_CANCEL</c> otherwise. </fsummary>
    <desc><p>Shows the dialog, returning <c>wxID_OK</c> if the user pressed OK, and <c>wxID_CANCEL</c> otherwise. 
      </p></desc>
  </func>
  </funcs>
</erlref>