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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_PropertyValue_idl__
  20 #define __com_sun_star_beans_PropertyValue_idl__
  21
  22 #include <com/sun/star/beans/Property.idl>
  23
  24 #include <com/sun/star/beans/PropertyState.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module beans {
  29
  30
  31 /** specifies a property value.
  32  */
  33 published struct PropertyValue
  34 {
  35     /** specifies the name of the property.
  36
  37         <p>The name is unique within a sequence of PropertyValues.
  38         Upper and lower case are distinguished.</p>
  39      */
  40     string Name;
  41
  42
  43     /** contains an implementation-specific handle for the property.
  44
  45         <p>It may be -1 if the implementation has no handle. If available
  46         it can be used for fast lookups.</p>
  47      */
  48     long Handle;
  49
  50
  51     /** contains the value of the property or `VOID`,
  52         if no value is available.
  53      */
  54     any Value;
  55
  56
  57     /** determines if the value comes from the object itself or from
  58         a default and if the value cannot be determined exactly.
  59      */
  60     com::sun::star::beans::PropertyState State;
  61
  62 };
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */