DirRelation Class Reference

#include <dirdef.h>

Public Member Functions
	DirRelation (const QCString &name, DirDef *src, UsedDir *dst)
DirDef *	source () const
UsedDir *	destination () const
void	writeDocumentation (OutputList &ol)
QCString	getOutputFileBase () const

Private Attributes
QCString	m_name
DirDef *	m_src
UsedDir *	m_dst

Detailed Description

A usage relation between two directories.

Definition at line 149 of file dirdef.h.

Constructor & Destructor Documentation

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

inline

Definition at line 152 of file dirdef.h.

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

Member Function Documentation

UsedDir* DirRelation::destination ( ) const

inline

Definition at line 155 of file dirdef.h.

{ return m_dst; }

QCString DirRelation::getOutputFileBase ( ) const

inline

Definition at line 157 of file dirdef.h.

{ return m_name; }

DirDef* DirRelation::source ( ) const

inline

Definition at line 154 of file dirdef.h.

{ return m_src; }

void DirRelation::writeDocumentation

(

OutputList &

ol

)

Definition at line 732 of file dirdef.cpp.

{
  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>");

  SDict<FilePair>::Iterator fpi(m_dst->filePairs());
  FilePair *fp;
  for (fpi.toFirst();(fp=fpi.current());++fpi)
  {
    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();
}

Member Data Documentation

UsedDir* DirRelation::m_dst

private

Definition at line 162 of file dirdef.h.

QCString DirRelation::m_name

private

Definition at line 160 of file dirdef.h.

DirDef* DirRelation::m_src

private

Definition at line 161 of file dirdef.h.

---

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

• doxygen-1.8.11/src/dirdef.h
• doxygen-1.8.11/src/dirdef.cpp