autodoc/source/display/idl/hi_factory.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hi_factory.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_DISPLAY_HI_FACTORY_HXX
  32 #define ADC_DISPLAY_HI_FACTORY_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include <toolkit/htmlfactory.hxx>
  38     // COMPONENTS
  39     // PARAMETERS
  40 #include <ary/stdconstiter.hxx>
  41 #include <ary/idl/i_types4idl.hxx>
  42 #include <toolkit/out_position.hxx>
  43
  44
  45 namespace ary
  46 {
  47 namespace idl
  48 {
  49     class Module;
  50 }
  51 namespace doc
  52 {
  53     class OldIdlDocu;
  54 }
  55 }
  56
  57
  58 class HtmlEnvironment_Idl;
  59 class LinkHelper;
  60 class HF_NaviSubRow;
  61 class HF_TitleTable;
  62 class HF_SubTitleTable;
  63
  64
  65 class HtmlFactory_Idl : public HtmlFactory<HtmlEnvironment_Idl>
  66 {
  67   public:
  68     enum E_MemberViewType
  69     {
  70         viewtype_summary,   // the summary of the members
  71         viewtype_details,   // the details of the members
  72         viewtype_complete   // everything
  73     };
  74
  75     enum E_DocType
  76     {
  77         doctype_summaryOnly,    // only the summary
  78         doctype_complete        // the complete documentation
  79     };
  80
  81   public:
  82     typedef ary::idl::CodeEntity                client;
  83     typedef ary::idl::Ce_id                     ce_id;
  84     typedef ary::idl::Type_id                   type_id;
  85     typedef ary::doc::OldIdlDocu                ce_info;
  86
  87     typedef ary::Dyn_StdConstIterator<ce_id>    dyn_ce_list;
  88     typedef ary::Dyn_StdConstIterator<type_id>  dyn_type_list;
  89     typedef ary::StdConstIterator<ce_id>        ce_list;
  90     typedef ary::StdConstIterator<type_id>      type_list;
  91
  92     typedef HtmlEnvironment_Idl                 Environment;
  93     typedef output::Position                    OutPosition;
  94
  95   protected:
  96                         HtmlFactory_Idl(
  97                             Environment &       io_rEnv,
  98                             Xml::Element *      o_pOut = 0 )
  99                             :   HtmlFactory<Environment>(io_rEnv, o_pOut)
 100                             { }
 101     virtual             ~HtmlFactory_Idl() {}
 102
 103     /** The default version only calls ->produce_InternalLink().
 104         This may be overwritten by derived classes.
 105     */
 106     virtual void        produce_SummaryDeclaration(
 107                             Xml::Element &      o_row,
 108                             const client &      i_ce ) const;
 109     void                produce_InternalLink(
 110                             Xml::Element &      o_row,
 111                             const client &      i_ce ) const;
 112     void                produce_ShortDoc(
 113                             Xml::Element &      o_row,
 114                             const client &      i_ce ) const;
 115
 116     // KORR_FUTURE: Does not belong here (implementation inheritance)!
 117     void                produce_Bases(
 118                                 Xml::Element &   o_screen,
 119                                 const client &   i_ce,
 120                                 const String &   i_sLabel ) const;
 121     void                produce_Members(
 122                             ce_list &               it_list,
 123                             const String &          i_summaryTitle,
 124                             const String &          i_summaryLabel,
 125                             const String &          i_detailsTitle,
 126                             const String &          i_detailsLabel,
 127                             const E_MemberViewType  i_viewType = viewtype_complete ) const;
 128
 129     void                produce_Title(
 130                             HF_TitleTable &     o_title,
 131                             const String &      i_label,
 132                             const client &      i_ce ) const;
 133     void                get_Annotations(
 134                             StreamStr &         o_out,
 135                             const client &      i_ce ) const;
 136
 137     /// Writes complete docu in standard format.
 138     void                write_Docu(
 139                             Xml::Element &      o_screen,
 140                             const client &      i_ce ) const;
 141
 142     void                write_ManualLinks(
 143                             Xml::Element &      o_screen,
 144                             const client &      i_ce ) const;
 145   private:
 146     // Dummy does nothing
 147     virtual void        produce_MemberDetails(
 148                             HF_SubTitleTable &  o_table,
 149                             const client &      i_ce ) const;
 150     void                recursive_ShowBases(
 151                             Xml::Element &      o_screen,
 152                             type_id             i_baseType,
 153                             int &               io_nDepth ) const;
 154     type_id             baseOf(
 155                             const client &      i_ce ) const
 156                                                 { return inq_BaseOf(i_ce); }
 157     virtual type_id     inq_BaseOf(
 158                             const client &      i_ce ) const;
 159 };
 160
 161
 162 extern const String
 163     C_sCellStyle_SummaryLeft;
 164 extern const String
 165     C_sCellStyle_SummaryRight;
 166 extern const String
 167     C_sCellStyle_MDetail;
 168 extern const String
 169     C_sMemberTitle;
 170
 171
 172 #endif