mac paths updated

[wxWidgets.git] / interface / html / htmprint.h

diff --git a/interface/html/htmprint.h b/interface/html/htmprint.h
index 07c6476c89b58c7e5b04d9ba83b0be7873e8a39e..7e5cb99a0664a170573c07789e456b41eb6aa972 100644 (file)
--- a/interface/html/htmprint.h
+++ b/interface/html/htmprint.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmprint.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmprint.h

-// Purpose:     documentation for wxHtmlDCRenderer class
+// Purpose:     interface of wxHtmlDCRenderer

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -39,56 +39,50 @@ public:
         Renders HTML text to the DC.
         
         @param x,y
         Renders HTML text to the DC.
         
         @param x,y

-        position of upper-left corner of printing rectangle (see SetSize)
-        
+            position of upper-left corner of printing rectangle (see SetSize)

         @param from
         @param from

-        y-coordinate of the very first visible cell
-        
+            y-coordinate of the very first visible cell

         @param dont_render
         @param dont_render

-        if @true then this method only returns y coordinate of the next page
-        and does not output anything
+            if @true then this method only returns y coordinate of the next page
+            and does not output anything

     */
     */

-    int Render(int x, int y, int from = 0, int dont_render = @false);
+    int Render(int x, int y, int from = 0, int dont_render = false);

 
     /**
         Assign DC instance to the renderer.
 
     /**
         Assign DC instance to the renderer.

-        
-        @e pixel_scale can be used when rendering to high-resolution DCs (e.g. printer)
+        @a pixel_scale can be used when rendering to high-resolution DCs (e.g. printer)

         to adjust size of pixel metrics.
         (Many dimensions in HTML are given in pixels -- e.g. image sizes. 300x300 image
         would be only one
         inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
     */
         to adjust size of pixel metrics.
         (Many dimensions in HTML are given in pixels -- e.g. image sizes. 300x300 image
         would be only one
         inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
     */

-#define void SetDC(wxDC* dc, double pixel_scale = 1.0)     /* implementation is private */
+    void SetDC(wxDC* dc, double pixel_scale = 1.0);

 
     /**
         Sets fonts. See wxHtmlWindow::SetFonts for
         detailed description.
 
     /**
         Sets fonts. See wxHtmlWindow::SetFonts for
         detailed description.

-        

         See also SetSize().
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,
         See also SetSize().
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,

-                  const int sizes = @NULL);
+                  const int sizes = NULL);

 
     /**
         Assign text to the renderer. Render() then draws
         the text onto DC.
         
         @param html
 
     /**
         Assign text to the renderer. Render() then draws
         the text onto DC.
         
         @param html

-        HTML text. This is not a filename.
-        
+            HTML text. This is not a filename.

         @param basepath
         @param basepath

-        base directory (html string would be stored there if it was in
-        file). It is used to determine path for loading images, for example.
-        
+            base directory (html string would be stored there if it was in
+            file). It is used to determine path for loading images, for example.

         @param isdir
         @param isdir

-        @false if basepath is filename, @true if it is directory name
-        (see wxFileSystem for detailed explanation)
+            @false if basepath is filename, @true if it is directory name
+            (see wxFileSystem for detailed explanation)

     */
     void SetHtmlText(const wxString& html,
                      const wxString& basepath = wxEmptyString,
     */
     void SetHtmlText(const wxString& html,
                      const wxString& basepath = wxEmptyString,

-                     bool isdir = @true);
+                     bool isdir = true);

 
     /**
         Set size of output rectangle, in pixels. Note that you @b can't change
 
     /**
         Set size of output rectangle, in pixels. Note that you @b can't change


@@ -99,6 +93,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxHtmlEasyPrinting
     @headerfile htmprint.h wx/html/htmprint.h
 /**
     @class wxHtmlEasyPrinting
     @headerfile htmprint.h wx/html/htmprint.h


@@ -117,14 +112,13 @@ public:
         Constructor.
         
         @param name
         Constructor.
         
         @param name

-        Name of the printing object. Used by preview frames and setup dialogs.
-        
+            Name of the printing object. Used by preview frames and setup dialogs.

         @param parentWindow
         @param parentWindow

-        pointer to the window that will own the preview frame and setup dialogs. May be
-        @NULL.
+            pointer to the window that will own the preview frame and setup dialogs.
+        May be @NULL.

     */
     wxHtmlEasyPrinting(const wxString& name = "Printing",
     */
     wxHtmlEasyPrinting(const wxString& name = "Printing",

-                       wxWindow* parentWindow = @NULL);
+                       wxWindow* parentWindow = NULL);

 
     /**
         Returns a pointer to wxPageSetupDialogData instance used by
 
     /**
         Returns a pointer to wxPageSetupDialogData instance used by


@@ -135,7 +129,7 @@ public:
     /**
         Gets the parent window for dialogs.
     */
     /**
         Gets the parent window for dialogs.
     */

-    wxWindow* GetParentWindow();
+    wxWindow* GetParentWindow() const;

 
     /**
         Returns pointer to wxPrintData instance used by this class. You can
 
     /**
         Returns pointer to wxPrintData instance used by this class. You can


@@ -150,7 +144,6 @@ public:
 
     /**
         Preview HTML file.
 
     /**
         Preview HTML file.

-        

         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.
         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.


@@ -159,24 +152,21 @@ public:
 
     /**
         Preview HTML text (not file!).
 
     /**
         Preview HTML text (not file!).

-        

         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.
         
         @param htmltext
         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.
         
         @param htmltext

-        HTML text.
-        
+            HTML text.

         @param basepath
         @param basepath

-        base directory (html string would be stored there if it was in
-        file). It is used to determine path for loading images, for example.
+            base directory (html string would be stored there if it was in
+            file). It is used to determine path for loading images, for example.

     */
     bool PreviewText(const wxString& htmltext,
                      const wxString& basepath = wxEmptyString);
 
     /**
         Print HTML file.
     */
     bool PreviewText(const wxString& htmltext,
                      const wxString& basepath = wxEmptyString);
 
     /**
         Print HTML file.

-        

         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.
         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.


@@ -185,17 +175,15 @@ public:
 
     /**
         Print HTML text (not file!).
 
     /**
         Print HTML text (not file!).

-        

         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.
         
         @param htmltext
         Returns @false in case of error -- call
         wxPrinter::GetLastError to get detailed
         information about the kind of the error.
         
         @param htmltext

-        HTML text.
-        
+            HTML text.

         @param basepath
         @param basepath

-        base directory (html string would be stored there if it was in
-        file). It is used to determine path for loading images, for example.
+            base directory (html string would be stored there if it was in
+            file). It is used to determine path for loading images, for example.

     */
     bool PrintText(const wxString& htmltext,
                    const wxString& basepath = wxEmptyString);
     */
     bool PrintText(const wxString& htmltext,
                    const wxString& basepath = wxEmptyString);


@@ -206,11 +194,10 @@ public:
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,

-                  const int sizes = @NULL);
+                  const int sizes = NULL);

 
     /**
         Set page footer. The following macros can be used inside it:
 
     /**
         Set page footer. The following macros can be used inside it:

-        

          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages
          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages


@@ -218,16 +205,14 @@ public:
          @TITLE@ is replaced with the title of the document
         
         @param footer
          @TITLE@ is replaced with the title of the document
         
         @param footer

-        HTML text to be used as footer.
-        
+            HTML text to be used as footer.

         @param pg
         @param pg

-        one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
+            one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.

     */
     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 
     /**
         Set page header. The following macros can be used inside it:
     */
     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 
     /**
         Set page header. The following macros can be used inside it:

-        

          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages
          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages


@@ -235,10 +220,9 @@ public:
          @TITLE@ is replaced with the title of the document
         
         @param header
          @TITLE@ is replaced with the title of the document
         
         @param header

-        HTML text to be used as header.
-        
+            HTML text to be used as header.

         @param pg
         @param pg

-        one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
+            one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.

     */
     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 
     */
     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 


