autodoc/inc/ary/ary.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: ary.hxx,v $
  10  * $Revision: 1.6 $
  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_ARY_HXX
  32 #define ARY_ARY_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37     // OTHER
  38
  39 namespace ary
  40 {
  41 namespace idl
  42 {
  43     class Gate;
  44 }
  45
  46 namespace cpp
  47 {
  48     class Gate;
  49 }
  50 }
  51
  52
  53
  54 namespace ary
  55 {
  56
  57 /** Starting point for all work with the
  58     Autodoc Sourcecode Repository.
  59
  60     Create and destroy the repository and
  61     give access to the "Gates" for different tasks.
  62
  63     @collab ::ary::cpp::Gate
  64     @collab ::ary::idl::Gate
  65 */
  66
  67 class Repository
  68 {
  69   public:
  70     //  LIFECYCLE
  71     virtual             ~Repository() {}
  72     static DYN Repository &
  73                         Create_();
  74     // INQUIRY
  75     virtual const String &
  76                         Title() const = 0;
  77     virtual const ::ary::cpp::Gate &
  78                         Gate_Cpp() const = 0;
  79     virtual const ::ary::idl::Gate &
  80                         Gate_Idl() const = 0;
  81     // ACCESS
  82     virtual ::ary::cpp::Gate &
  83                         Gate_Cpp() = 0;
  84     virtual ::ary::idl::Gate &
  85                         Gate_Idl() = 0;
  86     virtual void        Set_Title(
  87                             const String &      i_sName ) = 0;
  88 };
  89
  90
  91
  92 } // namespace ary
  93 #endif