DotLegendGraph类 参考

Representation of a legend explaining the meaning of boxes, arrows, and colors 更多...

#include <dotlegendgraph.h>

类 DotLegendGraph 继承关系图:

DotLegendGraph 的协作图:

Public 成员函数
void	writeGraph (const QCString &path)
Public 成员函数 继承自 DotGraph
	DotGraph ()
virtual	~DotGraph ()

Private 成员函数
virtual QCString	getBaseName () const
virtual void	computeTheGraph ()
virtual QCString	getMapLabel () const

额外继承的成员函数
Protected 成员函数 继承自 DotGraph
int	getNextNodeNumber ()
	returns node numbers. 更多...
QCString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
virtual QCString	absMapName () const
virtual QCString	getImgAltText () const
QCString	absBaseName () const
QCString	absDotName () const
QCString	imgName () const
QCString	absImgName () const
QCString	relImgName () const
静态 Protected 成员函数 继承自 DotGraph
static void	writeGraphHeader (TextStream &t, const QCString &title=QCString())
static void	writeGraphFooter (TextStream &t)
static void	computeGraph (DotNode *root, GraphType gt, GraphOutputFormat format, const QCString &rank, bool renderParents, bool backArrows, const QCString &title, QCString &graphStr)
Protected 属性 继承自 DotGraph
GraphOutputFormat	m_graphFormat = GOF_BITMAP
EmbeddedOutputFormat	m_textFormat = EOF_Html
Dir	m_dir
QCString	m_fileName
QCString	m_relPath
bool	m_generateImageMap = false
int	m_graphId = 0
QCString	m_absPath
QCString	m_baseName
QCString	m_theGraph
bool	m_regenerate = false
bool	m_doNotAddImageToIndex = false
bool	m_noDivTag = false
bool	m_zoomable = true
bool	m_urlOnly = false

详细描述

Representation of a legend explaining the meaning of boxes, arrows, and colors

在文件 dotlegendgraph.h 第 22 行定义.

成员函数说明

computeTheGraph()

void DotLegendGraph::computeTheGraph ( )

privatevirtual

实现了 DotGraph.

在文件 dotlegendgraph.cpp 第 44 行定义.

{
  int fontSize = Config_getInt(DOT_FONTSIZE);
  QCString fontName = Config_getString(DOT_FONTNAME);
  TextStream md5stream;
  writeGraphHeader(md5stream,theTranslator->trLegendTitle());
  md5stream << "  Node9 [shape=\"box\",label=\"Inherited\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",fillcolor=\"grey75\",style=\"filled\" fontcolor=\"black\"];\n";
  md5stream << "  Node10 -> Node9 [dir=\"back\",color=\"midnightblue\",fontsize=\"" << fontSize << "\",style=\"solid\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node10 [shape=\"box\",label=\"PublicBase\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"black\"];\n";
  md5stream << "  Node11 -> Node10 [dir=\"back\",color=\"midnightblue\",fontsize=\"" << fontSize << "\",style=\"solid\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node11 [shape=\"box\",label=\"Truncated\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"red\"];\n";
  md5stream << "  Node13 -> Node9 [dir=\"back\",color=\"darkgreen\",fontsize=\"" << fontSize << "\",style=\"solid\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node13 [shape=\"box\",label=\"ProtectedBase\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"black\"];\n";
  md5stream << "  Node14 -> Node9 [dir=\"back\",color=\"firebrick4\",fontsize=\"" << fontSize << "\",style=\"solid\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node14 [shape=\"box\",label=\"PrivateBase\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"black\"];\n";
  md5stream << "  Node15 -> Node9 [dir=\"back\",color=\"midnightblue\",fontsize=\"" << fontSize << "\",style=\"solid\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node15 [shape=\"box\",label=\"Undocumented\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"grey75\"];\n";
  md5stream << "  Node16 -> Node9 [dir=\"back\",color=\"midnightblue\",fontsize=\"" << fontSize << "\",style=\"solid\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node16 [shape=\"box\",label=\"Templ< int >\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"black\"];\n";
  md5stream << "  Node17 -> Node16 [dir=\"back\",color=\"orange\",fontsize=\"" << fontSize << "\",style=\"dashed\",label=\"< int >\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node17 [shape=\"box\",label=\"Templ< T >\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"black\"];\n";
  md5stream << "  Node18 -> Node9 [dir=\"back\",color=\"darkorchid3\",fontsize=\"" << fontSize << "\",style=\"dashed\",label=\"m_usedClass\",fontname=\"" << fontName << "\"];\n";
  md5stream << "  Node18 [shape=\"box\",label=\"Used\",fontsize=\"" << fontSize << "\",height=0.2,width=0.4,fontname=\"" << fontName << "\",color=\"black\"];\n";
  writeGraphFooter(md5stream);
  m_theGraph = md5stream.str();
}

引用了 Config_getInt, Config_getString, DotGraph::m_theGraph, TextStream::str(), theTranslator, Translator::trLegendTitle(), DotGraph::writeGraphFooter() , 以及 DotGraph::writeGraphHeader().

getBaseName()

QCString DotLegendGraph::getBaseName ( ) const

privatevirtual

实现了 DotGraph.

在文件 dotlegendgraph.cpp 第 39 行定义.

{
  return "graph_legend";
}

getMapLabel()

QCString DotLegendGraph::getMapLabel ( ) const

privatevirtual

实现了 DotGraph.

在文件 dotlegendgraph.cpp 第 71 行定义.

{
  return "";
}

writeGraph()

void DotLegendGraph::writeGraph

(

const QCString &

path

)

在文件 dotlegendgraph.cpp 第 26 行定义.

{
  TextStream ts;
  DotGraph::writeGraph(ts, GOF_BITMAP, EOF_Html, path, "", "", FALSE, 0);
 
  if (getDotImageExtension()=="svg")
  {
    DotManager::instance()->
      createFilePatcher(absBaseName()+Config_getString(HTML_FILE_EXTENSION))->
      addSVGObject("graph_legend", absImgName(),QCString());
  }
}

引用了 DotGraph::absBaseName(), DotGraph::absImgName(), Config_getString, EOF_Html, FALSE, getDotImageExtension(), GOF_BITMAP, DotManager::instance() , 以及 DotGraph::writeGraph().

被这些函数引用 writeGraphInfo().

---

该类的文档由以下文件生成:

• src/dotlegendgraph.h
• src/dotlegendgraph.cpp