office-gobmx/udkapi/com/sun/star/beans/XMultiPropertyStates.idl
Noel Grandin 2a1b850b78 clean up all the UNO IDL module header guards
.. so I don't keep tripping over the bad ones during my UNO cleanup work.

(1) make them all use a similar syntax, makes it easier to run my automatic checker
(2) some of them were just cut'n'paste accidents waiting to happen
(3) remove unnecessary header guards in the __including__ file. That is very brittle.

Change-Id: I4e679c15161483ad93aeb316a25d6db6d97e9d4e
2012-12-21 09:12:07 +02:00

113 lines
4.5 KiB
Text

/* -*- 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_XMultiPropertyStates_idl__
#define __com_sun_star_beans_XMultiPropertyStates_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/PropertyState.idl>
#include <com/sun/star/beans/UnknownPropertyException.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>
#include <com/sun/star/beans/XPropertyStateChangeListener.idl>
module com { module sun { module star { module beans {
/** makes it possible to query information about the state of
one or more properties.
<p>The state of a property contains information about the source of
the value, e.g. the object itself, a default or a stylesheet.
For more information see <type>PropertyState</type>.
*/
published interface XMultiPropertyStates: com::sun::star::uno::XInterface
{
/** @returns
a sequence of the states of the properties which are specified
by their names.
<p>The order of the states is correlating to the order of the
given property names.
@param aPropertyName
specifies the names of the properties. All names must be unique.
This sequence must be alphabetically sorted.
*/
sequence<com::sun::star::beans::PropertyState> getPropertyStates(
[in] sequence<string> aPropertyName )
raises( com::sun::star::beans::UnknownPropertyException );
/** sets all properties to their default values.
<p>Each value depends on the implementation of this interface.
If it is a bound property, you must change the value before
the change events are fired. If it is a constrained property, you
must fire the vetoable event before you change the property value.
</p>
*/
void setAllPropertiesToDefault();
/** sets the specified properties to their default values.
<p>Each value depends on the implementation of this interface.
If it is a bound property, you must change the value before
the change events are fired. If it is a constrained property, you
must fire the vetoable event before you change the property value. </p>
@param aPropertyName
specifies the names of the properties. All names must be unique.
This sequence must be alphabetically sorted.
@throws UnknownPropertyException
if one of the properties does not exist.
*/
void setPropertiesToDefault( [in] sequence<string> aPropertyNames )
raises( com::sun::star::beans::UnknownPropertyException );
/** @returns
the default values of the propertes with the specified names.
<p>If no default exists, is not known, or is void,
then the return type at the corresponding position in the
sequence returned is <atom>void</atom>. </p>
@param aPropertyName
specifies the names of the properties. All names must be unique.
This sequence must be alphabetically sorted.
@throws UnknownPropertyException
if one of the propertes 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
<type scope="com::sun::star::lang">WrappedTargetException</type>.
*/
sequence<any> getPropertyDefaults(
[in] sequence<string> aPropertyNames )
raises( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */