wxWidgets/interface/wx/printdlg.h
Vadim Zeitlin 947c91dae1 Remove obsolete parts of wxPageSetupDialog documentation.
Don't speak about features "new" in Windows 95 nor 4.0 any more (what next,
discussion of wxWidgets limitations when running on an abacus?) but do mention
that this dialog is native under all major platforms now.

Closes #11820.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-03-20 13:18:28 +00:00

120 lines
3.3 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: printdlg.h
// Purpose: interface of wxPrintDialog
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxPrintDialog
This class represents the print and print setup common dialogs.
You may obtain a wxPrinterDC device context from a successfully dismissed
print dialog.
@library{wxcore}
@category{printing}
@see @ref overview_printing, @ref overview_cmndlg_print
*/
class wxPrintDialog : public wxDialog
{
public:
/**
Constructor.
Pass a parent window, and optionally a pointer to a block of print
data, which will be copied to the print dialog's print data.
@see wxPrintDialogData
*/
wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
/**
Destructor.
If GetPrintDC() has not been called, the device context obtained by
the dialog (if any) will be deleted.
*/
virtual ~wxPrintDialog();
/**
Returns the device context created by the print dialog, if any.
When this function has been called, the ownership of the device context
is transferred to the application, so it must then be deleted
explicitly.
*/
virtual wxDC* GetPrintDC();
/**
Returns the @ref overview_printing_printdata "print dialog data" associated
with the print dialog.
*/
virtual wxPrintDialogData& GetPrintDialogData();
/**
Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
wxID_CANCEL otherwise.
After this function is called, a device context may be retrievable using
GetPrintDC().
*/
virtual int ShowModal();
};
/**
@class wxPageSetupDialog
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.
@library{wxcore}
@category{printing}
@see @ref overview_printing, wxPrintDialog, wxPageSetupDialogData
*/
class wxPageSetupDialog : public wxDialog
{
public:
/**
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.
*/
wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
/**
Destructor.
*/
virtual ~wxPageSetupDialog();
/**
Returns the wxPageSetupDialogData object associated with the dialog.
*/
wxPageSetupDialogData& GetPageSetupData();
/**
Shows the dialog, returning @c wxID_OK if the user pressed OK, and
@c wxID_CANCEL otherwise.
*/
int ShowModal();
};