diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2009-12-30 13:28:15 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2009-12-30 13:28:15 (GMT) |
commit | 05b70e8e2c6e0cda9b74fc99fd782d1977d298c9 (patch) | |
tree | e73e0b41d708a8ea6260e541347b464cb2e5aeaa /src/eclipsehelp.h | |
parent | e32567534d95ff3960fa4dcad7733c18e1b39bc5 (diff) | |
download | Doxygen-05b70e8e2c6e0cda9b74fc99fd782d1977d298c9.zip Doxygen-05b70e8e2c6e0cda9b74fc99fd782d1977d298c9.tar.gz Doxygen-05b70e8e2c6e0cda9b74fc99fd782d1977d298c9.tar.bz2 |
Release-1.6.2
Diffstat (limited to 'src/eclipsehelp.h')
-rw-r--r-- | src/eclipsehelp.h | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/src/eclipsehelp.h b/src/eclipsehelp.h new file mode 100644 index 0000000..e0c3a34 --- /dev/null +++ b/src/eclipsehelp.h @@ -0,0 +1,78 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2008 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. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ +/* + * eclipsehelp.h + * + * Created on: 7.11.2009 + * Author: ondrej + */ + +#ifndef ECLIPSEHELP_H +#define ECLIPSEHELP_H + +#include "qtbc.h" +#include "index.h" +#include <qtextstream.h> + +/* -- forward declarations */ +class QFile; + +/*! + * \brief Generator of Eclipse help files + * + * This class generates the Eclipse specific help files. + * These files can be used to generate a help plugin readable + * by the Eclipse IDE. + */ +class EclipseHelp : public IndexIntf +{ + public: + EclipseHelp(); + virtual ~EclipseHelp(); + + /* -- index interface */ + virtual void initialize(); + virtual void finalize(); + virtual void incContentsDepth(); + virtual void decContentsDepth(); + virtual void addContentsItem(bool isDir, const char *name, const char *ref = 0, + const char *file = 0, const char *anchor = 0); + virtual void addIndexItem(Definition *context,MemberDef *md, + const char *anchor,const char *word); + virtual void addIndexFile(const char *name); + virtual void addImageFile(const char *name); + virtual void addStyleSheetFile(const char *name); + + private: + int m_depth; + bool m_endtag; + + QFile * m_tocfile; + QTextStream m_tocstream; + QCString m_pathprefix; + + /* -- avoid copying */ + EclipseHelp(const EclipseHelp &); + EclipseHelp & operator = (const EclipseHelp &); + + /* -- formatting helpers */ + void indent(); + void closedTag(); + void openedTag(); +}; + +#endif /* ECLIPSEHELP_H */ |