autodoc/source/display/idl/hfi_enum.cxx

   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: hfi_enum.cxx,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 #include <precomp.h>
  32 #include "hfi_enum.hxx"
  33
  34
  35 // NOT FULLY DEFINED SERVICES
  36 #include <ary/idl/i_ce.hxx>
  37 #include <ary/idl/ik_enum.hxx>
  38 #include <toolkit/hf_linachain.hxx>
  39 #include <toolkit/hf_navi_sub.hxx>
  40 #include <toolkit/hf_title.hxx>
  41 #include "hfi_navibar.hxx"
  42 #include "hfi_property.hxx"
  43 #include "hi_linkhelper.hxx"
  44
  45
  46 extern const String
  47     C_sCePrefix_Enum("enum");
  48
  49 namespace
  50 {
  51
  52 const String
  53     C_sList_Values("Values");
  54 const String
  55     C_sList_Values_Label("Values");
  56 const String
  57     C_sList_ValueDetails("Values' Details");
  58 const String
  59     C_sList_ValueDetails_Label("ValueDetails");
  60
  61 enum E_SubListIndices
  62 {
  63     sli_ValuesSummary = 0,
  64     sli_ValueDetails = 1
  65 };
  66
  67 }   // anonymous namespace
  68
  69 HF_IdlEnum::HF_IdlEnum( Environment &       io_rEnv,
  70                         Xml::Element &      o_rOut )
  71     :   HtmlFactory_Idl(io_rEnv, &o_rOut)
  72 {
  73 }
  74
  75 HF_IdlEnum::~HF_IdlEnum()
  76 {
  77 }
  78
  79 void
  80 HF_IdlEnum::Produce_byData( const client & i_ce ) const
  81 {
  82     Dyn<HF_NaviSubRow>
  83         pNaviSubRow( &make_Navibar(i_ce) );
  84
  85     HF_TitleTable
  86         aTitle(CurOut());
  87
  88     HF_LinkedNameChain
  89         aNameChain(aTitle.Add_Row());
  90
  91     aNameChain.Produce_CompleteChain(Env().CurPosition(), nameChainLinker);
  92     produce_Title(aTitle, C_sCePrefix_Enum, i_ce);
  93
  94     write_Docu(aTitle.Add_Row(), i_ce);
  95     CurOut() << new Html::HorizontalLine();
  96
  97     dyn_ce_list
  98         dpValues;
  99     ary::idl::ifc_enum::attr::Get_Values(dpValues, i_ce);
 100     if ( (*dpValues).operator bool() )
 101     {
 102         produce_Members( *dpValues,
 103                          C_sList_Values,
 104                          C_sList_Values_Label,
 105                          C_sList_ValueDetails,
 106                          C_sList_ValueDetails_Label );
 107         pNaviSubRow->SwitchOn(sli_ValuesSummary);
 108         pNaviSubRow->SwitchOn(sli_ValueDetails);
 109     }
 110     pNaviSubRow->Produce_Row();
 111 }
 112
 113 HF_NaviSubRow &
 114 HF_IdlEnum::make_Navibar( const client & i_ce ) const
 115 {
 116     HF_IdlNavigationBar
 117         aNaviBar(Env(), CurOut());
 118     aNaviBar.Produce_CeMainRow(i_ce);
 119
 120     DYN HF_NaviSubRow &
 121         ret = aNaviBar.Add_SubRow();
 122     ret.AddItem(C_sList_Values, C_sList_Values_Label, false);
 123     ret.AddItem(C_sList_ValueDetails, C_sList_ValueDetails_Label, false);
 124
 125     CurOut() << new Html::HorizontalLine();
 126     return ret;
 127 }
 128
 129 void
 130 HF_IdlEnum::produce_MemberDetails( HF_SubTitleTable &  o_table,
 131                                    const client &      i_ce) const
 132 {
 133     HF_IdlEnumValue
 134         aElement( Env(), o_table );
 135     aElement.Produce_byData(i_ce);
 136 }