xref: /aoo41x/main/offapi/com/sun/star/image/ImageMapObject.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_image_ImageMapObject_idl__
#define __com_sun_star_image_ImageMapObject_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_document_XEventsSupplier_idl__
#include <com/sun/star/document/XEventsSupplier.idl>
#endif

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

 module com {  module sun {  module star {  module image {

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

/** this is a base service for objects inside a image maps.
	@see ImageMap
	@see ImageMapRectangleObject
	@see ImageMapCircleObject
	@see ImageMapPolygonObject
*/
published service ImageMapObject
{
	/** Interface to access the properties of this service. */
	interface ::com::sun::star::beans::XPropertySet;

	/** This interface gives access to the events bound to
		this ImageMapObject.<p>

		@see com::sun::star::document::Events
	*/
	interface com::sun::star::document::XEventsSupplier;

	/** This is the URL for this object */
	[property] string URL;

	/** This is an optional description text for the link. */
	[property] string Description;

	/** This is the target frame */
	[property] string Target;

	/** Optionally, objects could be named. */
	[property] string Name;

	/** If an object is not active, it is ignored when
		the user clicks on the ImageMap.
	*/
	[property] boolean IsActive;
};

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

}; }; }; };

#endif