/************************************************************************* * * $RCSfile: hd_docu.hxx,v $ * * $Revision: 1.1.1.1 $ * * last change: $Author: np $ $Date: 2002-03-08 14:45:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef ADC_DISPLAY_HTML_HD_DOCU_HXX #define ADC_DISPLAY_HTML_HD_DOCU_HXX // USED SERVICES // BASE CLASSES #include #include #include "hdimpl.hxx" // COMPONENTS // PARAMETERS namespace ary { namespace info { class DocuText; } class QualifiedName; } class OuputPage_Environmen; class Docu_Display : public ary::cpp::Display, 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(); // Interface ary::cpp::Display virtual void Display_Namespace( const ary::cpp::Namespace & i_rData ); virtual void Display_Class( const ary::cpp::Class & i_rData ); virtual void Display_Enum( const ary::cpp::Enum & i_rData ); virtual void Display_Typedef( const ary::cpp::Typedef & i_rData ); virtual void Display_Function( const ary::cpp::Function & i_rData ); virtual void Display_Variable( const ary::cpp::Variable & i_rData ); // Interface ary::info::DocuDisplay: virtual void Display_CodeInfo( const ary::info::CodeInfo & i_rData ); 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_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 ); private: 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 udmstri & 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