udkapi/com/sun/star/beans/Property.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_Property_idl__
  20 #define __com_sun_star_beans_Property_idl__
  21
  22 #include <com/sun/star/reflection/XIdlClass.idl>
  23
  24
  25
  26 module com {  module sun {  module star {  module beans {
  27
  28
  29 /** This structure describes a property.
  30
  31     There are three types of properties:
  32     - bound properties
  33     - constrained properties
  34     - free properties
  35
  36  */
  37 published struct Property
  38 {
  39     /** specifies the name of the property.
  40
  41         <p>The name is unique within an XPropertySet.
  42         Upper and lower case are distinguished.</p>
  43      */
  44     string Name;
  45
  46
  47     /** contains an implementation-specific handle for the property.
  48
  49         <p>It may be -1 if the implementation has no handle. You can use
  50         this handle to get values from the XFastPropertySet.</p>
  51      */
  52     long Handle;
  53
  54
  55     /** contains an object that identifies the declared type for
  56         the property.
  57
  58         <p>If the property has multiple types or the type is not
  59         known, <strong>but not an `any`</strong>, then
  60         void must be returned.</p>
  61      */
  62     type Type;
  63
  64
  65     /** This field may contain zero or more constants of the
  66         PropertyAttribute constants group.
  67      */
  68     short Attributes;
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */