Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxPageSetupDialog (3erl)

Name

wxPageSetupDialog - Functions for wxPageSetupDialog class

Synopsis

Please see following description for synopsis

Description

wxPageSetupDialog(3)       Erlang Module Definition       wxPageSetupDialog(3)



NAME
       wxPageSetupDialog - Functions for wxPageSetupDialog class

DESCRIPTION
       This class represents the page setup common dialog.

       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.

       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).

       When the dialog has been closed, you need to query  the  wxPageSetupDi-
       alogData object associated with the dialog.

       Note  that  the  OK  and Cancel buttons do not destroy the dialog; this
       must be done by the application.

       See: Overview printing, wxPrintDialog, wxPageSetupDialogData

       wxWidgets docs: wxPageSetupDialog

DATA TYPES
       wxPageSetupDialog() = wx:wx_object()

EXPORTS
       new(Parent) -> wxPageSetupDialog()

              Types:

                 Parent = wxWindow:wxWindow()

       new(Parent, Options :: [Option]) -> wxPageSetupDialog()

              Types:

                 Parent = wxWindow:wxWindow()
                 Option  =   {data,   wxPageSetupDialogData:wxPageSetupDialog-
                 Data()}

              Constructor.

              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.

       destroy(This :: wxPageSetupDialog()) -> ok

              Destructor.

       getPageSetupData(This) ->
                           wxPageSetupDialogData:wxPageSetupDialogData()

              Types:

                 This = wxPageSetupDialog()

              Returns  the  wxPageSetupDialogData  object  associated with the
              dialog.

       showModal(This) -> integer()

              Types:

                 This = wxPageSetupDialog()

              Shows the dialog, returning wxID_OK if the user pressed OK,  and
              wxID_CANCEL otherwise.



wxWidgets team.                    wx 2.1.1               wxPageSetupDialog(3)