autodoc/inc/ary/info/inftypes.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: inftypes.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_INFO_INFTYPES_HXX
  32 #define ARY_INFO_INFTYPES_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41 namespace ary
  42 {
  43 namespace info
  44 {
  45
  46
  47
  48
  49 typedef uintt GlobalTextId;
  50
  51
  52
  53 /** Because this enum is used as index list for displayed
  54     tag headlines, the items must neither be moved nor deleted.
  55     Only adding to the end is allowed. atid_MAX always has to exist
  56     and to be the last used value.
  57     Also assigning numbers to the values is forbidden.
  58 */
  59 enum E_AtTagId
  60 {
  61     atid_ATT = 0,
  62     atid_author,
  63     atid_change,
  64     atid_collab,
  65     atid_contact,
  66
  67     atid_copyright,
  68     atid_deprecated,
  69     atid_descr,
  70     atid_docdate,
  71     atid_derive,
  72
  73     atid_dyn,
  74     atid_instance,
  75     atid_interface,
  76     atid_invariant,
  77     atid_life,
  78
  79     atid_multi,
  80     atid_onerror,
  81     atid_persist,
  82     atid_postcond,
  83     atid_precond,
  84
  85     atid_resp,
  86     atid_return,
  87     atid_short,
  88     atid_todo,
  89     atid_version,
  90
  91     atid_MAX
  92 };
  93
  94 /** Because this enum is used as index list for displayed
  95     tag headlines, the items must neither be moved nor deleted.
  96     Only adding to the end is allowed. C_eAtTag_NrOfClasses always has to exist
  97     and to be the last used value.
  98     Also assigning other numbers to the values, than in this
  99     existing scheme, is forbidden.
 100 */
 101 enum E_AtTagClass
 102 {
 103     atc_std = 0,
 104
 105     atc_base = atid_MAX,
 106     atc_exception = atid_MAX + 1,
 107     atc_implements = atid_MAX + 2,
 108     atc_keyword = atid_MAX + 3,
 109     atc_parameter = atid_MAX + 4,
 110
 111     atc_see = atid_MAX + 5,
 112     atc_template = atid_MAX + 6,
 113     atc_label = atid_MAX + 7,
 114     atc_since = atid_MAX + 8,
 115     C_eAtTag_NrOfClasses
 116 };
 117
 118
 119
 120 }   // namespace info
 121 }   // namespace ary
 122
 123
 124 #endif
 125