office-gobmx/autodoc/source/display/html/hd_docu.hxx
2010-10-27 13:05:40 +01:00

199 lines
7.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ADC_DISPLAY_HTML_HD_DOCU_HXX
#define ADC_DISPLAY_HTML_HD_DOCU_HXX
// BASE CLASSES
#include <ary/ary_disp.hxx>
#include <ary/info/infodisp.hxx>
#include <cosv/tpl/processor.hxx>
#include "hdimpl.hxx"
namespace ary
{
namespace cpp
{
class Namespace;
class Class;
class Enum;
class Typedef;
class Function;
class Variable;
}
namespace doc
{
class Documentation;
}
namespace info
{
class DocuText;
}
class QualifiedName;
}
class OuputPage_Environment;
class Docu_Display : public ary::Display,
public csv::ConstProcessor<ary::cpp::Namespace>,
public csv::ConstProcessor<ary::cpp::Class>,
public csv::ConstProcessor<ary::cpp::Enum>,
public csv::ConstProcessor<ary::cpp::Typedef>,
public csv::ConstProcessor<ary::cpp::Function>,
public csv::ConstProcessor<ary::cpp::Variable>,
public csv::ConstProcessor<ary::doc::Documentation>,
public ary::info::DocuDisplay,
private HtmlDisplay_Impl
{
public:
Docu_Display(
OuputPage_Environment &
io_rEnv );
virtual ~Docu_Display();
void Assign_Out(
csi::xml::Element & o_rOut );
void Unassign_Out();
virtual void Display_StdTag(
const ary::info::StdTag &
i_rData );
virtual void Display_BaseTag(
const ary::info::BaseTag &
i_rData );
virtual void Display_ExceptionTag(
const ary::info::ExceptionTag &
i_rData );
virtual void Display_ImplementsTag(
const ary::info::ImplementsTag &
i_rData );
virtual void Display_KeywordTag(
const ary::info::KeywordTag &
i_rData );
virtual void Display_ParameterTag(
const ary::info::ParameterTag &
i_rData );
virtual void Display_SeeTag(
const ary::info::SeeTag &
i_rData );
virtual void Display_TemplateTag(
const ary::info::TemplateTag &
i_rData );
virtual void Display_LabelTag(
const ary::info::LabelTag &
i_rData );
virtual void Display_SinceTag(
const ary::info::SinceTag &
i_rData );
virtual void Display_DT_Text(
const ary::info::DT_Text &
i_rData );
virtual void Display_DT_MaybeLink(
const ary::info::DT_MaybeLink &
i_rData );
virtual void Display_DT_Whitespace(
const ary::info::DT_Whitespace &
i_rData );
virtual void Display_DT_Eol(
const ary::info::DT_Eol &
i_rData );
virtual void Display_DT_Xml(
const ary::info::DT_Xml &
i_rData );
using csv::ConstProcessor<ary::doc::Documentation>::Process;
private:
// Interface csv::ConstProcessor<>:
virtual void do_Process(
const ary::cpp::Namespace &
i_rData );
virtual void do_Process(
const ary::cpp::Class &
i_rData );
virtual void do_Process(
const ary::cpp::Enum &
i_rData );
virtual void do_Process(
const ary::cpp::Typedef &
i_rData );
virtual void do_Process(
const ary::cpp::Function &
i_rData );
virtual void do_Process(
const ary::cpp::Variable &
i_rData );
virtual void do_Process(
const ary::doc::Documentation &
i_rData );
// Interface ary::Display:
virtual const ary::cpp::Gate *
inq_Get_ReFinder() const;
// Locals
void Start_DocuBlock();
void Finish_DocuBlock();
void Write_TagTitle(
const char * i_sText,
const char * i_nFontSize = "+0" );
void Write_TagContents(
const ary::info::DocuText &
i_rDocuText );
void Write_Text(
const ary::info::DocuText &
i_rDocuText );
void Write_TextToken(
const String & i_sText );
void Write_LinkableText(
const ary::QualifiedName &
i_sQuName );
void Write_QualifiedName(
const ary::QualifiedName &
i_sQuName );
// DATA
bool bUseHtmlInDocuTokens;
/** This is used, if a class documentation is displayed,
because for links to members then the "current class"
is not the parent, but this class itself.
*/
const ary::cpp::Class *
pCurClassOverwrite;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */