Quelle  XPropertySet.idl   Sprache: unbekannt

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


/** provides information about and access to the
    properties from an implementation.

    <p>There are three types of properties: </p>

    <ul>
        <li>bound properties </li>
        <li>constrained properties </li>
        <li>free properties </li>
    </ul>

    <p>You can listen to changes of bound properties with the
    XPropertyChangeListener and you can veto changes
    of constrained properties with the XVetoableChangeListener.  </p>

    <p>To implement inaccurate name access, you must support the
    interface XExactName. </p>

    @see com::sun::star::beans::XExactName
 */
published interface XPropertySet: com::sun::star::uno::XInterface
{

    /** @returns
            the XPropertySetInfo interface, which
            describes all properties of the object which supplies this
            interface.

        @returns
            NULL if the implementation cannot or will
            not provide information about the properties; otherwise the
            interface XPropertySetInfo is returned.
     */
    com::sun::star::beans::XPropertySetInfo getPropertySetInfo();


    /** sets the value of the property with the specified name.

        <p>If it is a bound property the value will be changed before
        the change event is fired.  If it is a constrained property
        a vetoable event is fired before the property value can be
        changed.  </p>

        @throws com::sun::star::beans::PropertyVetoException
            if the property is read-only or vetoable
            and one of the listeners throws this exception
            because of an unaccepted new value.
     */
    void setPropertyValue( [in] string aPropertyName,
             [in] any aValue )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::beans::PropertyVetoException,
                    com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::lang::WrappedTargetException );


    /** @returns
            the value of the property with the specified name.

        @param PropertyName
            This parameter specifies the name of the property.

        @throws UnknownPropertyException
            if the property does not exist.

        @throws com::sun::star::lang::WrappedTargetException
            if the implementation has an internal reason for the exception.
            In this case the original exception is wrapped into that
            com::sun::star::lang::WrappedTargetException.
     */
    any getPropertyValue( [in] string PropertyName )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** adds an XPropertyChangeListener to the specified property.

        <p>An empty name ("") registers the listener to all bound
        properties. If the property is not bound, the behavior is
        not specified.  </p>

        <p>It is suggested to allow multiple registration of the same listener,
        thus for each time a listener is added, it has to be removed.

        @see removePropertyChangeListener
     */
    void addPropertyChangeListener( [in] string aPropertyName,
             [in] com::sun::star::beans::XPropertyChangeListener xListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** removes an XPropertyChangeListener from
        the listener list.

        <p>It is a "noop" if the listener is not registered.  </p>

        <p>It is suggested to allow multiple registration of the same listener,
        thus for each time a listener is added, it has to be removed.

        @see addPropertyChangeListener
     */
    void removePropertyChangeListener( [in] string aPropertyName,
             [in] com::sun::star::beans::XPropertyChangeListener aListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** adds an XVetoableChangeListener to the specified
        property with the name PropertyName.

        <p>An empty name ("") registers the listener to all
        constrained properties. If the property is not constrained,
        the behavior is not specified.  </p>

        @see removeVetoableChangeListener
     */
    void addVetoableChangeListener( [in] string PropertyName,
             [in] com::sun::star::beans::XVetoableChangeListener aListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** removes an XVetoableChangeListener from the
        listener list.

        <p>It is a "noop" if the listener is not registered.  </p>

        @see addVetoableChangeListener
     */
    void removeVetoableChangeListener( [in] string PropertyName,
             [in] com::sun::star::beans::XVetoableChangeListener aListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );

};


}; }; }; };

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