]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/html/htmlfilt.h
fixing wrong version commit
[wxWidgets.git] / interface / wx / html / htmlfilt.h
index 695ab88d7c46256092443d48c4eec4617f9161be..e5ef78c179879c3e05264b585eaa4f73cad43cda 100644 (file)
@@ -13,9 +13,9 @@
     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
 {
@@ -28,12 +28,25 @@ 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
     */
     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
     */
     virtual wxString ReadFile(const wxFSFile& file) const = 0;
 };