interface/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     @headerfile htmlfilt.h wx/html/htmlfilt.h
  12
  13     This class is the parent class of input filters for wxHtmlWindow.
  14     It allows you to read and display files of different file formats.
  15
  16     @library{wxhtml}
  17     @category{FIXME}
  18
  19     @see Overview()
  20 */
  21 class wxHtmlFilter : public wxObject
  22 {
  23 public:
  24     /**
  25         Constructor.
  26     */
  27     wxHtmlFilter();
  28
  29     /**
  30         Returns @true if this filter is capable of reading file @e file.
  31         Example:
  32     */
  33     bool CanRead(const wxFSFile& file);
  34
  35     /**
  36         Reads the file and returns string with HTML document.
  37         Example:
  38     */
  39     wxString ReadFile(const wxFSFile& file);
  40 };
  41