Blame src/qhp.h

Packit 1c1d7e
/*
Packit 1c1d7e
 * Copyright (C) 2008 by Sebastian Pipping.
Packit 1c1d7e
 * Copyright (C) 2008 Dimitri van Heesch.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Permission to use, copy, modify, and distribute this software and its
Packit 1c1d7e
 * documentation under the terms of the GNU General Public License is hereby 
Packit 1c1d7e
 * granted. No representations are made about the suitability of this software 
Packit 1c1d7e
 * for any purpose. It is provided "as is" without express or implied warranty.
Packit 1c1d7e
 * See the GNU General Public License for more details.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Documents produced by Doxygen are derivative works derived from the
Packit 1c1d7e
 * input used in their production; they are not affected by this license.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Sebastian Pipping <sebastian@pipping.org>
Packit 1c1d7e
 */
Packit 1c1d7e
Packit 1c1d7e
#ifndef DOXYGEN_QHP_H
Packit 1c1d7e
#define DOXYGEN_QHP_H
Packit 1c1d7e
Packit 1c1d7e
#include "index.h"
Packit 1c1d7e
#include "qhpxmlwriter.h"
Packit 1c1d7e
Packit 1c1d7e
class Qhp : public IndexIntf
Packit 1c1d7e
{
Packit 1c1d7e
  public:
Packit 1c1d7e
    Qhp();
Packit 1c1d7e
   ~Qhp();
Packit 1c1d7e
Packit 1c1d7e
    // BEGIN IndexIntf
Packit 1c1d7e
    void initialize();
Packit 1c1d7e
    void finalize();
Packit 1c1d7e
    void incContentsDepth();
Packit 1c1d7e
    void decContentsDepth();
Packit 1c1d7e
    void addContentsItem(bool isDir, const char * name, const char * ref,
Packit 1c1d7e
                         const char * file, const char * anchor,
Packit 1c1d7e
                         bool separateIndex,bool addToNavIndex,
Packit 1c1d7e
                         Definition *def);
Packit 1c1d7e
    void addIndexItem(Definition *context, MemberDef *md,
Packit 1c1d7e
                      const char *sectionAnchor, const char *title);
Packit 1c1d7e
    void addIndexFile(const char * name);
Packit 1c1d7e
    void addImageFile(const char * name);
Packit 1c1d7e
    void addStyleSheetFile(const char * name);
Packit 1c1d7e
    // END IndexIntf
Packit 1c1d7e
Packit 1c1d7e
    static QCString getQhpFileName();
Packit 1c1d7e
Packit 1c1d7e
  private:
Packit 1c1d7e
    void handlePrevSection();
Packit 1c1d7e
    void clearPrevSection();
Packit 1c1d7e
    void setPrevSection(const char * title, const char * basename, const char * anchor, int level);
Packit 1c1d7e
    void addFile(const char * fileName);
Packit 1c1d7e
Packit 1c1d7e
    static QCString getFullProjectName();
Packit 1c1d7e
Packit 1c1d7e
    QhpXmlWriter m_doc;
Packit 1c1d7e
    QhpXmlWriter m_toc;
Packit 1c1d7e
    QhpXmlWriter m_index;
Packit 1c1d7e
    QhpXmlWriter m_files;
Packit 1c1d7e
Packit 1c1d7e
    QCString m_prevSectionTitle;
Packit 1c1d7e
    QCString m_prevSectionBaseName;
Packit 1c1d7e
    QCString m_prevSectionAnchor;
Packit 1c1d7e
Packit 1c1d7e
    int m_prevSectionLevel;
Packit 1c1d7e
    int m_sectionLevel;
Packit 1c1d7e
Packit 1c1d7e
    bool m_skipMainPageSection;
Packit 1c1d7e
};
Packit 1c1d7e
Packit 1c1d7e
#endif // DOXYGEN_QHP_H
Packit 1c1d7e