wxPageSetupDialogData (wx v2.5.4)

Copy Markdown View Source

This class holds a variety of information related to wxPageSetupDialog.

It contains a wxPrintData member which is used to hold basic printer configuration data (as opposed to the user-interface configuration settings stored by wxPageSetupDialogData).

See:

wxWidgets docs: wxPageSetupDialogData

Summary

Types

wxPageSetupDialogData()

Functions

destroy(This)

Destroys the object

enableHelp(This, Flag)

Enables or disables the "Help" button (Windows only).

enableMargins(This, Flag)

Enables or disables the margin controls (Windows only).

enableOrientation(This, Flag)

Enables or disables the orientation control (Windows only).

enablePaper(This, Flag)

Enables or disables the paper size control (Windows only).

enablePrinter(This, Flag)

Enables or disables the "Printer" button, which invokes a printer setup dialog.

getDefaultInfo(This)

Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).

getDefaultMinMargins(This)

Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).

getEnableHelp(This)

Returns true if the printer setup button is enabled.

getEnableMargins(This)

Returns true if the margin controls are enabled (Windows only).

getEnableOrientation(This)

Returns true if the orientation control is enabled (Windows only).

getEnablePaper(This)

Returns true if the paper size control is enabled (Windows only).

getEnablePrinter(This)

Returns true if the printer setup button is enabled.

getMarginBottomRight(This)

Returns the right (x) and bottom (y) margins in millimetres.

getMarginTopLeft(This)

Returns the left (x) and top (y) margins in millimetres.

getMinMarginBottomRight(This)

Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).

getMinMarginTopLeft(This)

Returns the left (x) and top (y) minimum margins the user can enter (Windows only).

getPaperId(This)

Returns the paper id (stored in the internal wxPrintData object).

getPaperSize(This)

Returns the paper size in millimetres.

getPrintData(This)
isOk(This)

Returns true if the print data associated with the dialog data is valid.

new()

Default constructor.

new(PrintData)

Construct an object from a print data object.

setDefaultInfo(This, Flag)

Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).

setDefaultMinMargins(This, Flag)

Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).

setMarginBottomRight(This, Pt)

Sets the right (x) and bottom (y) margins in millimetres.

setMarginTopLeft(This, Pt)

Sets the left (x) and top (y) margins in millimetres.

setMinMarginBottomRight(This, Pt)

Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).

setMinMarginTopLeft(This, Pt)

Sets the left (x) and top (y) minimum margins the user can enter (Windows only).

setPaperId(This, Id)

Sets the paper size id.

setPaperSize(This, Size)

Sets the paper size in millimetres.

setPrintData(This, PrintData)

Sets the print data associated with this object.

Types

wxPageSetupDialogData()

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

Functions

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

Destroys the object

enableHelp(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Enables or disables the "Help" button (Windows only).

enableMargins(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Enables or disables the margin controls (Windows only).

enableOrientation(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Enables or disables the orientation control (Windows only).

enablePaper(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Enables or disables the paper size control (Windows only).

enablePrinter(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Enables or disables the "Printer" button, which invokes a printer setup dialog.

getDefaultInfo(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).

getDefaultMinMargins(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).

getEnableHelp(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the printer setup button is enabled.

getEnableMargins(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the margin controls are enabled (Windows only).

getEnableOrientation(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the orientation control is enabled (Windows only).

getEnablePaper(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the paper size control is enabled (Windows only).

getEnablePrinter(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the printer setup button is enabled.

getMarginBottomRight(This) -> Result

Types

This = wxPageSetupDialogData()
Result = {X :: integer(), Y :: integer()}

Returns the right (x) and bottom (y) margins in millimetres.

getMarginTopLeft(This) -> Result

Types

This = wxPageSetupDialogData()
Result = {X :: integer(), Y :: integer()}

Returns the left (x) and top (y) margins in millimetres.

getMinMarginBottomRight(This) -> Result

Types

This = wxPageSetupDialogData()
Result = {X :: integer(), Y :: integer()}

Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

getMinMarginTopLeft(This) -> Result

Types

This = wxPageSetupDialogData()
Result = {X :: integer(), Y :: integer()}

Returns the left (x) and top (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

getPaperId(This :: wxPageSetupDialogData()) -> wx:wx_enum()

Returns the paper id (stored in the internal wxPrintData object).

See: wxPrintData:setPaperId/2

getPaperSize(This) -> Result

Types

This = wxPageSetupDialogData()
Result = {W :: integer(), H :: integer()}

Returns the paper size in millimetres.

getPrintData(This :: wxPageSetupDialogData()) -> Result

Types

Result = wxPrintData:wxPrintData()

isOk(This :: wxPageSetupDialogData()) -> boolean()

Returns true if the print data associated with the dialog data is valid.

This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.

new() -> Result

Types

Result = wxPageSetupDialogData()

Default constructor.

new(PrintData) -> Result

Types

PrintData = wxPrintData:wxPrintData() | wxPageSetupDialogData:wxPageSetupDialogData()
Result = wxPageSetupDialogData()

Construct an object from a print data object.

setDefaultInfo(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).

setDefaultMinMargins(This :: wxPageSetupDialogData(), Flag :: boolean()) -> ok

Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).

Units are in millimetres.

setMarginBottomRight(This, Pt) -> ok

Types

This = wxPageSetupDialogData()
Pt = {X :: integer(), Y :: integer()}

Sets the right (x) and bottom (y) margins in millimetres.

setMarginTopLeft(This, Pt) -> ok

Types

This = wxPageSetupDialogData()
Pt = {X :: integer(), Y :: integer()}

Sets the left (x) and top (y) margins in millimetres.

setMinMarginBottomRight(This, Pt) -> ok

Types

This = wxPageSetupDialogData()
Pt = {X :: integer(), Y :: integer()}

Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

setMinMarginTopLeft(This, Pt) -> ok

Types

This = wxPageSetupDialogData()
Pt = {X :: integer(), Y :: integer()}

Sets the left (x) and top (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

setPaperId(This :: wxPageSetupDialogData(), Id :: wx:wx_enum()) -> ok

Sets the paper size id.

Calling this function overrides the explicit paper dimensions passed in setPaperSize/2.

See: wxPrintData:setPaperId/2

setPaperSize(This, Size) -> ok

Types

This = wxPageSetupDialogData()
Size = {W :: integer(), H :: integer()}

Sets the paper size in millimetres.

If a corresponding paper id is found, it will be set in the internal wxPrintData object, otherwise the paper size overrides the paper id.

setPrintData(This, PrintData) -> ok

Types

This = wxPageSetupDialogData()
PrintData = wxPrintData:wxPrintData()

Sets the print data associated with this object.