xref: /trunk/main/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl (revision 408a4873)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_beans_PropertyStateChangeEvent_idl__
#define __com_sun_star_beans_PropertyStateChangeEvent_idl__

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif

#ifndef __com_sun_star_beans_PropertyState_idl__
#include <com/sun/star/beans/PropertyState.idl>
#endif


//=============================================================================

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

//=============================================================================

/** is delivered whenever the state of a "bound" property is changed.

	<p>It is sent as an argument to the method of
	<type>XPropertyStateChangeListener</type>.  </p>

	<p>Normally these events are accompanied by the name, and the old
	and new values of the changed property.  </p>

	<p>Void values may be provided for the old and new values if their
	true values are not known. </p>
 */
published struct PropertyStateChangeEvent: com::sun::star::lang::EventObject
{
	//-------------------------------------------------------------------------

	/** specifies the name of the property which changes its value.

		<p>This name identifies the property uniquely within an
		<type>XPropertySet</type>. Upper and lower case are distinguished.</p>
	 */
	string PropertyName;

	//-------------------------------------------------------------------------

	/** contains the implementation 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>
		interface.</p>
	 */
	long PropertyHandle;

	//-------------------------------------------------------------------------

	/** contains the old value of the property.
	 */
	com::sun::star::beans::PropertyState OldValue;

	//-------------------------------------------------------------------------

	/** contains the new value of the property.
	 */
	com::sun::star::beans::PropertyState NewValue;

};

//=============================================================================

}; }; }; };

#endif