summaryrefslogtreecommitdiffstats
path: root/src/tooltip.h
blob: acdacb46fda99d4a6308e841e7e6490712f0d5b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/******************************************************************************
 *
 * Copyright (C) 1997-2020 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.
 *
 */
#ifndef TOOLTIP_H
#define TOOLTIP_H

#include <memory>

class Definition;
class CodeOutputInterface;

//! Class that manages the tooltips for a source file
class TooltipManager
{
  public:
    static TooltipManager &instance();
   ~TooltipManager();

    /** add a tooltip for a given symbol definition */
    void addTooltip(CodeOutputInterface &ol,const Definition *d);

    /** write the list of all collected tooltip to the given outputs */
    void writeTooltips(CodeOutputInterface &ol);

  private:
    TooltipManager();
    class Private;
    std::unique_ptr<Private> p;
};

#endif