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 wxObject
	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	wxPrintDialog(wxWindow parent, wxPrintData data);
	34
	35	/**
	36	Destructor.
	37
	38	If GetPrintDC() has not been called, the device context obtained by
	39	the dialog (if any) will be deleted.
	40	*/
	41	virtual ~wxPrintDialog();
	42
	43	/**
	44	Returns the device context created by the print dialog, if any.
	45
	46	When this function has been called, the ownership of the device context
	47	is transferred to the application, so it must then be deleted
	48	explicitly.
	49	*/
	50	virtual wxDC* GetPrintDC();
	51
	52	/**
	53	Returns the @ref overview_printing_printdata "print dialog data" associated
	54	with the print dialog.
	55	*/
	56	virtual wxPrintDialogData& GetPrintDialogData();
	57
	58	/**
	59	Returns the @ref overview_printing_printdata "print data" associated
	60	with the print dialog.
	61	*/
	62	virtual wxPrintData& GetPrintData();
	63
	64	/**
	65	Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
	66	wxID_CANCEL otherwise.
	67
	68	After this function is called, a device context may be retrievable using
	69	GetPrintDC().
	70	*/
	71	virtual int ShowModal();
	72	};
	73
	74
	75
	76	/**
	77	@class wxPageSetupDialog
	78
	79	This class represents the page setup common dialog.
	80
	81	The page setup dialog contains controls for paper size (letter, A4, A5 etc.),
	82	orientation (landscape or portrait), and, only under Windows currently,
	83	controls for setting left, top, right and bottom margin sizes in millimetres.
	84
	85	The exact appearance of this dialog varies among the platforms as a native
	86	dialog is used when available (currently the case for all major platforms).
	87
	88	When the dialog has been closed, you need to query the wxPageSetupDialogData
	89	object associated with the dialog.
	90
	91	Note that the OK and Cancel buttons do not destroy the dialog; this must be done
	92	by the application.
	93
	94	@library{wxcore}
	95	@category{printing}
	96
	97	@see @ref overview_printing, wxPrintDialog, wxPageSetupDialogData
	98	*/
	99	class wxPageSetupDialog : public wxObject
	100	{
	101	public:
	102	/**
	103	Constructor.
	104
	105	Pass a parent window, and optionally a pointer to a block of page
	106	setup data, which will be copied to the print dialog's internal data.
	107	*/
	108	wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
	109
	110	/**
	111	Destructor.
	112	*/
	113	virtual ~wxPageSetupDialog();
	114
	115	/**
	116	Returns the wxPageSetupDialogData object associated with the dialog.
	117	*/
	118	wxPageSetupDialogData& GetPageSetupData();
	119
	120	/**
	121	Shows the dialog, returning @c wxID_OK if the user pressed OK, and
	122	@c wxID_CANCEL otherwise.
	123	*/
	124	int ShowModal();
	125	};
	126