autodoc/source/display/idl/hfi_property.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2         /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ADC_DISPLAY_HFI_PROPERTY_HXX
  30 #define ADC_DISPLAY_HFI_PROPERTY_HXX
  31
  32
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include "hi_factory.hxx"
  37     // COMPONENTS
  38     // PARAMETERS
  39 #include <ary/idl/i_comrela.hxx>
  40
  41 class HF_SubTitleTable;
  42
  43 class HF_IdlDataMember : public HtmlFactory_Idl
  44 {
  45   public:
  46     void                Produce_byData(
  47                             const client &      ce ) const;
  48   protected:
  49                         HF_IdlDataMember(
  50                             Environment &       io_rEnv,
  51                             HF_SubTitleTable &  o_table );
  52     virtual             ~HF_IdlDataMember() {}
  53
  54   private:
  55     virtual void        write_Title(
  56                             const client &      i_ce ) const;
  57
  58     virtual void        write_Declaration(
  59                             const client &      i_ce ) const = 0;
  60
  61     virtual void        write_Description(
  62                             const client &      i_ce ) const;
  63
  64     void                enter_ContentCell() const;
  65     void                leave_ContentCell() const;
  66 };
  67
  68
  69
  70 class HF_IdlProperty : public HF_IdlDataMember
  71 {
  72   public:
  73                         HF_IdlProperty(
  74                             Environment &       io_rEnv,
  75                             HF_SubTitleTable &  o_table )
  76                             :   HF_IdlDataMember(io_rEnv, o_table) {}
  77     virtual             ~HF_IdlProperty();
  78   private:
  79     virtual void        write_Declaration(
  80                             const client &      i_ce ) const;
  81 };
  82
  83 class HF_IdlAttribute : public HF_IdlDataMember
  84 {
  85   public:
  86                         HF_IdlAttribute(
  87                             Environment &       io_rEnv,
  88                             HF_SubTitleTable &  o_table )
  89                             :   HF_IdlDataMember(io_rEnv, o_table) {}
  90     virtual             ~HF_IdlAttribute();
  91
  92   private:
  93     virtual void        write_Declaration(
  94                             const client &      i_ce ) const;
  95 };
  96
  97
  98 class HF_IdlEnumValue : public HF_IdlDataMember
  99 {
 100   public:
 101                         HF_IdlEnumValue(
 102                             Environment &       io_rEnv,
 103                             HF_SubTitleTable &  o_table )
 104                             :   HF_IdlDataMember(io_rEnv, o_table) {}
 105     virtual             ~HF_IdlEnumValue();
 106
 107   private:
 108     virtual void        write_Declaration(
 109                             const client &      i_ce ) const;
 110 };
 111
 112 class HF_IdlConstant : public HF_IdlDataMember
 113 {
 114   public:
 115                         HF_IdlConstant(
 116                             Environment &       io_rEnv,
 117                             HF_SubTitleTable &  o_table )
 118                             :   HF_IdlDataMember(io_rEnv, o_table) {}
 119     virtual             ~HF_IdlConstant();
 120
 121   private:
 122     virtual void        write_Declaration(
 123                             const client &      i_ce ) const;
 124 };
 125
 126
 127 class HF_IdlStructElement : public HF_IdlDataMember
 128 {
 129   public:
 130                         HF_IdlStructElement(
 131                             Environment &       io_rEnv,
 132                             HF_SubTitleTable &  o_table )
 133                             :   HF_IdlDataMember(io_rEnv, o_table) {}
 134     virtual             ~HF_IdlStructElement();
 135
 136   private:
 137     virtual void        write_Declaration(
 138                             const client &      i_ce ) const;
 139 };
 140
 141 class HF_IdlCommentedRelationElement : public HF_IdlDataMember
 142 {
 143   public:
 144                         HF_IdlCommentedRelationElement(
 145                             Environment &                       io_rEnv,
 146                             HF_SubTitleTable &                  o_table,
 147                             const ary::idl::CommentedRelation&  i_relation )
 148                             :   HF_IdlDataMember(io_rEnv, o_table)
 149                             ,   m_relation( i_relation )
 150                         {
 151                         }
 152     virtual             ~HF_IdlCommentedRelationElement();
 153
 154     typedef ::ary::idl::CommentedRelation       comref;
 155
 156     static void         produce_LinkDoc(
 157                             Environment &   io_env,
 158                             const client &  i_ce,
 159                             Xml::Element &  io_context,
 160                             const comref &  i_commentedRef,
 161                             const E_DocType i_docType );
 162
 163   private:
 164     virtual void        write_Title(
 165                             const client &      i_ce ) const;
 166     virtual void        write_Declaration(
 167                             const client &      i_ce ) const;
 168     virtual void        write_Description(
 169                             const client &      i_ce ) const;
 170   private:
 171     static void         produce_Summary( Environment &  io_env,
 172                                          Xml::Element & io_context,
 173                                          const comref & i_commentedRef,
 174                                          const client & i_rScopeGivingCe );
 175
 176     static String       get_LocalLinkName( Environment &  io_env,
 177                                            const comref & i_commentedRef );
 178
 179   private:
 180     const ary::idl::CommentedRelation&  m_relation;
 181 };
 182
 183 #endif
 184
 185 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */