interface/wx/html/htmlfilt.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html/htmlfilt.h
   3 // Purpose:     interface of wxHtmlFilter
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxHtmlFilter
  11
  12     This class is the parent class of input filters for wxHtmlWindow.
  13     It allows you to read and display files of different file formats.
  14
  15     @library{wxhtml}
  16     @category{FIXME}
  17
  18     @see Overview()
  19 */
  20 class wxHtmlFilter : public wxObject
  21 {
  22 public:
  23     /**
  24         Constructor.
  25     */
  26     wxHtmlFilter();
  27
  28     /**
  29         Returns @true if this filter is capable of reading file @e file.
  30         Example:
  31     */
  32     bool CanRead(const wxFSFile& file);
  33
  34     /**
  35         Reads the file and returns string with HTML document.
  36         Example:
  37     */
  38     wxString ReadFile(const wxFSFile& file);
  39 };
  40