autodoc/source/display/idl/hfi_property.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_DISPLAY_HFI_PROPERTY_HXX
  21 #define ADC_DISPLAY_HFI_PROPERTY_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27 #include "hi_factory.hxx"
  28     // COMPONENTS
  29     // PARAMETERS
  30 #include <ary/idl/i_comrela.hxx>
  31
  32 class HF_SubTitleTable;
  33
  34 class HF_IdlDataMember : public HtmlFactory_Idl
  35 {
  36   public:
  37     void                Produce_byData(
  38                             const client &      ce ) const;
  39   protected:
  40                         HF_IdlDataMember(
  41                             Environment &       io_rEnv,
  42                             HF_SubTitleTable &  o_table );
  43     virtual             ~HF_IdlDataMember() {}
  44
  45   private:
  46     virtual void        write_Title(
  47                             const client &      i_ce ) const;
  48
  49     virtual void        write_Declaration(
  50                             const client &      i_ce ) const = 0;
  51
  52     virtual void        write_Description(
  53                             const client &      i_ce ) const;
  54
  55     void                enter_ContentCell() const;
  56     void                leave_ContentCell() const;
  57 };
  58
  59
  60
  61 class HF_IdlProperty : public HF_IdlDataMember
  62 {
  63   public:
  64                         HF_IdlProperty(
  65                             Environment &       io_rEnv,
  66                             HF_SubTitleTable &  o_table )
  67                             :   HF_IdlDataMember(io_rEnv, o_table) {}
  68     virtual             ~HF_IdlProperty();
  69   private:
  70     virtual void        write_Declaration(
  71                             const client &      i_ce ) const;
  72 };
  73
  74 class HF_IdlAttribute : public HF_IdlDataMember
  75 {
  76   public:
  77                         HF_IdlAttribute(
  78                             Environment &       io_rEnv,
  79                             HF_SubTitleTable &  o_table )
  80                             :   HF_IdlDataMember(io_rEnv, o_table) {}
  81     virtual             ~HF_IdlAttribute();
  82
  83   private:
  84     virtual void        write_Declaration(
  85                             const client &      i_ce ) const;
  86 };
  87
  88
  89 class HF_IdlEnumValue : public HF_IdlDataMember
  90 {
  91   public:
  92                         HF_IdlEnumValue(
  93                             Environment &       io_rEnv,
  94                             HF_SubTitleTable &  o_table )
  95                             :   HF_IdlDataMember(io_rEnv, o_table) {}
  96     virtual             ~HF_IdlEnumValue();
  97
  98   private:
  99     virtual void        write_Declaration(
 100                             const client &      i_ce ) const;
 101 };
 102
 103 class HF_IdlConstant : public HF_IdlDataMember
 104 {
 105   public:
 106                         HF_IdlConstant(
 107                             Environment &       io_rEnv,
 108                             HF_SubTitleTable &  o_table )
 109                             :   HF_IdlDataMember(io_rEnv, o_table) {}
 110     virtual             ~HF_IdlConstant();
 111
 112   private:
 113     virtual void        write_Declaration(
 114                             const client &      i_ce ) const;
 115 };
 116
 117
 118 class HF_IdlStructElement : public HF_IdlDataMember
 119 {
 120   public:
 121                         HF_IdlStructElement(
 122                             Environment &       io_rEnv,
 123                             HF_SubTitleTable &  o_table )
 124                             :   HF_IdlDataMember(io_rEnv, o_table) {}
 125     virtual             ~HF_IdlStructElement();
 126
 127   private:
 128     virtual void        write_Declaration(
 129                             const client &      i_ce ) const;
 130 };
 131
 132 class HF_IdlCommentedRelationElement : public HF_IdlDataMember
 133 {
 134   public:
 135                         HF_IdlCommentedRelationElement(
 136                             Environment &                       io_rEnv,
 137                             HF_SubTitleTable &                  o_table,
 138                             const ary::idl::CommentedRelation&  i_relation )
 139                             :   HF_IdlDataMember(io_rEnv, o_table)
 140                             ,   m_relation( i_relation )
 141                         {
 142                         }
 143     virtual             ~HF_IdlCommentedRelationElement();
 144
 145     typedef ::ary::idl::CommentedRelation       comref;
 146
 147     static void         produce_LinkDoc(
 148                             Environment &   io_env,
 149                             const client &  i_ce,
 150                             Xml::Element &  io_context,
 151                             const comref &  i_commentedRef,
 152                             const E_DocType i_docType );
 153
 154   private:
 155     virtual void        write_Title(
 156                             const client &      i_ce ) const;
 157     virtual void        write_Declaration(
 158                             const client &      i_ce ) const;
 159     virtual void        write_Description(
 160                             const client &      i_ce ) const;
 161   private:
 162     static void         produce_Summary( Environment &  io_env,
 163                                          Xml::Element & io_context,
 164                                          const comref & i_commentedRef,
 165                                          const client & i_rScopeGivingCe );
 166
 167     static String       get_LocalLinkName( Environment &  io_env,
 168                                            const comref & i_commentedRef );
 169
 170   private:
 171     const ary::idl::CommentedRelation&  m_relation;
 172 };
 173
 174 #endif
 175
 176 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */