autodoc/inc/ary/idl/i_gate.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: i_gate.hxx,v $
  10  * $Revision: 1.5 $
  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 ARY_IDL_I_GATE_HXX
  32 #define ARY_IDL_I_GATE_HXX
  33
  34 // USED SERVICES
  35
  36 namespace autodoc
  37 {
  38     class Options;
  39 }
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44     class CePilot;
  45     class TypePilot;
  46 }
  47 }
  48
  49
  50
  51
  52 namespace ary
  53 {
  54 namespace idl
  55 {
  56
  57
  58 /** Main entry to access the IDL parts of the repository.
  59 */
  60 class Gate
  61 {
  62   public:
  63     // LIFECYCLE
  64     virtual             ~Gate() {}
  65
  66     // OPERATIONS
  67     virtual void        Calculate_AllSecondaryInformation(
  68                             const String &      i_devman_reffilepath ) = 0;
  69 //                            const ::autodoc::Options &
  70 //                                                i_options ) = 0;
  71     // INQUIRY
  72     virtual const CePilot &
  73                         Ces() const = 0;
  74     virtual const TypePilot &
  75                         Types() const = 0;
  76     // ACCESS
  77     virtual CePilot &   Ces() = 0;
  78     virtual TypePilot & Types() = 0;
  79 };
  80
  81
  82
  83
  84 }   // namespace idl
  85 }   // namespace ary
  86 #endif