offapi/com/sun/star/configuration/backend/NodeAttribute.idl

   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: NodeAttribute.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_configuration_backend_NodeAttribute_idl__
  31 #define __com_sun_star_configuration_backend_NodeAttribute_idl__
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module configuration { module backend {
  36
  37 //=============================================================================
  38
  39 /** These values are used to specify the behavior of a node or property
  40     in a layer.
  41
  42     <p> The values were chosen so they can be combined with values from
  43         <type>SchemaAttribute</type>
  44     </p>
  45
  46     @see com::sun::star::configuration::backend::SchemaAttribute
  47         During merging the values may be combined with static attributes
  48         from the schema.
  49
  50     @since OOo 1.1.2
  51  */
  52 published constants NodeAttribute
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** indicates that a node or property may not be changed or overridden
  57         in subsequent layers
  58      */
  59     const short FINALIZED = 256;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** indicates that a set item may not be removed or replaced
  64         in subsequent layers.
  65      */
  66     const short MANDATORY = 512;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** indicates that a node or property may not be changed
  71         in this or subsequent layer.
  72      */
  73     const short READONLY = 1024;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** indicates that contents shall be fused.
  78
  79         <p>Used in <member>XLayerHandler::addOrReplaceNode</member>,
  80         <member>XLayerHandler::addOrReplaceNodeFromTemplate</member>,
  81         <member>XUpdateHandler::addOrReplaceNode</member>, and
  82         <member>XUpdateHandler::addOrReplaceNodeFromTemplate</member>.</p>
  83
  84         @since OOo 2.0.3
  85      */
  86     const short FUSE = 2048;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** can be used to mask the node attributes from merged attributes
  91      */
  92     const short MASK = 32512; // 0xFF00, changed to 0x7F00 because only 3 bits
  93                               // are masked and fixing a bug in idlc
  94
  95     //-------------------------------------------------------------------------
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; }; };
 101
 102 //=============================================================================
 103
 104 #endif