/************************************************************************* * * $RCSfile: XMultiPropertyStates.idl,v $ * * $Revision: 1.9 $ * * last change: $Author: mi $ $Date: 2002-12-10 10:31:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_beans_XMultiPropertyState_idl__ #define __com_sun_star_beans_XMultiPropertyState_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_beans_PropertyState_idl__ #include #endif #ifndef __com_sun_star_beans_UnknownPropertyException_idl__ #include #endif #ifndef __com_sun_star_lang_WrappedTargetException_idl__ #include #endif #ifndef __com_sun_star_beans_XPropertyStateChangeListener_idl__ #include #endif //============================================================================= module com { module sun { module star { module beans { //============================================================================= /** makes it possible to query information about the state of one or more properties.

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 PropertyState. */ interface XMultiPropertyStates: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** @returns a sequence of the states of the properties which are specified by their names.

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 getPropertyStates( [in] sequence aPropertyName ) raises( com::sun::star::beans::UnknownPropertyException ); //------------------------------------------------------------------------- /** sets all properties to their default values.

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.

*/ void setAllPropertiesToDefault(); //------------------------------------------------------------------------- /** sets the specified properties to their default values.

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.

@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 aPropertyNames ) raises( com::sun::star::beans::UnknownPropertyException ); //------------------------------------------------------------------------- /** @returns the default values of the propertes with the specified names.

If no default exists, is not known, or is void, then the return type at the corresponding position in the sequence returned is void.

@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 WrappedTargetException. */ sequence getPropertyDefaults( [in] sequence aPropertyNames ) raises( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ); }; //============================================================================= }; }; }; }; #endif