office-gobmx/autodoc/source/display/idl/hfi_property.hxx
Rüdiger Timm 2aef3f79eb CWS-TOOLING: integrate CWS betterautoifacedoc
2008-12-03 07:40:21 +0100 fs  r264742 : #i86469# for interfaces, have a 'Summary' and a 'Details' section, for greatly enhanced readability
2008-12-02 13:59:13 +0100 fs  r264698 : #i10000#
2008-12-08 12:49:49 +00:00

185 lines
6.2 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: hfi_property.hxx,v $
* $Revision: 1.4 $
*
* 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_HFI_PROPERTY_HXX
#define ADC_DISPLAY_HFI_PROPERTY_HXX
// USED SERVICES
// BASE CLASSES
#include "hi_factory.hxx"
// COMPONENTS
// PARAMETERS
#include <ary/idl/i_comrela.hxx>
class HF_SubTitleTable;
class HF_IdlDataMember : public HtmlFactory_Idl
{
public:
void Produce_byData(
const client & ce ) const;
protected:
HF_IdlDataMember(
Environment & io_rEnv,
HF_SubTitleTable & o_table );
virtual ~HF_IdlDataMember() {}
private:
virtual void write_Title(
const client & i_ce ) const;
virtual void write_Declaration(
const client & i_ce ) const = 0;
virtual void write_Description(
const client & i_ce ) const;
void enter_ContentCell() const;
void leave_ContentCell() const;
};
class HF_IdlProperty : public HF_IdlDataMember
{
public:
HF_IdlProperty(
Environment & io_rEnv,
HF_SubTitleTable & o_table )
: HF_IdlDataMember(io_rEnv, o_table) {}
virtual ~HF_IdlProperty();
private:
virtual void write_Declaration(
const client & i_ce ) const;
};
class HF_IdlAttribute : public HF_IdlDataMember
{
public:
HF_IdlAttribute(
Environment & io_rEnv,
HF_SubTitleTable & o_table )
: HF_IdlDataMember(io_rEnv, o_table) {}
virtual ~HF_IdlAttribute();
private:
virtual void write_Declaration(
const client & i_ce ) const;
};
class HF_IdlEnumValue : public HF_IdlDataMember
{
public:
HF_IdlEnumValue(
Environment & io_rEnv,
HF_SubTitleTable & o_table )
: HF_IdlDataMember(io_rEnv, o_table) {}
virtual ~HF_IdlEnumValue();
private:
virtual void write_Declaration(
const client & i_ce ) const;
};
class HF_IdlConstant : public HF_IdlDataMember
{
public:
HF_IdlConstant(
Environment & io_rEnv,
HF_SubTitleTable & o_table )
: HF_IdlDataMember(io_rEnv, o_table) {}
virtual ~HF_IdlConstant();
private:
virtual void write_Declaration(
const client & i_ce ) const;
};
class HF_IdlStructElement : public HF_IdlDataMember
{
public:
HF_IdlStructElement(
Environment & io_rEnv,
HF_SubTitleTable & o_table )
: HF_IdlDataMember(io_rEnv, o_table) {}
virtual ~HF_IdlStructElement();
private:
virtual void write_Declaration(
const client & i_ce ) const;
};
class HF_IdlCommentedRelationElement : public HF_IdlDataMember
{
public:
HF_IdlCommentedRelationElement(
Environment & io_rEnv,
HF_SubTitleTable & o_table,
const ary::idl::CommentedRelation& i_relation )
: HF_IdlDataMember(io_rEnv, o_table)
, m_relation( i_relation )
{
}
virtual ~HF_IdlCommentedRelationElement();
typedef ::ary::idl::CommentedRelation comref;
static void produce_LinkDoc(
Environment & io_env,
const client & i_ce,
Xml::Element & io_context,
const comref & i_commentedRef,
const E_DocType i_docType );
private:
virtual void write_Title(
const client & i_ce ) const;
virtual void write_Declaration(
const client & i_ce ) const;
virtual void write_Description(
const client & i_ce ) const;
private:
static void produce_Summary( Environment & io_env,
Xml::Element & io_context,
const comref & i_commentedRef,
const client & i_rScopeGivingCe );
static String get_LocalLinkName( Environment & io_env,
const comref & i_commentedRef );
private:
const ary::idl::CommentedRelation& m_relation;
};
#endif