]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/richtextprintout.tex
remove just added wxCoordRound() (see patch 1586499)
[wxWidgets.git] / docs / latex / wx / richtextprintout.tex
CommitLineData
62f4313b
JS
1\section{\class{wxRichTextPrintout}}\label{wxrichtextprintout}
2
3This class implements print layout for \helpref{wxRichTextBuffer}{wxrichtextbuffer}. Instead of using it directly, you
4should 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{Data structures}
15
16\latexignore{\rtfignore{\wxheading{Members}}}
17
18\membersection{wxRichTextPrintout::wxRichTextPrintout}\label{wxrichtextprintoutwxrichtextprintout}
19
20\func{}{wxRichTextPrintout}{\param{const wxString\& }{title = wxT("Printout")}}
21
22Constructor.
23
24\membersection{wxRichTextPrintout::CalculateScaling}\label{wxrichtextprintoutcalculatescaling}
25
26\func{void}{CalculateScaling}{\param{wxDC* }{dc}, \param{wxRect\& }{textRect}, \param{wxRect\& }{headerRect}, \param{wxRect\& }{footerRect}}
27
28Calculates scaling and text, header and footer rectangles.
29
30\membersection{wxRichTextPrintout::GetHeaderFooterData}\label{wxrichtextprintoutgetheaderfooterdata}
31
32\constfunc{const wxRichTextHeaderFooterData\&}{GetHeaderFooterData}{\void}
33
34Returns the header and footer data associated with the printout.
35
36\membersection{wxRichTextPrintout::GetPageInfo}\label{wxrichtextprintoutgetpageinfo}
37
38\func{void}{GetPageInfo}{\param{int* }{minPage}, \param{int* }{maxPage}, \param{int* }{selPageFrom}, \param{int* }{selPageTo}}
39
40Gets the page information.
41
42\membersection{wxRichTextPrintout::GetRichTextBuffer}\label{wxrichtextprintoutgetrichtextbuffer}
43
44\constfunc{wxRichTextBuffer*}{GetRichTextBuffer}{\void}
45
46Returns a pointer to the buffer being rendered.
47
48\membersection{wxRichTextPrintout::HasPage}\label{wxrichtextprintouthaspage}
49
50\func{bool}{HasPage}{\param{int }{page}}
51
52Returns \true if the given page exists in the printout.
53
54\membersection{wxRichTextPrintout::OnPreparePrinting}\label{wxrichtextprintoutonprepareprinting}
55
56\func{void}{OnPreparePrinting}{\void}
57
58Prepares for printing, laying out the buffer and calculating pagination.
59
60\membersection{wxRichTextPrintout::OnPrintPage}\label{wxrichtextprintoutonprintpage}
61
62\func{bool}{OnPrintPage}{\param{int }{page}}
63
64Does the actual printing for this page.
65
66\membersection{wxRichTextPrintout::SetHeaderFooterData}\label{wxrichtextprintoutsetheaderfooterdata}
67
68\func{void}{SetHeaderFooterData}{\param{const wxRichTextHeaderFooterData\& }{data}}
69
70Sets the header and footer data associated with the printout.
71
72\membersection{wxRichTextPrintout::SetMargins}\label{wxrichtextprintoutsetmargins}
73
74\func{void}{SetMargins}{\param{int }{top = 252}, \param{int }{bottom = 252}, \param{int }{left = 252}, \param{int }{right = 252}}
75
76Sets margins in 10ths of millimetre. Defaults to 1 inch for margins.
77
78\membersection{wxRichTextPrintout::SetRichTextBuffer}\label{wxrichtextprintoutsetrichtextbuffer}
79
80\func{void}{SetRichTextBuffer}{\param{wxRichTextBuffer* }{buffer}}
81
82Sets the buffer to print. wxRichTextPrintout does not manage this pointer; it should
83be managed by the calling code, such as wxRichTextPrinting.
84