]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/html/htmlfilt.h
add parent parameter to wxAboutBox() (closes #9952)
[wxWidgets.git] / interface / wx / html / htmlfilt.h
index 9a40dbcff162d645332e4c5eba690116b3a09cc6..e5ef78c179879c3e05264b585eaa4f73cad43cda 100644 (file)
@@ -8,15 +8,14 @@
 
 /**
     @class wxHtmlFilter
-    @headerfile htmlfilt.h wx/html/htmlfilt.h
 
     This class is the parent class of input filters for wxHtmlWindow.
     It allows you to read and display files of different file formats.
 
     @library{wxhtml}
-    @category{FIXME}
+    @category{html}
 
-    @see Overview()
+    @see @ref overview_html_filters
 */
 class wxHtmlFilter : public wxObject
 {
@@ -29,13 +28,26 @@ public:
     /**
         Returns @true if this filter is capable of reading file @e file.
         Example:
+        @code
+        bool MyFilter::CanRead(const wxFSFile& file)
+        {
+            return (file.GetMimeType() == "application/x-ugh");
+        }
+        @endcode
     */
-    bool CanRead(const wxFSFile& file);
+    virtual bool CanRead(const wxFSFile& file) const = 0;
 
     /**
         Reads the file and returns string with HTML document.
         Example:
+        @code
+        wxString MyImgFilter::ReadFile(const wxFSFile& file)
+        {
+            return "<html><body><img src=\"" + file.GetLocation() +
+                   "\"></body></html>";
+        }
+        @endcode
     */
-    wxString ReadFile(const wxFSFile& file);
+    virtual wxString ReadFile(const wxFSFile& file) const = 0;
 };