mac paths updated

[wxWidgets.git] / interface / richtext / richtextprint.h

diff --git a/interface/richtext/richtextprint.h b/interface/richtext/richtextprint.h
index 35dd8a3092b7b929bfe4658d1eda6f4e37149816..2c70bdbf5d224bab0aabb8e921e384a1dfba564c 100644 (file)
--- a/interface/richtext/richtextprint.h
+++ b/interface/richtext/richtextprint.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        richtext/richtextprint.h
-// Purpose:     documentation for wxRichTextHeaderFooterData class
+// Purpose:     interface of wxRichTextHeaderFooterData
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -31,7 +31,7 @@
     wxRichTextLayout constructor.
 
     @library{wxrichtext}
-    @category{FIXME}
+    @category{richtext}
 */
 class wxRichTextHeaderFooterData : public wxObject
 {
@@ -57,48 +57,48 @@ public:
     /**
         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.
@@ -156,6 +156,7 @@ public:
 };
 
 
+
 /**
     @class wxRichTextPrintout
     @headerfile richtextprint.h wx/richtext/richtextprint.h
@@ -165,14 +166,13 @@ public:
     should normally use the wxRichTextPrinting class.
 
     @library{wxrichtext}
-    @category{FIXME}
+    @category{richtext}
 */
 class wxRichTextPrintout : public wxPrintout
 {
 public:
     /**
         )
-        
         Constructor.
     */
     wxRichTextPrintout();
@@ -187,7 +187,7 @@ public:
     /**
         Returns the header and footer data associated with the printout.
     */
-    const wxRichTextHeaderFooterData GetHeaderFooterData();
+    const wxRichTextHeaderFooterData GetHeaderFooterData() const;
 
     /**
         Gets the page information.
@@ -198,7 +198,7 @@ public:
     /**
         Returns a pointer to the buffer being rendered.
     */
-    wxRichTextBuffer* GetRichTextBuffer();
+    wxRichTextBuffer* GetRichTextBuffer() const;
 
     /**
         Returns @true if the given page exists in the printout.
@@ -235,6 +235,7 @@ public:
 };
 
 
+
 /**
     @class wxRichTextPrinting
     @headerfile richtextprint.h wx/richtext/richtextprint.h
@@ -243,14 +244,13 @@ public:
     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.
@@ -262,19 +262,19 @@ public:
         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.
@@ -285,12 +285,12 @@ public:
         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.
@@ -300,7 +300,7 @@ public:
     /**
         Returns the title of the preview window or printing wait caption.
     */
-    const wxString GetTitle();
+    const wxString GetTitle() const;
 
     /**
         Shows the page setup dialog.
@@ -314,7 +314,7 @@ public:
     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.
     */
@@ -326,7 +326,7 @@ public:
     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.
     */
@@ -394,3 +394,4 @@ public:
     */
     void SetTitle(const wxString& title);
 };
+