ftvhelp.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.
 *
 */
 
/******************************************************************************
 * ftvhelp.h,v 1.0 2000/09/06 16:09:00
 *
 * Kenney Wong <kwong@ea.com>
 *
 * Folder Tree View for offline help on browsers that do not support HTML Help.
 */
 
#ifndef FTVHELP_H
#define FTVHELP_H
 
#include <memory>
#include <vector>
 
#include "construct.h"
#include "indexlist.h"
 
class Definition;
class DString;
class MemberDef;
class TextStream;
 
/** A class that generates a dynamic tree view side panel.
 */
class FTVHelp final : public IndexIntf
{
  public:
    FTVHelp(bool LTI);
    ~FTVHelp();
    NON_COPYABLE(FTVHelp)
 
    void initialize();
    void finalize();
    void incContentsDepth();
    void decContentsDepth();
    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=DString());
    void addIndexItem(const Definition *,const MemberDef *,const DString &,const DString &) {}
    void addIndexFile(const DString &) {}
    void addImageFile(const DString &) {}
    void addStyleSheetFile(const DString &) {}
    void generateTreeView();
    void generateTreeViewInline(TextStream &t);
    void generateTreeViewScripts();
  private:
    struct Private;
    std::unique_ptr<Private> p;
};
 
constexpr auto JAVASCRIPT_LICENSE_TEXT = R"LIC(/*
 @licstart  The following is the entire license notice for the JavaScript code in this file.
 
 The MIT License (MIT)
 
 Copyright (C) 1997-2026 by Dimitri van Heesch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 and associated documentation files (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge, publish, distribute,
 sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or
 substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 @licend  The above is the entire license notice for the JavaScript code in this file
*/
)LIC";
 
#endif /* FTVHELP_H */