#include <wx/richtext/richtextprint.h>
This class provides a simple interface for performing wxRichTextBuffer printing and previewing.
It uses wxRichTextPrintout for layout and rendering.
<>< =''>:</>&;&;< =''>\ </></>
Public Member Functions | |
wxRichTextPrinting (const wxString &name="Printing", wxWindow *parentWindow=NULL) | |
Constructor. | |
wxString | GetFooterText (wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_EVEN, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) const |
A convenience function to get the footer text. | |
const wxRichTextHeaderFooterData & | GetHeaderFooterData () const |
Returns the internal wxRichTextHeaderFooterData object. | |
wxString | GetHeaderText (wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_EVEN, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) const |
A convenience function to get the header text. | |
wxPageSetupDialogData * | GetPageSetupData () |
Returns a pointer to the internal page setup data. | |
wxWindow * | GetParentWindow () const |
Returns the parent window to be used for the preview window and printing wait dialog. | |
const wxRect & | GetPreviewRect () const |
Returns the dimensions to be used for the preview window. | |
wxPrintData * | GetPrintData () |
Returns a pointer to the internal print data. | |
const wxString & | GetTitle () const |
Returns the title of the preview window or printing wait caption. | |
void | PageSetup () |
Shows the page setup dialog. | |
bool | PreviewBuffer (const wxRichTextBuffer &buffer) |
Shows a preview window for the given buffer. | |
bool | PreviewFile (const wxString &richTextFile) |
Shows a preview window for the given file. | |
bool | PrintBuffer (const wxRichTextBuffer &buffer, bool showPrintDialog=true) |
Prints the given buffer. | |
bool | PrintFile (const wxString &richTextFile, bool showPrintDialog=true) |
Prints the given file. | |
void | SetFooterText (const wxString &text, wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_ALL, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) |
A convenience function to set the footer text. | |
void | SetHeaderFooterData (const wxRichTextHeaderFooterData &data) |
Sets the internal wxRichTextHeaderFooterData object. | |
void | SetHeaderFooterFont (const wxFont &font) |
Sets the wxRichTextHeaderFooterData font. | |
void | SetHeaderFooterTextColour (const wxColour &colour) |
Sets the wxRichTextHeaderFooterData text colour. | |
void | SetHeaderText (const wxString &text, wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_ALL, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) |
A convenience function to set the header text. | |
void | SetPageSetupData (const wxPageSetupDialogData &pageSetupData) |
Sets the page setup data. | |
void | SetParentWindow (wxWindow *parent) |
Sets the parent window to be used for the preview window and printing wait dialog. | |
void | SetPreviewRect (const wxRect &rect) |
Sets the dimensions to be used for the preview window. | |
void | SetPrintData (const wxPrintData &printData) |
Sets the print data. | |
void | SetShowOnFirstPage (bool show) |
Pass true to show the header and footer on the first page. | |
void | SetTitle (const wxString &title) |
Pass the title of the preview window or printing wait caption. | |
![]() | |
wxObject () | |
Default ctor; initializes to NULL the internal reference data. | |
wxObject (const wxObject &other) | |
Copy ctor. | |
virtual | ~wxObject () |
Destructor. | |
virtual wxClassInfo * | GetClassInfo () const |
This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). | |
wxObjectRefData * | GetRefData () const |
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. | |
bool | IsKindOf (const wxClassInfo *info) const |
Determines whether this class is a subclass of (or the same class as) the given class. | |
bool | IsSameAs (const wxObject &obj) const |
Returns true if this object has the same data pointer as obj. | |
void | Ref (const wxObject &clone) |
Makes this object refer to the data in clone. | |
void | SetRefData (wxObjectRefData *data) |
Sets the wxObject::m_refData pointer. | |
void | UnRef () |
Decrements the reference count in the associated data, and if it is zero, deletes the data. | |
void | UnShare () |
This is the same of AllocExclusive() but this method is public. | |
void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
Additional Inherited Members | |
![]() | |
void | AllocExclusive () |
Ensure that this object's data is not shared with any other object. | |
virtual wxObjectRefData * | CreateRefData () const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. | |
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. | |
![]() | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. | |
wxRichTextPrinting::wxRichTextPrinting | ( | const wxString & | name = "Printing" , |
wxWindow * | parentWindow = NULL |
||
) |
Constructor.
Optionally pass a title to be used in the preview frame and printing wait dialog, and also a parent window for these windows.
wxString wxRichTextPrinting::GetFooterText | ( | wxRichTextOddEvenPage | page = wxRICHTEXT_PAGE_EVEN , |
wxRichTextPageLocation | location = wxRICHTEXT_PAGE_CENTRE |
||
) | const |
A convenience function to get the footer text.
See wxRichTextHeaderFooterData for details.
const wxRichTextHeaderFooterData & wxRichTextPrinting::GetHeaderFooterData | ( | ) | const |
Returns the internal wxRichTextHeaderFooterData object.
wxString wxRichTextPrinting::GetHeaderText | ( | wxRichTextOddEvenPage | page = wxRICHTEXT_PAGE_EVEN , |
wxRichTextPageLocation | location = wxRICHTEXT_PAGE_CENTRE |
||
) | const |
A convenience function to get the header text.
See wxRichTextHeaderFooterData for details.
wxPageSetupDialogData * wxRichTextPrinting::GetPageSetupData | ( | ) |
Returns a pointer to the internal page setup data.
wxWindow * wxRichTextPrinting::GetParentWindow | ( | ) | const |
Returns the parent window to be used for the preview window and printing wait dialog.
Returns the dimensions to be used for the preview window.
wxPrintData * wxRichTextPrinting::GetPrintData | ( | ) |
Returns a pointer to the internal print data.
Returns the title of the preview window or printing wait caption.
void wxRichTextPrinting::PageSetup | ( | ) |
Shows the page setup dialog.
bool wxRichTextPrinting::PreviewBuffer | ( | const wxRichTextBuffer & | buffer | ) |
Shows a preview window for the given buffer.
The function takes its own copy of buffer.
Shows a preview window for the given file.
richTextFile can be a text file or XML file, or other file depending on the available file handlers.
bool wxRichTextPrinting::PrintBuffer | ( | const wxRichTextBuffer & | buffer, |
bool | showPrintDialog = true |
||
) |
Prints the given buffer.
The function takes its own copy of buffer. showPrintDialog can be true to show the print dialog, or false to print quietly.
Prints the given file.
richTextFile can be a text file or XML file, or other file depending on the available file handlers. showPrintDialog can be true to show the print dialog, or false to print quietly.
void wxRichTextPrinting::SetFooterText | ( | const wxString & | text, |
wxRichTextOddEvenPage | page = wxRICHTEXT_PAGE_ALL , |
||
wxRichTextPageLocation | location = wxRICHTEXT_PAGE_CENTRE |
||
) |
A convenience function to set the footer text.
See wxRichTextHeaderFooterData for details.
void wxRichTextPrinting::SetHeaderFooterData | ( | const wxRichTextHeaderFooterData & | data | ) |
Sets the internal wxRichTextHeaderFooterData object.
Sets the wxRichTextHeaderFooterData font.
Sets the wxRichTextHeaderFooterData text colour.
void wxRichTextPrinting::SetHeaderText | ( | const wxString & | text, |
wxRichTextOddEvenPage | page = wxRICHTEXT_PAGE_ALL , |
||
wxRichTextPageLocation | location = wxRICHTEXT_PAGE_CENTRE |
||
) |
A convenience function to set the header text.
See wxRichTextHeaderFooterData for details.
void wxRichTextPrinting::SetPageSetupData | ( | const wxPageSetupDialogData & | pageSetupData | ) |
Sets the page setup data.
Sets the parent window to be used for the preview window and printing wait dialog.
Sets the dimensions to be used for the preview window.
void wxRichTextPrinting::SetPrintData | ( | const wxPrintData & | printData | ) |
Sets the print data.
Pass true to show the header and footer on the first page.