TooltipManager Class Reference

#include <tooltip.h>

Classes
class	Private

Public Member Functions
void	clearTooltips ()
void	addTooltip (Definition *d)
void	writeTooltips (CodeOutputInterface &ol)

Static Public Member Functions
static TooltipManager *	instance ()

Private Member Functions
	TooltipManager ()
	~TooltipManager ()

Private Attributes
Private *	p

Static Private Attributes
static TooltipManager *	s_theInstance = 0

Detailed Description

Definition at line 21 of file tooltip.h.

Constructor & Destructor Documentation

TooltipManager::TooltipManager ( )

private

Definition at line 35 of file tooltip.cpp.

References p, and Private.

Referenced by instance().

{
  p = new Private;
}

TooltipManager::~TooltipManager ( )

private

Definition at line 40 of file tooltip.cpp.

References p.

{
  delete p;
}

Member Function Documentation

void TooltipManager::addTooltip

(

Definition *

d

)

Definition at line 71 of file tooltip.cpp.

References Definition::anchor(), Config_getBool, escapeId(), Definition::getOutputFileBase(), Doxygen::htmlFileExtension, p, and TooltipManager::Private::tooltipInfo.

{
  static bool sourceTooltips = Config_getBool(SOURCE_TOOLTIPS);
  if (!sourceTooltips) return;
  QCString id = d->getOutputFileBase();
  int i=id.findRev('/');
  if (i!=-1)
  {
    id = id.right(id.length()-i-1); // strip path (for CREATE_SUBDIRS=YES)
  }
  id+=escapeId(Doxygen::htmlFileExtension);
  QCString anc = d->anchor();
  if (!anc.isEmpty())
  {
    id+="_"+anc;
  }
  if (p->tooltipInfo.find(id)==0)
  {
    p->tooltipInfo.insert(id,d);
  }
}

void TooltipManager::clearTooltips

(

)

Definition at line 54 of file tooltip.cpp.

References p, and TooltipManager::Private::tooltipInfo.

{
  p->tooltipInfo.clear();
}

TooltipManager * TooltipManager::instance ( )

static

Definition at line 45 of file tooltip.cpp.

References s_theInstance, and TooltipManager().

{
  if (!s_theInstance)
  {
    s_theInstance = new TooltipManager;
  }
  return s_theInstance;
}

void TooltipManager::writeTooltips

(

CodeOutputInterface &

ol

)

Definition at line 93 of file tooltip.cpp.

References DocLinkInfo::anchor, SourceLinkInfo::anchor, Definition::anchor(), Definition::briefDescriptionAsTooltip(), MemberDef::declaration(), DefinitionIntf::definitionType(), SourceLinkInfo::file, Definition::getBodyDef(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceAnchor(), Definition::getSourceFileBase(), Definition::getStartBodyLine(), SourceLinkInfo::line, DocLinkInfo::name, FileDef::name(), p, Definition::qualifiedName(), DocLinkInfo::ref, TooltipManager::Private::tooltipInfo, DefinitionIntf::TypeMember, DocLinkInfo::url, SourceLinkInfo::url, and CodeOutputInterface::writeTooltip().

{
  QDictIterator<Definition> di(p->tooltipInfo);
  Definition *d;
  for (di.toFirst();(d=di.current());++di)
  {
    DocLinkInfo docInfo;
    docInfo.name   = d->qualifiedName();
    docInfo.ref    = d->getReference();
    docInfo.url    = d->getOutputFileBase();
    docInfo.anchor = d->anchor();
    SourceLinkInfo defInfo;
    if (d->getBodyDef() && d->getStartBodyLine()!=-1)
    {
      defInfo.file    = d->getBodyDef()->name();
      defInfo.line    = d->getStartBodyLine();
      defInfo.url     = d->getSourceFileBase();
      defInfo.anchor  = d->getSourceAnchor();
    }
    SourceLinkInfo declInfo; // TODO: fill in...
    QCString decl;
    if (d->definitionType()==Definition::TypeMember)
    {
      MemberDef *md = (MemberDef*)d;
      decl = md->declaration();
      if (!decl.isEmpty() && decl.at(0)=='@') // hide enum values
      {
        decl.resize(0);
      }
    }
    ol.writeTooltip(di.currentKey(),                 // id
                    docInfo,                         // symName
                    decl,                            // decl
                    d->briefDescriptionAsTooltip(),  // desc
                    defInfo,
                    declInfo
                   );
  }
}

Member Data Documentation

Private* TooltipManager::p

private

Definition at line 30 of file tooltip.h.

Referenced by addTooltip(), clearTooltips(), TooltipManager(), writeTooltips(), and ~TooltipManager().

TooltipManager * TooltipManager::s_theInstance = 0

staticprivate

Definition at line 34 of file tooltip.h.

Referenced by instance().

---

The documentation for this class was generated from the following files:

• tooltip.h
• tooltip.cpp