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_IK_CE_HXX 29 #define ARY_IDL_IK_CE_HXX 30 // KORR_DEPRECATED_3.0 31 32 33 34 // USED SERVICES 35 // BASE CLASSES 36 // COMPONENTS 37 // PARAMETERS 38 #include <ary/idl/i_types4idl.hxx> 39 #include <ary/stdconstiter.hxx> 40 41 namespace ary 42 { 43 namespace info 44 { 45 class Text; 46 } 47 namespace idl 48 { 49 50 51 namespace ifc_ce 52 { 53 54 55 typedef ::ary::Dyn_StdConstIterator<Ce_id> Dyn_CeIterator; 56 typedef ::ary::Dyn_StdConstIterator<Type_id> Dyn_TypeIterator; 57 typedef ::ary::info::Text DocText; 58 59 60 61 struct attr 62 { 63 static Ce_id CeId( 64 const CodeEntity & i_ce ); 65 static const String & 66 LocalName( 67 const CodeEntity & i_ce ); 68 static Ce_id NameRoom( 69 const CodeEntity & i_ce ); 70 static Rid Owner( 71 const CodeEntity & i_ce ); 72 static E_SightLevel SightLevel( 73 const CodeEntity & i_ce ); 74 static bool Search_Member( 75 const CodeEntity & , 76 const String & ) 77 { return true; } // KORR_FUTURE 78 }; 79 80 struct xref 81 { 82 }; 83 84 struct doc 85 { 86 static const DocText & 87 ShortInfo( /// @return a short description of the CodeEntity 88 const CodeEntity & i_ce ); 89 90 static const DocText & 91 TagAuthor( 92 const CodeEntity & i_ce ); 93 static const DocText & 94 TagExample( 95 const CodeEntity & i_ce ); 96 static const DocText & 97 TagDescr( 98 const CodeEntity & i_ce ); 99 static const DocText & 100 TagGuarantees( 101 const CodeEntity & i_ce ); 102 static const DocText & 103 TagKey( 104 const CodeEntity & i_ce ); 105 static const DocText & 106 TagMissing( 107 const CodeEntity & i_ce ); 108 static const DocText & 109 TagSee( 110 const CodeEntity & i_ce ); 111 static const DocText & 112 TagShort( 113 const CodeEntity & i_ce ); 114 static const DocText & 115 TagVersion( 116 const CodeEntity & i_ce ); 117 118 void Get_UnkownTags( 119 Dyn_CeIterator & o_result, 120 const CodeEntity & i_ce ); 121 122 bool IsDeprecated( 123 const CodeEntity & i_ce ); 124 bool IsIncomplete( 125 const CodeEntity & i_ce ); 126 bool IsInternal( 127 const CodeEntity & i_ce ); 128 bool IsNodoc( 129 const CodeEntity & i_ce ); 130 bool IsOptional( 131 const CodeEntity & i_ce ); 132 bool IsSuspicious( 133 const CodeEntity & i_ce ); 134 135 }; 136 137 138 } // namespace ifc_ce 139 140 141 } // namspace idl 142 } // namspace ary 143 144 #endif 145 146 147