autodoc/inc/ary/idl/ik_ce.hxx

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