summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/Property.idl
blob: 365784427ce33f8a025d1785693fc99e4ddfc532 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_beans_Property_idl__
#define __com_sun_star_beans_Property_idl__

#include <com/sun/star/reflection/XIdlClass.idl>



module com {  module sun {  module star {  module beans {


/** This structure describes a property.


    <dl>There are three types of properties:
        <dt>- bound properties</dt>
        <dt>- constrained properties</dt>
        <dt>- free properties</dt>
    </dl>
 */
published struct Property
{
    /** specifies the name of the property.

        <p>The name is unique within an <type>XPropertySet</type>.
        Upper and lower case are distinguished.</p>
     */
    string Name;


    /** contains an implementation-specific handle for the property.

        <p>It may be -1 if the implementation has no handle. You can use
        this handle to get values from the <type>XFastPropertySet</type>.</p>
     */
    long Handle;


    /** contains an object that identifies the declared type for
        the property.

        <p>If the property has multiple types or the type is not
        known, <strong>but not an <atom>any</atom></strong>, then
        <const>void</const> must be returned.</p>
     */
    type Type;


    /** This field may contain zero or more constants of the
        <type>PropertyAttribute</type> constants group.
     */
    short Attributes;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */