]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/richtextprinting.tex
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
removed empty and unused CalculateScrollbar() method
[wxWidgets.git] / docs / latex / wx / richtextprinting.tex
... / ...
CommitLineData
1\section{\class{wxRichTextPrinting}}\label{wxrichtextprinting}
2
3This class provides a simple interface for performing \helpref{wxRichTextBuffer}{wxrichtextbuffer} printing
4and previewing. It uses \helpref{wxRichTextPrintout}{wxrichtextprintout} for layout and rendering.
5
6\wxheading{Derived from}
7
8\helpref{wxObject}{wxobject}
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{wxRichTextPrinting::wxRichTextPrinting}\label{wxrichtextprintingwxrichtextprinting}
19
20\func{}{wxRichTextPrinting}{\param{const wxString\& }{name = wxT("Printing")}, \param{wxWindow* }{parentWindow = NULL}}
21
22Constructor. Optionally pass a title to be used in the preview frame and printing wait dialog, and
23also a parent window for these windows.
24
25\membersection{wxRichTextPrinting::GetFooterText}\label{wxrichtextprintinggetfootertext}
26
27\constfunc{wxString}{GetFooterText}{\param{wxRichTextOddEvenPage }{page = wxRICHTEXT\_PAGE\_EVEN}, \param{wxRichTextPageLocation }{location = wxRICHTEXT\_PAGE\_CENTRE}}
28
29A convenience function to get the footer text. See \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} for details.
30
31\membersection{wxRichTextPrinting::GetHeaderFooterData}\label{wxrichtextprintinggetheaderfooterdata}
32
33\constfunc{const wxRichTextHeaderFooterData\&}{GetHeaderFooterData}{\void}
34
35Returns the internal \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} object.
36
37\membersection{wxRichTextPrinting::GetHeaderText}\label{wxrichtextprintinggetheadertext}
38
39\constfunc{wxString}{GetHeaderText}{\param{wxRichTextOddEvenPage }{page = wxRICHTEXT\_PAGE\_EVEN}, \param{wxRichTextPageLocation }{location = wxRICHTEXT\_PAGE\_CENTRE}}
40
41A convenience function to get the header text. See \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} for details.
42
43\membersection{wxRichTextPrinting::GetPageSetupData}\label{wxrichtextprintinggetpagesetupdata}
44
45\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
46
47Returns a pointer to the internal page setup data.
48
49\membersection{wxRichTextPrinting::GetParentWindow}\label{wxrichtextprintinggetparentwindow}
50
51\constfunc{wxWindow*}{GetParentWindow}{\void}
52
53Returns the parent window to be used for the preview window and printing wait dialog.
54
55\membersection{wxRichTextPrinting::GetPreviewRect}\label{wxrichtextprintinggetpreviewrect}
56
57\constfunc{const wxRect\&}{GetPreviewRect}{\void}
58
59Returns the dimensions to be used for the preview window.
60
61\membersection{wxRichTextPrinting::GetPrintData}\label{wxrichtextprintinggetprintdata}
62
63\func{wxPrintData*}{GetPrintData}{\void}
64
65Returns a pointer to the internal print data.
66
67\membersection{wxRichTextPrinting::GetTitle}\label{wxrichtextprintinggettitle}
68
69\constfunc{const wxString\&}{GetTitle}{\void}
70
71Returns the title of the preview window or printing wait caption.
72
73\membersection{wxRichTextPrinting::PageSetup}\label{wxrichtextprintingpagesetup}
74
75\func{void}{PageSetup}{\void}
76
77Shows the page setup dialog.
78
79\membersection{wxRichTextPrinting::PreviewBuffer}\label{wxrichtextprintingpreviewbuffer}
80
81\func{bool}{PreviewBuffer}{\param{const wxRichTextBuffer\& }{buffer}}
82
83Shows a preview window for the given buffer. The function takes its own copy of {\it buffer}.
84
85\membersection{wxRichTextPrinting::PreviewFile}\label{wxrichtextprintingpreviewfile}
86
87\func{bool}{PreviewFile}{\param{const wxString\& }{richTextFile}}
88
89Shows a preview window for the given file. {\it richTextFile} can be a text file or XML file, or other file
90depending on the available file handlers.
91
92\membersection{wxRichTextPrinting::PrintBuffer}\label{wxrichtextprintingprintbuffer}
93
94\func{bool}{PrintBuffer}{\param{const wxRichTextBuffer\& }{buffer}}
95
96Prints the given buffer. The function takes its own copy of {\it buffer}.
97
98\membersection{wxRichTextPrinting::PrintFile}\label{wxrichtextprintingprintfile}
99
100\func{bool}{PrintFile}{\param{const wxString\& }{richTextFile}}
101
102Prints the given file. {\it richTextFile} can be a text file or XML file, or other file
103depending on the available file handlers.
104
105\membersection{wxRichTextPrinting::SetFooterText}\label{wxrichtextprintingsetfootertext}
106
107\func{void}{SetFooterText}{\param{const wxString\& }{text}, \param{wxRichTextOddEvenPage }{page = wxRICHTEXT\_PAGE\_ALL}, \param{wxRichTextPageLocation }{location = wxRICHTEXT\_PAGE\_CENTRE}}
108
109A convenience function to set the footer text. See \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} for details.
110
111\membersection{wxRichTextPrinting::SetHeaderFooterData}\label{wxrichtextprintingsetheaderfooterdata}
112
113\func{void}{SetHeaderFooterData}{\param{const wxRichTextHeaderFooterData\& }{data}}
114
115Sets the internal \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} object.
116
117\membersection{wxRichTextPrinting::SetHeaderFooterFont}\label{wxrichtextprintingsetheaderfooterfont}
118
119\func{void}{SetHeaderFooterFont}{\param{const wxFont\& }{font}}
120
121Sets the \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} font.
122
123\membersection{wxRichTextPrinting::SetHeaderFooterTextColour}\label{wxrichtextprintingsetheaderfootertextcolour}
124
125\func{void}{SetHeaderFooterTextColour}{\param{const wxColour\& }{colour}}
126
127Sets the \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} text colour.
128
129\membersection{wxRichTextPrinting::SetHeaderText}\label{wxrichtextprintingsetheadertext}
130
131\func{void}{SetHeaderText}{\param{const wxString\& }{text}, \param{wxRichTextOddEvenPage }{page = wxRICHTEXT\_PAGE\_ALL}, \param{wxRichTextPageLocation }{location = wxRICHTEXT\_PAGE\_CENTRE}}
132
133A convenience function to set the header text. See \helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata} for details.
134
135\membersection{wxRichTextPrinting::SetPageSetupData}\label{wxrichtextprintingsetpagesetupdata}
136
137\func{void}{SetPageSetupData}{\param{const wxPageSetupData\& }{pageSetupData}}
138
139Sets the page setup data.
140
141\membersection{wxRichTextPrinting::SetParentWindow}\label{wxrichtextprintingsetparentwindow}
142
143\func{void}{SetParentWindow}{\param{wxWindow* }{parent}}
144
145Sets the parent window to be used for the preview window and printing wait dialog.
146
147\membersection{wxRichTextPrinting::SetPreviewRect}\label{wxrichtextprintingsetpreviewrect}
148
149\func{void}{SetPreviewRect}{\param{const wxRect\& }{rect}}
150
151Sets the dimensions to be used for the preview window.
152
153\membersection{wxRichTextPrinting::SetPrintData}\label{wxrichtextprintingsetprintdata}
154
155\func{void}{SetPrintData}{\param{const wxPrintData\& }{printData}}
156
157Sets the print data.
158
159\membersection{wxRichTextPrinting::SetShowOnFirstPage}\label{wxrichtextprintingsetshowonfirstpage}
160
161\func{void}{SetShowOnFirstPage}{\param{bool }{show}}
162
163Pass \true to show the header and footer on the first page.
164
165\membersection{wxRichTextPrinting::SetTitle}\label{wxrichtextprintingsettitle}
166
167\func{void}{SetTitle}{\param{const wxString\& }{title}}
168
169Pass the title of the preview window or printing wait caption.
170
wxWidgets (Impactor)