The DirRelation Class Reference

A usage relation between two directories. More...

Declaration

class DirRelation { ... }

Included Headers

#include <src/dirdef.h>

Public Constructors Index

	DirRelation (const QCString &name, const DirDef *src, UsedDir *dst)

Public Member Functions Index

const DirDef *	source () const
UsedDir *	destination () const
void	writeDocumentation (OutputList &ol)
QCString	getOutputFileBase () const

Private Member Attributes Index

QCString	m_name
const DirDef *	m_src
UsedDir *	m_dst

Description

A usage relation between two directories.

Definition at line 154 of file dirdef.h.

Public Constructors

DirRelation()

DirRelation::DirRelation (const QCString & name, const DirDef * src, UsedDir * dst)

inline

Definition at line 157 of file dirdef.h.

157 DirRelation(const QCString &name,const DirDef *src,UsedDir *dst)

158 : m_name(name), m_src(src), m_dst(dst) {}

References m_dst, m_name and m_src.

Public Member Functions

destination()

UsedDir * DirRelation::destination ()

inline

Definition at line 160 of file dirdef.h.

160 UsedDir *destination() const { return m_dst; }

Reference m_dst.

getOutputFileBase()

QCString DirRelation::getOutputFileBase ()

inline

Definition at line 162 of file dirdef.h.

162 QCString getOutputFileBase() const { return m_name; }

Reference m_name.

Referenced by writeDocumentation.

source()

const DirDef * DirRelation::source ()

inline

Definition at line 159 of file dirdef.h.

159 const DirDef *source() const { return m_src; }

Reference m_src.

writeDocumentation()

void DirRelation::writeDocumentation (OutputList & ol)

Declaration at line 161 of file dirdef.h, definition at line 942 of file dirdef.cpp.

942void DirRelation::writeDocumentation(OutputList &ol)

943{

944 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);

945 ol.pushGeneratorState();

946 ol.disableAllBut(OutputType::Html);

947

948 QCString shortTitle=theTranslator->trDirRelation(

949 (m_src->shortName()+" &rarr; "+m_dst->dir()->shortName()));

950 QCString title=theTranslator->trDirRelation(

951 (m_src->displayName()+" -> "+m_dst->dir()->shortName()));

952 AUTO_TRACE("title={}",title);

953 startFile(ol,getOutputFileBase(),getOutputFileBase(),

954 title,HighlightedItem::None,!generateTreeView,m_src->getOutputFileBase());

955

956 if (!generateTreeView)

957 {

958 // write navigation path

959 m_src->writeNavigationPath(ol);

960 ol.endQuickIndices();

961 }

962 ol.startContents();

963

964 ol.writeString("<h3>"+shortTitle+"</h3>");

965 ol.writeString("<table class=\"dirtab\">");

966 ol.writeString("<tr class=\"dirtab\">");

967 ol.writeString("<th class=\"dirtab\">");

968 ol.parseText(theTranslator->trFileIn(m_src->pathFragment()));

969 ol.writeString("</th>");

970 ol.writeString("<th class=\"dirtab\">");

971 ol.parseText(theTranslator->trIncludesFileIn(m_dst->dir()->pathFragment()));

972 ol.writeString("</th>");

973 ol.writeString("</tr>");

974

975 for (const auto &fp : m_dst->filePairs())

976 {

977 ol.writeString("<tr class=\"dirtab\">");

978 ol.writeString("<td class=\"dirtab\">");

979 writePartialFilePath(ol,m_src,fp->source());

980 ol.writeString("</td>");

981 ol.writeString("<td class=\"dirtab\">");

982 writePartialFilePath(ol,m_dst->dir(),fp->destination());

983 ol.writeString("</td>");

984 ol.writeString("</tr>");

985 }

986 ol.writeString("</table>");

987

988 ol.endContents();

989

990 endFileWithNavPath(ol,m_src);

991

992 ol.popGeneratorState();

993}

References AUTO_TRACE, Config_getBool, OutputList::disableAllBut, OutputList::endContents, endFileWithNavPath, OutputList::endQuickIndices, getOutputFileBase, Html, m_dst, m_src, None, OutputList::parseText, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::startContents, startFile, theTranslator, writePartialFilePath and OutputList::writeString.

Private Member Attributes

m_dst

UsedDir* DirRelation::m_dst

Definition at line 167 of file dirdef.h.

167 UsedDir *m_dst;

Referenced by destination, DirRelation and writeDocumentation.

m_name

QCString DirRelation::m_name

Definition at line 165 of file dirdef.h.

165 QCString m_name;

Referenced by DirRelation and getOutputFileBase.

m_src

const DirDef* DirRelation::m_src

Definition at line 166 of file dirdef.h.

166 const DirDef *m_src;

Referenced by DirRelation, source and writeDocumentation.

---

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

• dirdef.cpp
• dirdef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.