@@ -249,6 +233,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxHtmlPrintout
     @headerfile htmprint.h wx/html/htmprint.h
 /**
     @class wxHtmlPrintout
     @headerfile htmprint.h wx/html/htmprint.h


@@ -279,11 +264,10 @@ public:
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,

-                  const int sizes = @NULL);
+                  const int sizes = NULL);

 
     /**
         Set page footer. The following macros can be used inside it:
 
     /**
         Set page footer. The following macros can be used inside it:

-        

          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages
          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages


@@ -291,16 +275,14 @@ public:
          @TITLE@ is replaced with the title of the document
         
         @param footer
          @TITLE@ is replaced with the title of the document
         
         @param footer

-        HTML text to be used as footer.
-        
+            HTML text to be used as footer.

         @param pg
         @param pg

-        one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
+            one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.

     */
     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 
     /**
         Set page header. The following macros can be used inside it:
     */
     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 
     /**
         Set page header. The following macros can be used inside it:

-        

          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages
          @DATE@ is replaced by the current date in default format
          @PAGENUM@ is replaced by page number
          @PAGESCNT@ is replaced by total number of pages


@@ -308,10 +290,9 @@ public:
          @TITLE@ is replaced with the title of the document
         
         @param header
          @TITLE@ is replaced with the title of the document
         
         @param header

-        HTML text to be used as header.
-        
+            HTML text to be used as header.

         @param pg
         @param pg

-        one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
+            one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.

     */
     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 
     */
     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 


@@ -325,19 +306,17 @@ public:
         Prepare the class for printing this HTML text.
         
         @param html
         Prepare the class for printing this HTML text.
         
         @param html

-        HTML text. (NOT file!)
-        
+            HTML text. (NOT file!)

         @param basepath
         @param basepath

-        base directory (html string would be stored there if it was in
-        file). It is used to determine path for loading images, for example.
-        
+            base directory (html string would be stored there if it was in
+            file). It is used to determine path for loading images, for example.

         @param isdir
         @param isdir

-        @false if basepath is filename, @true if it is directory name
-        (see wxFileSystem for detailed explanation)
+            @false if basepath is filename, @true if it is directory name
+            (see wxFileSystem for detailed explanation)

     */
     void SetHtmlText(const wxString& html,
                      const wxString& basepath = wxEmptyString,
     */
     void SetHtmlText(const wxString& html,
                      const wxString& basepath = wxEmptyString,

-                     bool isdir = @true);
+                     bool isdir = true);

 
     /**
         Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space
 
     /**
         Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space


@@ -348,3 +327,4 @@ public:
                     float right = 25.2,
                     float spaces = 5);
 };
                     float right = 25.2,
                     float spaces = 5);
 };

+