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