DirRelation类 参考

A usage relation between two directories. 更多...

#include <dirdef.h>

DirRelation 的协作图:

Public 成员函数
	DirRelation (const QCString &name, const DirDef *src, UsedDir *dst)
const DirDef *	source () const
UsedDir *	destination () const
void	writeDocumentation (OutputList &ol)
QCString	getOutputFileBase () const

Private 属性
QCString	m_name
const DirDef *	m_src
UsedDir *	m_dst

详细描述

A usage relation between two directories.

在文件 dirdef.h 第 159 行定义.

构造及析构函数说明

DirRelation()

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

inline

在文件 dirdef.h 第 162 行定义.

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

成员函数说明

destination()

UsedDir* DirRelation::destination ( ) const

inline

在文件 dirdef.h 第 165 行定义.

{ return m_dst; }

引用了 m_dst.

getOutputFileBase()

QCString DirRelation::getOutputFileBase ( ) const

inline

在文件 dirdef.h 第 167 行定义.

{ return m_name; }

引用了 m_name.

被这些函数引用 writeDocumentation().

source()

const DirDef* DirRelation::source ( ) const

inline

在文件 dirdef.h 第 164 行定义.

{ return m_src; }

引用了 m_src.

writeDocumentation()

void DirRelation::writeDocumentation

(

OutputList &

ol

)

在文件 dirdef.cpp 第 872 行定义.

{
  static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
 
  QCString shortTitle=theTranslator->trDirRelation(
                      (m_src->shortName()+" → "+m_dst->dir()->shortName()));
  QCString title=theTranslator->trDirRelation(
                 (m_src->displayName()+" -> "+m_dst->dir()->shortName()));
  startFile(ol,getOutputFileBase(),getOutputFileBase(),
            title,HLI_None,!generateTreeView,m_src->getOutputFileBase());
 
  if (!generateTreeView)
  {
    // write navigation path
    m_src->writeNavigationPath(ol);
    ol.endQuickIndices();
  }
  ol.startContents();
 
  ol.writeString("<h3>"+shortTitle+"</h3>");
  ol.writeString("<table class=\"dirtab\">");
  ol.writeString("<tr class=\"dirtab\">");
  ol.writeString("<th class=\"dirtab\">");
  ol.parseText(theTranslator->trFileIn(m_src->pathFragment()));
  ol.writeString("</th>");
  ol.writeString("<th class=\"dirtab\">");
  ol.parseText(theTranslator->trIncludesFileIn(m_dst->dir()->pathFragment()));
  ol.writeString("</th>");
  ol.writeString("</tr>");
 
  for (const auto &fp : m_dst->filePairs())
  {
    ol.writeString("<tr class=\"dirtab\">");
    ol.writeString("<td class=\"dirtab\">");
    writePartialFilePath(ol,m_src,fp->source());
    ol.writeString("</td>");
    ol.writeString("<td class=\"dirtab\">");
    writePartialFilePath(ol,m_dst->dir(),fp->destination());
    ol.writeString("</td>");
    ol.writeString("</tr>");
  }
  ol.writeString("</table>");
 
  ol.endContents();
 
  endFileWithNavPath(m_src,ol);
 
  ol.popGeneratorState();
}

引用了 Config_getBool, UsedDir::dir(), OutputList::disableAllBut(), DirDef::displayName(), OutputList::endContents(), endFileWithNavPath(), OutputList::endQuickIndices(), UsedDir::filePairs(), DirDef::getOutputFileBase(), getOutputFileBase(), HLI_None, OutputGenerator::Html, m_dst, m_src, OutputList::parseText(), Definition::pathFragment(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DirDef::shortName(), OutputList::startContents(), startFile(), theTranslator, Translator::trDirRelation(), Translator::trFileIn(), Translator::trIncludesFileIn(), DefinitionMutable::writeNavigationPath(), writePartialFilePath() , 以及 OutputList::writeString().

类成员变量说明

m_dst

UsedDir* DirRelation::m_dst

private

在文件 dirdef.h 第 172 行定义.

被这些函数引用 destination() , 以及 writeDocumentation().

m_name

QCString DirRelation::m_name

private

在文件 dirdef.h 第 170 行定义.

被这些函数引用 getOutputFileBase().

m_src

const DirDef* DirRelation::m_src

private

在文件 dirdef.h 第 171 行定义.

被这些函数引用 source() , 以及 writeDocumentation().

---

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

• src/dirdef.h
• src/dirdef.cpp