Impressum Property.idl

/* -*- 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 .
 */



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


/** This structure describes a property.

    There are three types of properties:
    - bound properties
    - constrained properties
    - free properties

 */
published struct Property
{
    /** specifies the name of the property.

        <p>The name is unique within an XPropertySet.
        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 XFastPropertySet.</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 `any`</strong>, then
        void must be returned.</p>
     */
    type Type;


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

};


}; }; }; };

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