#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 151 of file dirdef.h.

Constructor & Destructor Documentation

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

inline

Definition at line 154 of file dirdef.h.

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

Member Function Documentation

UsedDir* DirRelation::destination ( ) const

inline

Definition at line 157 of file dirdef.h.

References m_dst.

{ return m_dst; }

QCString DirRelation::getOutputFileBase ( ) const

inline

Definition at line 159 of file dirdef.h.

References m_name.

Referenced by writeDocumentation().

{ return m_name; }

DirDef* DirRelation::source ( ) const

inline

Definition at line 156 of file dirdef.h.

References m_src.

{ return m_src; }

void DirRelation::writeDocumentation ( OutputList & ol )

Definition at line 777 of file dirdef.cpp.

References 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(), Definition::writeNavigationPath(), writePartialFilePath(), and OutputList::writeString().

Referenced by generateDirDocs().

{
  static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  QCString shortTitle=theTranslator->trDirRelation(
                      m_src->shortName()+" &rarr; "+
                      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();
}