xref: /aoo42x/main/autodoc/inc/ary/idl/i_comrela.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ARY_IDL_I_COMRELA_HXX
29 #define ARY_IDL_I_COMRELA_HXX
30 
31 // USED SERVICES
32 #include <ary/idl/i_types4idl.hxx>
33 
34 namespace ary
35 {
36 namespace doc
37 {
38     class OldIdlDocu;
39 }
40 }
41 
42 
43 
44 
45 namespace ary
46 {
47 namespace idl
48 {
49 
50 
51 /** Contains data for an IDL code entity related to another one like a base of
52     an interface or of a service or the supported interface of a service.
53 */
54 class CommentedRelation
55 {
56   public:
57     // LIFECYCLE
58 
59                         CommentedRelation(
60                             Type_id             i_nType,
61                             doc::OldIdlDocu *   i_pInfo )
62                                                 :   nType(i_nType),
63                                                     pInfo(i_pInfo)
64                                                 {}
65     // INQUIRY
66     Type_id             Type() const            { return nType; }
67     doc::OldIdlDocu *   Info() const            { return pInfo; }
68 
69   private:
70     // DATA
71     Type_id             nType;
72     doc::OldIdlDocu *   pInfo;
73 };
74 
75 
76 
77 
78 }   // namespace idl
79 }   // namespace ary
80 #endif
81