udkapi/com/sun/star/beans/PropertyValue.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: PropertyValue.idl,v $
  10  * $Revision: 1.10 $
  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_beans_PropertyValue_idl__
  31 #define __com_sun_star_beans_PropertyValue_idl__
  32
  33 #ifndef __com_sun_star_beans_Property_idl__
  34 #include <com/sun/star/beans/Property.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyState_idl__
  38 #include <com/sun/star/beans/PropertyState.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module beans {
  45
  46 //=============================================================================
  47
  48 /** specifies a property value.
  49  */
  50 published struct PropertyValue
  51 {
  52     /** specifies the name of the property.
  53
  54         <p>The name is unique within a sequence of <type>PropertyValue</type>s.
  55         Upper and lower case are distinguished.</p>
  56      */
  57     string Name;
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** contains an implementation-specific handle for the property.
  62
  63         <p>It may be -1 if the implementation has no handle. If available
  64         it can be used for fast lookups.</p>
  65      */
  66     long Handle;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** contains the value of the property or <void/>,
  71         if no value is available.
  72      */
  73     any Value;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** determines if the value comes from the object itself or from
  78         a default and if the value cannot be determined exactly.
  79      */
  80     com::sun::star::beans::PropertyState State;
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif