docs/latex/wx/richtextprintout.tex

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