wxwidgets/interface/wx/printdlg.h
Vadim Zeitlin 4f4c5fcfdf Use nullptr instead of NULL in the code and documentation
This is a combination of running clang-tidy with modernize-use-nullptr
check for some ports (GTK, X11, OSX) and manual changes to the ports for
which it couldn't be used easily (MSW, DFB) and also manually updating
the docs.

Also replace NULL with null or nullptr in the comments as this is more
consistent with the use of nullptr in the code and makes it simpler to
grep for the remaining occurrences of NULL itself.

And also use null in the assert messages.

Only a few occurrences of "NULL" are still left in non-C files, mostly
corresponding to unclear comments or string output which it might not be
safe to change.
2022-10-18 01:25:25 +02:00

125 lines
3.5 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: printdlg.h
// Purpose: interface of wxPrintDialog
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@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 wxObject
{
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 = nullptr);
wxPrintDialog(wxWindow *parent, wxPrintData* data);
/**
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();
/**
Returns the @ref overview_printing_printdata "print data" associated
with the print dialog.
*/
virtual wxPrintData& GetPrintData();
/**
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 wxObject
{
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 = nullptr);
/**
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();
};