summaryrefslogtreecommitdiffstats
path: root/src/htmlgen.h
diff options
context:
space:
mode:
authormueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7>1999-12-15 19:25:10 (GMT)
committermueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7>1999-12-15 19:25:10 (GMT)
commit719f0a35063be88eddcc4ed8fe7a940de47ef20c (patch)
treecc1cd70cf5761ddf72ff114c0b65576c3f4c1d2a /src/htmlgen.h
parentbd30c025c4651ddda467f1af09d4c7ccab397bde (diff)
downloadDoxygen-719f0a35063be88eddcc4ed8fe7a940de47ef20c.zip
Doxygen-719f0a35063be88eddcc4ed8fe7a940de47ef20c.tar.gz
Doxygen-719f0a35063be88eddcc4ed8fe7a940de47ef20c.tar.bz2
initial version
Diffstat (limited to 'src/htmlgen.h')
-rw-r--r--src/htmlgen.h174
1 files changed, 174 insertions, 0 deletions
diff --git a/src/htmlgen.h b/src/htmlgen.h
new file mode 100644
index 0000000..c8a5223
--- /dev/null
+++ b/src/htmlgen.h
@@ -0,0 +1,174 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ * Copyright (C) 1997-1999 by Dimitri van Heesch.
+ *
+ * Permission to use, copy, modify, and distribute this software and its
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
+ * for any purpose. It is provided "as is" without express or implied warranty.
+ * See the GNU General Public License for more details.
+ *
+ * All output generated with Doxygen is not covered by this license.
+ *
+ */
+
+#ifndef HTMLGEN_H
+#define HTMLGEN_H
+
+#include "outputgen.h"
+
+class QFile;
+
+class HtmlGenerator : public OutputGenerator
+{
+ public:
+ HtmlGenerator();
+ ~HtmlGenerator();
+
+ OutputGenerator *copy() { return new HtmlGenerator; }
+ //OutputGenerator *clone() { return new HtmlGenerator(*this); }
+ void append(const OutputGenerator *o);
+ void enable() { active=TRUE; }
+ void disable() { active=FALSE; }
+ void enableIf(OutputType o) { if (o==Html) active=TRUE; }
+ void disableIf(OutputType o) { if (o==Html) active=FALSE; }
+ void disableIfNot(OutputType o) { if (o!=Html) active=FALSE; }
+ bool isEnabled(OutputType o) { return (o==Html && active); }
+ OutputGenerator *get(OutputType o) { return (o==Html) ? this : 0; }
+
+ static void init();
+ //void generateExternalIndex();
+ void startFile(const char *name,const char *title,bool external);
+ void writeFooter(int,bool);
+ void endFile();
+ void clearBuffer();
+
+ //void writeIndex();
+ void startIndexSection(IndexSections) {}
+ void endIndexSection(IndexSections) {}
+ void startProjectNumber();
+ void endProjectNumber();
+ void writeStyleInfo(int part);
+ void startTitleHead() { startTitle(); }
+ void endTitleHead(const char *) { endTitle(); }
+ void startTitle() { t << "<h1>"; }
+ void endTitle() { t << "</h1>"; }
+
+ void newParagraph();
+ void writeString(const char *text);
+ void startIndexList() { t << "<ul>" << endl; }
+ void endIndexList() { t << "</ul>" << endl; }
+ void startItemList() { t << "<ul>" << endl; }
+ void endItemList() { t << "</ul>" << endl; }
+ void startEnumList() { t << "<ol>" << endl; }
+ void endEnumList() { t << "</ol>" << endl; }
+ void writeIndexItem(const char *ref,const char *file,const char *name);
+ void docify(const char *text);
+ void codify(const char *text);
+ void writeObjectLink(const char *ref,const char *file,
+ const char *anchor,const char *name);
+ void writeCodeLink(const char *ref,const char *f,
+ const char *anchor,const char *name)
+ { writeObjectLink(ref,f,anchor,name); }
+ void startTextLink(const char *file,const char *anchor);
+ void endTextLink();
+ void writeHtmlLink(const char *url,const char *text);
+ void startTypewriter() { t << "<code>"; }
+ void endTypewriter() { t << "</code>"; }
+ void startGroupHeader();
+ void endGroupHeader();
+ void writeListItem() { t << "<li>"; }
+
+ void startMemberHeader() { startGroupHeader(); }
+ void endMemberHeader() { endGroupHeader(); }
+ void startMemberList() { t << "<ul>" << endl; }
+ void endMemberList() { t << "</ul>" << endl; }
+ void startMemberItem() { t << "<li>"; }
+ void endMemberItem() { t << endl; }
+
+ void writeRuler() { t << "<hr>"; }
+ void writeAnchor(const char *name)
+ { t << "<a name=\"" << name <<"\"></a>"; }
+ void startCodeFragment() { t << "<div class=\"fragment\"><pre>"; }
+ void endCodeFragment() { t << "</div></pre>"; }
+ void writeBoldString(const char *text)
+ { t << "<b>"; docify(text); t << "</b>"; }
+ void startEmphasis() { t << "<em>"; }
+ void endEmphasis() { t << "</em>"; }
+ void startBold() { t << "<b>"; }
+ void endBold() { t << "</b>"; }
+ void startDescription() { t << endl << "<dl compact>" << endl; }
+ void endDescription() { t << endl << "</dl>" << endl; }
+ void startDescItem() { t << "<dt>"; }
+ void endDescItem() { t << "<dd>"; }
+ void lineBreak() { t << "<br>" << endl; }
+ void writeChar(char c);
+ void startMemberDoc(const char *,const char *,const char *)
+ { t << endl << "<h3>"; }
+ void endMemberDoc() { t << "</h3>" << endl; }
+ void writeDoxyAnchor(const char *clName,const char *anchor,
+ const char *name);
+ void writeLatexSpacing() {}
+ void writeStartAnnoItem(const char *type,const char *file,
+ const char *path,const char *name);
+ void writeEndAnnoItem(const char *) { t << endl; }
+ void startSubsection() { t << "<h2>"; }
+ void endSubsection() { t << "</h2>" << endl; }
+ void startSubsubsection() { t << "<h3>"; }
+ void endSubsubsection() { t << "</h3>" << endl; }
+ void startCenter() { t << "<center>" << endl; }
+ void endCenter() { t << "</center>" << endl; }
+ void startSmall() { t << "<small>" << endl; }
+ void endSmall() { t << "</small>" << endl; }
+ void startSubscript() { t << "<sub>"; }
+ void endSubscript() { t << "</sub>"; }
+ void startSuperscript() { t << "<sup>"; }
+ void endSuperscript() { t << "</sup>"; }
+ void startTable(int) { t << "<table border=1 cellspacing=3 cellpadding=3>"; }
+ void endTable() { t << "</table>" << endl; }
+ void nextTableRow() { t << endl << "<tr><td>"; }
+ void endTableRow() { t << "</tr>" << endl; }
+ void nextTableColumn() { t << "<td>"; }
+ void endTableColumn() { t << "</td>"; }
+ void writeCopyright() { t << "&copy;"; }
+ void writeQuote() { t << "&quot;"; }
+ void writeUmlaut(char c) { t << "&" << c << "uml;"; }
+ void writeAcute(char c) { t << "&" << c << "acute;"; }
+ void writeGrave(char c) { t << "&" << c << "grave;"; }
+ void writeCirc(char c) { t << "&" << c << "circ;"; }
+ void writeTilde(char c) { t << "&" << c << "tilde;"; }
+ void startMemberDescription() { t << "<dl class=\"el\"><dd><font size=-1><em>"; }
+ void endMemberDescription() { t << "</em></font></dl>"; }
+ void startDescList() { t << "<dl compact><dt>" << endl; }
+ void endDescTitle() {}
+ void writeDescItem() { t << "<dd>" << endl; }
+ void endDescList() { t << "</dl>"; }
+ void writeSection(const char *,const char *,bool);
+ void writeSectionRef(const char *,const char *,const char *);
+ void writeSectionRefItem(const char *,const char *,const char *);
+ void addToIndex(const char *,const char *) {}
+ void startIndent() { t << "<div class=\"in\">" << endl; }
+ void endIndent() { t << "</div>" << endl; }
+ void writeSynopsis() {}
+ void startClassDiagram();
+ void endClassDiagram(ClassDiagram &,const char *,const char *);
+ void startColorFont(uchar r,uchar g,uchar b);
+ void endColorFont();
+ void writePageRef(const char *,const char *) {}
+ void startQuickIndexItem(const char *,const char *);
+ void endQuickIndexItem();
+ void writeFormula(const char *,const char *);
+
+ //static void docifyStatic(QTextStream &t,const char *str);
+
+ private:
+ QString header;
+ QString footer;
+
+ HtmlGenerator &operator=(const HtmlGenerator &g);
+ HtmlGenerator(const HtmlGenerator &g);
+};
+
+#endif