git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/richtextprintout.tex

... / ...

Commit	Line	Data
	1	\section{\class{wxRichTextPrintout}}\label{wxrichtextprintout}
	2
	3	This class implements print layout for \helpref{wxRichTextBuffer}{wxrichtextbuffer}. Instead of using it directly, you
	4	should normally use the \helpref{wxRichTextPrinting}{wxrichtextprinting} class.
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxPrintout}{wxprintout}
	9
	10	\wxheading{Include files}
	11
	12	<wx/richtext/richtextprint.h>
	13
	14	\wxheading{Library}
	15
	16	\helpref{wxRichtext}{librarieslist}
	17
	18	\wxheading{Data structures}
	19
	20	\latexignore{\rtfignore{\wxheading{Members}}}
	21
	22	\membersection{wxRichTextPrintout::wxRichTextPrintout}\label{wxrichtextprintoutwxrichtextprintout}
	23
	24	\func{}{wxRichTextPrintout}{\param{const wxString\& }{title = wxT("Printout")}}
	25
	26	Constructor.
	27
	28	\membersection{wxRichTextPrintout::CalculateScaling}\label{wxrichtextprintoutcalculatescaling}
	29
	30	\func{void}{CalculateScaling}{\param{wxDC* }{dc}, \param{wxRect\& }{textRect}, \param{wxRect\& }{headerRect}, \param{wxRect\& }{footerRect}}
	31
	32	Calculates scaling and text, header and footer rectangles.
	33
	34	\membersection{wxRichTextPrintout::GetHeaderFooterData}\label{wxrichtextprintoutgetheaderfooterdata}
	35
	36	\constfunc{const wxRichTextHeaderFooterData\&}{GetHeaderFooterData}{\void}
	37
	38	Returns the header and footer data associated with the printout.
	39
	40	\membersection{wxRichTextPrintout::GetPageInfo}\label{wxrichtextprintoutgetpageinfo}
	41
	42	\func{void}{GetPageInfo}{\param{int* }{minPage}, \param{int* }{maxPage}, \param{int* }{selPageFrom}, \param{int* }{selPageTo}}
	43
	44	Gets the page information.
	45
	46	\membersection{wxRichTextPrintout::GetRichTextBuffer}\label{wxrichtextprintoutgetrichtextbuffer}
	47
	48	\constfunc{wxRichTextBuffer*}{GetRichTextBuffer}{\void}
	49
	50	Returns a pointer to the buffer being rendered.
	51
	52	\membersection{wxRichTextPrintout::HasPage}\label{wxrichtextprintouthaspage}
	53
	54	\func{bool}{HasPage}{\param{int }{page}}
	55
	56	Returns \true if the given page exists in the printout.
	57
	58	\membersection{wxRichTextPrintout::OnPreparePrinting}\label{wxrichtextprintoutonprepareprinting}
	59
	60	\func{void}{OnPreparePrinting}{\void}
	61
	62	Prepares for printing, laying out the buffer and calculating pagination.
	63
	64	\membersection{wxRichTextPrintout::OnPrintPage}\label{wxrichtextprintoutonprintpage}
	65
	66	\func{bool}{OnPrintPage}{\param{int }{page}}
	67
	68	Does the actual printing for this page.
	69
	70	\membersection{wxRichTextPrintout::SetHeaderFooterData}\label{wxrichtextprintoutsetheaderfooterdata}
	71
	72	\func{void}{SetHeaderFooterData}{\param{const wxRichTextHeaderFooterData\& }{data}}
	73
	74	Sets the header and footer data associated with the printout.
	75
	76	\membersection{wxRichTextPrintout::SetMargins}\label{wxrichtextprintoutsetmargins}
	77
	78	\func{void}{SetMargins}{\param{int }{top = 252}, \param{int }{bottom = 252}, \param{int }{left = 252}, \param{int }{right = 252}}
	79
	80	Sets margins in 10ths of millimetre. Defaults to 1 inch for margins.
	81
	82	\membersection{wxRichTextPrintout::SetRichTextBuffer}\label{wxrichtextprintoutsetrichtextbuffer}
	83
	84	\func{void}{SetRichTextBuffer}{\param{wxRichTextBuffer* }{buffer}}
	85
	86	Sets the buffer to print. wxRichTextPrintout does not manage this pointer; it should
	87	be managed by the calling code, such as wxRichTextPrinting.
	88