/////////////////////////////////////////////////////////////////////////////
// Name: richtext/richtextprint.h
-// Purpose: documentation for wxRichTextHeaderFooterData class
+// Purpose: interface of wxRichTextHeaderFooterData
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxRichTextHeaderFooterData
@headerfile richtextprint.h wx/richtext/richtextprint.h
-
-
+
+
This class represents header and footer data to be passed to the
wxRichTextPrinting and
wxRichTextPrintout classes.
-
+
Headers and footers can be specified independently for odd, even or both page
sides. Different text can be specified
for left, centre and right locations on the page, and the font and text colour
be specified. You can specify the following keywords in header and footer text,
which will
be substituted for the actual values during printing and preview.
-
+
@DATE@: the current date.
@PAGESCNT@: the total number of pages.
@PAGENUM@: the current page number.
@TIME@: the current time.
@TITLE@: the title of the document, as passed to the wxRichTextPrinting or
wxRichTextLayout constructor.
-
+
@library{wxrichtext}
- @category{FIXME}
+ @category{richtext}
*/
class wxRichTextHeaderFooterData : public wxObject
{
Constructors.
*/
wxRichTextHeaderFooterData();
- wxRichTextHeaderFooterData(const wxRichTextHeaderFooterData& data);
+ wxRichTextHeaderFooterData(const wxRichTextHeaderFooterData& data);
//@}
/**
/**
Returns the font specified for printing the header and footer.
*/
- const wxFont GetFont();
+ const wxFont GetFont() const;
/**
Returns the margin between the text and the footer.
*/
- int GetFooterMargin();
+ int GetFooterMargin() const;
/**
Returns the footer text on odd or even pages, and at a given position on the
page (left, centre or right).
*/
wxString GetFooterText(wxRichTextOddEvenPage page = wxRICHTEXT_PAGE_EVEN,
- wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE);
+ wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE) const;
/**
Returns the margin between the text and the header.
*/
- int GetHeaderMargin();
+ int GetHeaderMargin() const;
/**
Returns the header text on odd or even pages, and at a given position on the
page (left, centre or right).
*/
wxString GetHeaderText(wxRichTextOddEvenPage page = wxRICHTEXT_PAGE_EVEN,
- wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE);
+ wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE) const;
/**
Returns @true if the header and footer will be shown on the first page.
*/
- bool GetShowOnFirstPage();
+ bool GetShowOnFirstPage() const;
/**
Helper function for getting the header or footer text, odd or even pages, and
at a given position on the page (left, centre or right).
*/
wxString GetText(int headerFooter, wxRichTextOddEvenPage page,
- wxRichTextPageLocation location);
+ wxRichTextPageLocation location) const;
/**
Returns the text colour for drawing the header and footer.
*/
- const wxColour GetTextColour();
+ const wxColour GetTextColour() const;
/**
Initialises the object.
};
+
/**
@class wxRichTextPrintout
@headerfile richtextprint.h wx/richtext/richtextprint.h
-
+
This class implements print layout for wxRichTextBuffer. Instead of using it
directly, you
should normally use the wxRichTextPrinting class.
-
+
@library{wxrichtext}
- @category{FIXME}
+ @category{richtext}
*/
class wxRichTextPrintout : public wxPrintout
{
public:
/**
)
-
Constructor.
*/
wxRichTextPrintout();
/**
Returns the header and footer data associated with the printout.
*/
- const wxRichTextHeaderFooterData GetHeaderFooterData();
+ const wxRichTextHeaderFooterData GetHeaderFooterData() const;
/**
Gets the page information.
/**
Returns a pointer to the buffer being rendered.
*/
- wxRichTextBuffer* GetRichTextBuffer();
+ wxRichTextBuffer* GetRichTextBuffer() const;
/**
Returns @true if the given page exists in the printout.
};
+
/**
@class wxRichTextPrinting
@headerfile richtextprint.h wx/richtext/richtextprint.h
-
+
This class provides a simple interface for performing wxRichTextBuffer printing
and previewing. It uses wxRichTextPrintout for layout and rendering.
-
+
@library{wxrichtext}
- @category{FIXME}
+ @category{richtext}
*/
class wxRichTextPrinting : public wxObject
{
public:
/**
, @b wxWindow*@e 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.
for details.
*/
wxString GetFooterText(wxRichTextOddEvenPage page = wxRICHTEXT_PAGE_EVEN,
- wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE);
+ wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE) const;
/**
Returns the internal wxRichTextHeaderFooterData object.
*/
- const wxRichTextHeaderFooterData GetHeaderFooterData();
+ const wxRichTextHeaderFooterData GetHeaderFooterData() const;
/**
A convenience function to get the header text. See wxRichTextHeaderFooterData
for details.
*/
wxString GetHeaderText(wxRichTextOddEvenPage page = wxRICHTEXT_PAGE_EVEN,
- wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE);
+ wxRichTextPageLocation location = wxRICHTEXT_PAGE_CENTRE) const;
/**
Returns a pointer to the internal page setup data.
Returns the parent window to be used for the preview window and printing wait
dialog.
*/
- wxWindow* GetParentWindow();
+ wxWindow* GetParentWindow() const;
/**
Returns the dimensions to be used for the preview window.
*/
- const wxRect GetPreviewRect();
+ const wxRect GetPreviewRect() const;
/**
Returns a pointer to the internal print data.
/**
Returns the title of the preview window or printing wait caption.
*/
- const wxString GetTitle();
+ const wxString GetTitle() const;
/**
Shows the page setup dialog.
bool PreviewBuffer(const wxRichTextBuffer& buffer);
/**
- Shows a preview window for the given file. @e richTextFile can be a text file
+ Shows a preview window for the given file. @a richTextFile can be a text file
or XML file, or other file
depending on the available file handlers.
*/
bool PrintBuffer(const wxRichTextBuffer& buffer);
/**
- Prints the given file. @e richTextFile can be a text file or XML file, or other
+ Prints the given file. @a richTextFile can be a text file or XML file, or other
file
depending on the available file handlers.
*/
*/
void SetTitle(const wxString& title);
};
+
projects / wxWidgets.git / blobdiff