autodoc/inc/ary/idl/i_comrela.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_comrela.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_COMRELA_HXX
  32 #define ARY_IDL_I_COMRELA_HXX
  33
  34 // USED SERVICES
  35 #include <ary/idl/i_types4idl.hxx>
  36
  37 namespace ary
  38 {
  39 namespace doc
  40 {
  41     class OldIdlDocu;
  42 }
  43 }
  44
  45
  46
  47
  48 namespace ary
  49 {
  50 namespace idl
  51 {
  52
  53
  54 /** Contains data for an IDL code entity related to another one like a base of
  55     an interface or of a service or the supported interface of a service.
  56 */
  57 class CommentedRelation
  58 {
  59   public:
  60     // LIFECYCLE
  61
  62                         CommentedRelation(
  63                             Type_id             i_nType,
  64                             doc::OldIdlDocu *   i_pInfo )
  65                                                 :   nType(i_nType),
  66                                                     pInfo(i_pInfo)
  67                                                 {}
  68     // INQUIRY
  69     Type_id             Type() const            { return nType; }
  70     doc::OldIdlDocu *   Info() const            { return pInfo; }
  71
  72   private:
  73     // DATA
  74     Type_id             nType;
  75     doc::OldIdlDocu *   pInfo;
  76 };
  77
  78
  79
  80
  81 }   // namespace idl
  82 }   // namespace ary
  83 #endif