runtime/kioslave/man/man2html.h

   1 /**
   2  * \file man2html.h
   3  *
   4  * Converts man pages to HTML.  This kioslave is not part of kdelibs and is
   5  * not public API.
   6  * \internal
   7  */
   8
   9 #ifndef MAN2HTML_H
  10 #define MAN2HTML_H
  11
  12 class QByteArray;
  13
  14 /** call this with the buffer you have */
  15 void scan_man_page(const char *man_page);
  16
  17 /**
  18  * Set the paths to KDE resources
  19  *
  20  * \param cssPath Path to the KDE resources, encoded for CSS
  21  * \since 3.5
  22  *
  23  */
  24 extern void setResourcePath(const QByteArray& _cssPath);
  25
  26 /*
  27  * Sets the path to a CSS file that should be included with the generated
  28  * HTML output.
  29  *
  30  * \param HTML-encoded path to the file to reference for stylesheets.
  31  * \since 4.1
  32  */
  33 extern void setCssFile(const QByteArray& _cssFile);
  34
  35 /** implement this somewhere. It will be called
  36    with HTML contents
  37 */
  38 extern void output_real(const char *insert);
  39
  40 /**
  41  * called for requested man pages. filename can be a
  42  * relative path! Return NULL on errors. The returned
  43  * char array is freed by man2html
  44  */
  45 extern char *read_man_page(const char *filename);
  46
  47 #endif // MAN2HTML_H