Doxygen
Loading...
Searching...
No Matches
DirRelation Class Reference

A usage relation between two directories. More...

#include <src/dirdef.h>

Collaboration diagram for DirRelation:

Public Member Functions

 DirRelation (const QCString &name, const DirDef *src, UsedDir *dst)
const DirDefsource () const
UsedDirdestination () const
void writeDocumentation (OutputList &ol)
QCString getOutputFileBase () const

Private Attributes

QCString m_name
const DirDefm_src
UsedDirm_dst

Detailed Description

A usage relation between two directories.

Definition at line 155 of file dirdef.h.

Constructor & Destructor Documentation

◆ DirRelation()

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

Definition at line 158 of file dirdef.h.

159 : m_name(name), m_src(src), m_dst(dst) {}
const DirDef * m_src
Definition dirdef.h:167
UsedDir * m_dst
Definition dirdef.h:168
QCString m_name
Definition dirdef.h:166

References m_dst, m_name, and m_src.

Member Function Documentation

◆ destination()

UsedDir * DirRelation::destination ( ) const
inline

Definition at line 161 of file dirdef.h.

161{ return m_dst; }

References m_dst.

◆ getOutputFileBase()

QCString DirRelation::getOutputFileBase ( ) const
inline

Definition at line 163 of file dirdef.h.

163{ return m_name; }

References m_name.

Referenced by writeDocumentation().

◆ source()

const DirDef * DirRelation::source ( ) const
inline

Definition at line 160 of file dirdef.h.

160{ return m_src; }

References m_src.

◆ writeDocumentation()

void DirRelation::writeDocumentation ( OutputList & ol)

Definition at line 966 of file dirdef.cpp.

967{
968 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
971
972 QCString shortTitle=theTranslator->trDirRelation(
973 (m_src->shortName()+" &rarr; "+m_dst->dir()->shortName()));
974 QCString title=theTranslator->trDirRelation(
975 (m_src->displayName()+" -> "+m_dst->dir()->shortName()));
976 AUTO_TRACE("title={}",title);
978 title,HighlightedItem::None,!generateTreeView,m_src->getOutputFileBase());
979
980 if (!generateTreeView)
981 {
982 // write navigation path
983 m_src->writeNavigationPath(ol);
984 ol.endQuickIndices();
985 }
986 ol.startContents();
987
988 ol.writeString("<h3>"+shortTitle+"</h3>");
989 ol.writeString("<table class=\"dirtab\">");
990 ol.writeString("<tr class=\"dirtab\">");
991 ol.writeString("<th class=\"dirtab\">");
992 ol.parseText(theTranslator->trFileIn(m_src->pathFragment()));
993 ol.writeString("</th>");
994 ol.writeString("<th class=\"dirtab\">");
995 ol.parseText(theTranslator->trIncludesFileIn(m_dst->dir()->pathFragment()));
996 ol.writeString("</th>");
997 ol.writeString("</tr>");
998
999 for (const auto &fp : m_dst->filePairs())
1000 {
1001 ol.writeString("<tr class=\"dirtab\">");
1002 ol.writeString("<td class=\"dirtab\">");
1003 writePartialFilePath(ol,m_src,fp->source());
1004 ol.writeString("</td>");
1005 ol.writeString("<td class=\"dirtab\">");
1006 writePartialFilePath(ol,m_dst->dir(),fp->destination());
1007 ol.writeString("</td>");
1008 ol.writeString("</tr>");
1009 }
1010 ol.writeString("</table>");
1011
1012 ol.endContents();
1013
1015
1016 ol.popGeneratorState();
1017}
QCString getOutputFileBase() const
Definition dirdef.h:163
void writeString(const QCString &text)
Definition outputlist.h:411
void endContents()
Definition outputlist.h:620
void pushGeneratorState()
void disableAllBut(OutputType o)
void popGeneratorState()
void endQuickIndices()
Definition outputlist.h:604
void startContents()
Definition outputlist.h:618
void parseText(const QCString &textStr)
virtual QCString trIncludesFileIn(const QCString &name)=0
virtual QCString trDirRelation(const QCString &name)=0
virtual QCString trFileIn(const QCString &name)=0
#define Config_getBool(name)
Definition config.h:33
static void writePartialFilePath(OutputList &ol, const DirDef *root, const FileDef *fd)
Definition dirdef.cpp:947
#define AUTO_TRACE(...)
Definition docnode.cpp:46
void startFile(OutputList &ol, const QCString &name, bool isSource, const QCString &manName, const QCString &title, HighlightedItem hli, bool additionalIndices, const QCString &altSidebarName, int hierarchyLevel, const QCString &allMembersFile)
Definition index.cpp:401
void endFileWithNavPath(OutputList &ol, const DefinitionMutable *d, bool showPageNavigation)
Definition index.cpp:448
Translator * theTranslator
Definition language.cpp:71

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().

Member Data Documentation

◆ m_dst

UsedDir* DirRelation::m_dst
private

Definition at line 168 of file dirdef.h.

Referenced by destination(), DirRelation(), and writeDocumentation().

◆ m_name

QCString DirRelation::m_name
private

Definition at line 166 of file dirdef.h.

Referenced by DirRelation(), and getOutputFileBase().

◆ m_src

const DirDef* DirRelation::m_src
private

Definition at line 167 of file dirdef.h.

Referenced by DirRelation(), source(), and writeDocumentation().


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