autodoc/source/display/idl/hfi_struct.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: hfi_struct.hxx,v $
  10  * $Revision: 1.4 $
  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_HFI_STRUCT_HXX
  32 #define ADC_DISPLAY_HFI_STRUCT_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include "hi_factory.hxx"
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42 /** Is used to display ->ary::idl::Exception s as well as ->ary::idl::Struct s.
  43 */
  44 class HF_IdlStruct : public HtmlFactory_Idl
  45 {
  46   public:
  47
  48                         HF_IdlStruct(
  49                             Environment &       io_rEnv,
  50                             Xml::Element &      o_rOut,
  51                             bool                i_bIsException );
  52     virtual             ~HF_IdlStruct();
  53
  54     void                Produce_byData(
  55                             const client &      ce ) const;
  56   private:
  57     // Interface HtmlFactory_Idl:
  58     virtual type_id     inq_BaseOf(
  59                             const client &      i_ce ) const;
  60     // Locals
  61     HF_NaviSubRow &     make_Navibar(
  62                             const client &      ce ) const;
  63     virtual void        produce_MemberDetails(
  64                             HF_SubTitleTable &  o_table,
  65                             const client &      ce ) const;
  66     // DATA
  67     bool                bIsException;
  68 };
  69
  70
  71
  72 // IMPLEMENTATION
  73
  74
  75 extern const String
  76     C_sCePrefix_Struct;
  77 extern const String
  78     C_sCePrefix_Exception;
  79
  80
  81 #endif