git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: printdlg.h
	3	// Purpose: interface of wxPrintDialog
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxPrintDialog
	11
	12	This class represents the print and print setup common dialogs.
	13	You may obtain a wxPrinterDC device context from a successfully dismissed
	14	print dialog.
	15
	16	@library{wxcore}
	17	@category{printing}
	18
	19	@see @ref overview_printing, @ref overview_cmndlg_print
	20	*/
	21	class wxPrintDialog : public wxDialog
	22	{
	23	public:
	24	/**
	25	Constructor.
	26
	27	Pass a parent window, and optionally a pointer to a block of print
	28	data, which will be copied to the print dialog's print data.
	29
	30	@see wxPrintDialogData
	31	*/
	32	wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
	33
	34	/**
	35	Destructor.
	36
	37	If GetPrintDC() has not been called, the device context obtained by
	38	the dialog (if any) will be deleted.
	39	*/
	40	virtual ~wxPrintDialog();
	41
	42	/**
	43	Returns the device context created by the print dialog, if any.
	44
	45	When this function has been called, the ownership of the device context
	46	is transferred to the application, so it must then be deleted
	47	explicitly.
	48	*/
	49	virtual wxDC* GetPrintDC();
	50
	51	/**
	52	Returns the @ref overview_printing_printdata "print dialog data" associated
	53	with the print dialog.
	54	*/
	55	virtual wxPrintDialogData& GetPrintDialogData();
	56
	57	/**
	58	Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
	59	wxID_CANCEL otherwise.
	60
	61	After this function is called, a device context may be retrievable using
	62	GetPrintDC().
	63	*/
	64	virtual int ShowModal();
	65	};
	66
	67
	68
	69	/**
	70	@class wxPageSetupDialog
	71
	72	This class represents the page setup common dialog.
	73
	74	The page setup dialog contains controls for paper size (letter, A4, A5 etc.),
	75	orientation (landscape or portrait), and, only under Windows currently,
	76	controls for setting left, top, right and bottom margin sizes in millimetres.
	77
	78	The exact appearance of this dialog varies among the platforms as a native
	79	dialog is used when available (currently the case for all major platforms).
	80
	81	When the dialog has been closed, you need to query the wxPageSetupDialogData
	82	object associated with the dialog.
	83
	84	Note that the OK and Cancel buttons do not destroy the dialog; this must be done
	85	by the application.
	86
	87	@library{wxcore}
	88	@category{printing}
	89
	90	@see @ref overview_printing, wxPrintDialog, wxPageSetupDialogData
	91	*/
	92	class wxPageSetupDialog : public wxDialog
	93	{
	94	public:
	95	/**
	96	Constructor.
	97
	98	Pass a parent window, and optionally a pointer to a block of page
	99	setup data, which will be copied to the print dialog's internal data.
	100	*/
	101	wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
	102
	103	/**
	104	Destructor.
	105	*/
	106	virtual ~wxPageSetupDialog();
	107
	108	/**
	109	Returns the wxPageSetupDialogData object associated with the dialog.
	110	*/
	111	wxPageSetupDialogData& GetPageSetupData();
	112
	113	/**
	114	Shows the dialog, returning @c wxID_OK if the user pressed OK, and
	115	@c wxID_CANCEL otherwise.
	116	*/
	117	int ShowModal();
	118	};
	119