wxPageSetupDialog — wx v2.4.2

Search documentation of wx

# View Source wxPageSetupDialog (wx v2.4.2)

Functions for wxPageSetupDialog class

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 `wxPageSetupDialogData` 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

# Summary

## Types

wxPageSetupDialog()

## Functions

destroy(This)

Destructor.

getPageSetupData(This)

Returns the `wxPageSetupDialogData` object associated with the dialog.

new(Parent)
new/2

Constructor.

showModal(This)

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

# Types

Link to this type

# wxPageSetupDialog()

View Source

    -type wxPageSetupDialog() :: wx:wx_object().

# Functions

Link to this function

# destroy(This)

View Source

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

Destructor.

Link to this function

# getPageSetupData(This)

View Source

    -spec getPageSetupData(This) -> wxPageSetupDialogData:wxPageSetupDialogData()
                              when This :: wxPageSetupDialog().

Returns the `wxPageSetupDialogData` object associated with the dialog.

Link to this function

# new(Parent)

View Source

    -spec new(Parent) -> wxPageSetupDialog() when Parent :: wxWindow:wxWindow().

Link to this function

# new/2

View Source

    -spec new(Parent, [Option]) -> wxPageSetupDialog()
                 when
                     Parent :: wxWindow:wxWindow(),
                     Option :: {data, wxPageSetupDialogData:wxPageSetupDialogData()}.

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.

Link to this function

# showModal(This)

View Source

    -spec showModal(This) -> integer() when This :: wxPageSetupDialog().

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