eclipsehelp.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright (C) 1997-2026 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 <memory>
 
#include "construct.h"
#include "indexlist.h"
 
/* -- forward declarations */
class DString;
class Definition;
class MemberDef;
 
/** Generator for 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 final : public IndexIntf
{
  public:
    EclipseHelp();
    virtual ~EclipseHelp();
    NON_COPYABLE(EclipseHelp)
 
    /* -- index interface */
    virtual void initialize();
    virtual void finalize();
    virtual void incContentsDepth();
    virtual void decContentsDepth();
    virtual void addContentsItem(bool isDir, const DString &name, const DString &ref,
                                 const DString &file, const DString &anchor,bool separateIndex,bool addToNavIndex,
                                 const Definition *def, const DString &nameAsHtml);
    virtual void addIndexItem(const Definition *context,const MemberDef *md,
                              const DString &sectionAnchor,const DString &title);
    virtual void addIndexFile(const DString &name);
    virtual void addImageFile(const DString &name);
    virtual void addStyleSheetFile(const DString &name);
 
  private:
    struct Private;
    std::unique_ptr<Private> p;
};
 
#endif /* ECLIPSEHELP_H */