Document and test behaviour of wxRegion methods when it is invalid.

[wxWidgets.git] / interface / wx / richtext / richtexthtml.h

diff --git a/interface/wx/richtext/richtexthtml.h b/interface/wx/richtext/richtexthtml.h
index a4baf9d6d2e690931d6d4c414d1dc785d6ea879a..f347288f80b83284899f93ccb087838094d40aa3 100644 (file)
--- a/interface/wx/richtext/richtexthtml.h
+++ b/interface/wx/richtext/richtexthtml.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxRichTextHTMLHandler
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -49,7 +49,8 @@
     - wxRICHTEXT_HANDLER_NO_HEADER_FOOTER
       Don't include header and footer tags (HTML, HEAD, BODY), so that the HTML
       can be used as part of a larger document.
-
+    - wxRICHTEXT_HANDLER_USE_CSS
+      Use CSS where possible, otherwise use workarounds that will show in wxHtmlWindow.
 
     @library{wxrichtext}
     @category{richtext}
@@ -60,8 +61,8 @@ public:
     /**
         Constructor.
     */
-    wxRichTextHTMLHandler(const wxString& name = wxT("HTML"),
-                          const wxString& ext = wxT("html"),
+    wxRichTextHTMLHandler(const wxString& name = "HTML",
+                          const wxString& ext = "html",
                           int type = wxRICHTEXT_TYPE_HTML);
 
     /**
@@ -79,13 +80,8 @@ public:
         This is a static function that can be used to delete the saved locations
         from an earlier operation, for example after the user has viewed the HTML file.
     */
-    bool DeleteTemporaryImages(int flags,
-                               const wxArrayString& imageLocations);
-
-    /**
-        Saves the buffer content to the HTML stream.
-    */
-    virtual bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
+    static bool DeleteTemporaryImages(int flags,
+                                      const wxArrayString& imageLocations);
 
     /**
         Returns the mapping for converting point sizes to HTML font sizes.
@@ -95,12 +91,12 @@ public:
     /**
         Returns the directory used to store temporary image files.
     */
-    const wxString GetTempDir() const;
+    const wxString& GetTempDir() const;
 
     /**
         Returns the image locations for the last operation.
     */
-    const wxArrayString GetTemporaryImageLocations() const;
+    const wxArrayString& GetTemporaryImageLocations() const;
 
     /**
         Reset the file counter, in case, for example, the same names are required each
@@ -139,5 +135,11 @@ public:
         Sets the list of image locations generated by the last operation.
     */
     void SetTemporaryImageLocations(const wxArrayString& locations);
+
+protected:
+    /**
+        Saves the buffer content to the HTML stream.
+    */
+    virtual bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
 };