xref: /aoo41x/main/autodoc/inc/ary/idl/ik_ce.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ARY_IDL_IK_CE_HXX
29*cdf0e10cSrcweir #define ARY_IDL_IK_CE_HXX
30*cdf0e10cSrcweir //  KORR_DEPRECATED_3.0
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir // USED SERVICES
35*cdf0e10cSrcweir 	// BASE CLASSES
36*cdf0e10cSrcweir 	// COMPONENTS
37*cdf0e10cSrcweir 	// PARAMETERS
38*cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx>
39*cdf0e10cSrcweir #include <ary/stdconstiter.hxx>
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir namespace ary
42*cdf0e10cSrcweir {
43*cdf0e10cSrcweir namespace info
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir  	class Text;
46*cdf0e10cSrcweir }
47*cdf0e10cSrcweir namespace idl
48*cdf0e10cSrcweir {
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir namespace ifc_ce
52*cdf0e10cSrcweir {
53*cdf0e10cSrcweir 
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir typedef ::ary::Dyn_StdConstIterator<Ce_id>      Dyn_CeIterator;
56*cdf0e10cSrcweir typedef ::ary::Dyn_StdConstIterator<Type_id>    Dyn_TypeIterator;
57*cdf0e10cSrcweir typedef ::ary::info::Text                       DocText;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir struct attr
62*cdf0e10cSrcweir {
63*cdf0e10cSrcweir     static Ce_id        CeId(
64*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
65*cdf0e10cSrcweir     static const String &
66*cdf0e10cSrcweir                         LocalName(
67*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
68*cdf0e10cSrcweir     static Ce_id        NameRoom(
69*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
70*cdf0e10cSrcweir     static Rid          Owner(
71*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
72*cdf0e10cSrcweir     static E_SightLevel SightLevel(
73*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
74*cdf0e10cSrcweir     static bool         Search_Member(
75*cdf0e10cSrcweir                             const CodeEntity &  ,
76*cdf0e10cSrcweir                             const String &      )
77*cdf0e10cSrcweir                             { return true; }    // KORR_FUTURE
78*cdf0e10cSrcweir };
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir struct xref
81*cdf0e10cSrcweir {
82*cdf0e10cSrcweir };
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir struct doc
85*cdf0e10cSrcweir {
86*cdf0e10cSrcweir     static const DocText &
87*cdf0e10cSrcweir                         ShortInfo(          /// @return a short description of the CodeEntity
88*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir     static const DocText &
91*cdf0e10cSrcweir                         TagAuthor(
92*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
93*cdf0e10cSrcweir     static const DocText &
94*cdf0e10cSrcweir                         TagExample(
95*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
96*cdf0e10cSrcweir     static const DocText &
97*cdf0e10cSrcweir                         TagDescr(
98*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
99*cdf0e10cSrcweir     static const DocText &
100*cdf0e10cSrcweir                         TagGuarantees(
101*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
102*cdf0e10cSrcweir     static const DocText &
103*cdf0e10cSrcweir                         TagKey(
104*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
105*cdf0e10cSrcweir     static const DocText &
106*cdf0e10cSrcweir                         TagMissing(
107*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
108*cdf0e10cSrcweir     static const DocText &
109*cdf0e10cSrcweir                         TagSee(
110*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
111*cdf0e10cSrcweir     static const DocText &
112*cdf0e10cSrcweir                         TagShort(
113*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
114*cdf0e10cSrcweir     static const DocText &
115*cdf0e10cSrcweir                         TagVersion(
116*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
117*cdf0e10cSrcweir 
118*cdf0e10cSrcweir     void                Get_UnkownTags(
119*cdf0e10cSrcweir                             Dyn_CeIterator &    o_result,
120*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
121*cdf0e10cSrcweir 
122*cdf0e10cSrcweir     bool                IsDeprecated(
123*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
124*cdf0e10cSrcweir     bool                IsIncomplete(
125*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
126*cdf0e10cSrcweir     bool                IsInternal(
127*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
128*cdf0e10cSrcweir     bool                IsNodoc(
129*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
130*cdf0e10cSrcweir     bool                IsOptional(
131*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
132*cdf0e10cSrcweir     bool                IsSuspicious(
133*cdf0e10cSrcweir                             const CodeEntity &  i_ce );
134*cdf0e10cSrcweir 
135*cdf0e10cSrcweir };
136*cdf0e10cSrcweir 
137*cdf0e10cSrcweir 
138*cdf0e10cSrcweir }   // namespace ifc_ce
139*cdf0e10cSrcweir 
140*cdf0e10cSrcweir 
141*cdf0e10cSrcweir }   // namspace idl
142*cdf0e10cSrcweir }   // namspace ary
143*cdf0e10cSrcweir 
144*cdf0e10cSrcweir #endif
145*cdf0e10cSrcweir 
146*cdf0e10cSrcweir 
147