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