udkapi/com/sun/star/beans/PropertyValue.idl

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