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