The DotLegendGraph Class Reference

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

Declaration

class DotLegendGraph { ... }

Included Headers

#include <src/dotlegendgraph.h>

Base class

class	DotGraph
	A dot graph. More...

Public Member Functions Index

void	writeGraph (const QCString &path)

Private Member Functions Index

QCString	getBaseName () const override
void	computeTheGraph () override
QCString	getMapLabel () const override

Description

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

Definition at line 22 of file dotlegendgraph.h.

Public Member Functions

writeGraph()

void DotLegendGraph::writeGraph (const QCString & path)

Declaration at line 25 of file dotlegendgraph.h, definition at line 27 of file dotlegendgraph.cpp.

27void DotLegendGraph::writeGraph(const QCString &path)

28{

29 TextStream ts;

30 DotGraph::writeGraph(ts, GraphOutputFormat::BITMAP, EmbeddedOutputFormat::Html, path, "", "", FALSE, 0);

31

32 if (getDotImageExtension()=="svg")

33 {

34 DotManager::instance()->

35 createFilePatcher(absBaseName()+Config_getString(HTML_FILE_EXTENSION))->

36 addSVGObject("graph_legend", absImgName(),QCString());

37 }

38}

References DotGraph::absBaseName, DotGraph::absImgName, BITMAP, Config_getString, FALSE, getDotImageExtension, Html, DotManager::instance and DotGraph::writeGraph.

Referenced by writeGraphInfo.

Private Member Functions

computeTheGraph()

void DotLegendGraph::computeTheGraph ()

virtual

Declaration at line 29 of file dotlegendgraph.h, definition at line 45 of file dotlegendgraph.cpp.

45void DotLegendGraph::computeTheGraph()

46{

47 TextStream md5stream;

48 writeGraphHeader(md5stream,theTranslator->trLegendTitle());

49

50 DotNode{this,"Inherited", "", "", TRUE}.setNodeId(9).writeBox(md5stream, GraphType::CallGraph, GraphOutputFormat::BITMAP, false);

51 md5stream << " Node10 -> Node9 [dir=\"back\",color=\"steelblue1\",style=\"solid\" tooltip=\" \"];\n";

52 DotNode{this,"PublicBase", "", DotNode::placeholderUrl}.setNodeId(10).markHasDocumentation().writeBox(md5stream, GraphType::CallGraph, GraphOutputFormat::BITMAP, false);

53 md5stream << " Node11 -> Node10 [dir=\"back\",color=\"steelblue1\",style=\"solid\" tooltip=\" \"];\n";

54 DotNode{this,"Truncated", "", DotNode::placeholderUrl}.setNodeId(11).markAsTruncated().markHasDocumentation().writeBox(md5stream, GraphType::CallGraph, GraphOutputFormat::BITMAP, true);

55 md5stream << " Node13 -> Node9 [dir=\"back\",color=\"darkgreen\",style=\"solid\" tooltip=\" \"];\n";

56 md5stream << " Node13 [label=\"ProtectedBase\",color=\"gray40\",fillcolor=\"white\",style=\"filled\" tooltip=\" \"];\n";

57 md5stream << " Node14 -> Node9 [dir=\"back\",color=\"firebrick4\",style=\"solid\" tooltip=\" \"];\n";

58 md5stream << " Node14 [label=\"PrivateBase\",color=\"gray40\",fillcolor=\"white\",style=\"filled\" tooltip=\" \"];\n";

59 md5stream << " Node15 -> Node9 [dir=\"back\",color=\"steelblue1\",style=\"solid\" tooltip=\" \"];\n";

60 DotNode{this,"Undocumented", "", ""}.setNodeId(15).writeBox(md5stream, GraphType::CallGraph, GraphOutputFormat::BITMAP, false);

61 md5stream << " Node16 -> Node9 [dir=\"back\",color=\"steelblue1\",style=\"solid\" tooltip=\" \"];\n";

62 md5stream << " Node16 [label=\"Templ\\< int \\>\",color=\"gray40\",fillcolor=\"white\",style=\"filled\" tooltip=\" \"];\n";

63 md5stream << " Node17 -> Node16 [dir=\"back\",color=\"orange\",style=\"dashed\",label=\"< int >\",fontcolor=\"grey\" tooltip=\" \"];\n";

64 md5stream << " Node17 [label=\"Templ\\< T \\>\",color=\"gray40\",fillcolor=\"white\",style=\"filled\" tooltip=\" \"];\n";

65 md5stream << " Node18 -> Node9 [dir=\"back\",color=\"darkorchid3\",style=\"dashed\",label=\"m_usedClass\",fontcolor=\"grey\" tooltip=\" \"];\n";

66 md5stream << " Node18 [label=\"Used\",color=\"gray40\",fillcolor=\"white\",style=\"filled\" tooltip=\" \"];\n";

67 writeGraphFooter(md5stream);

68 m_theGraph = md5stream.str();

69}

References BITMAP, CallGraph, DotGraph::DotNode, DotGraph::m_theGraph, DotNode::placeholderUrl, TextStream::str, theTranslator, TRUE, DotGraph::writeGraphFooter and DotGraph::writeGraphHeader.

getBaseName()

QCString DotLegendGraph::getBaseName ()

virtual

Declaration at line 28 of file dotlegendgraph.h, definition at line 40 of file dotlegendgraph.cpp.

40QCString DotLegendGraph::getBaseName() const

41{

42 return "graph_legend";

43}

getMapLabel()

QCString DotLegendGraph::getMapLabel ()

virtual

Declaration at line 30 of file dotlegendgraph.h, definition at line 71 of file dotlegendgraph.cpp.

71QCString DotLegendGraph::getMapLabel() const

72{

73 return "";

74}

---

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

• dotlegendgraph.cpp
• dotlegendgraph.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.