offapi/com/sun/star/image/ImageMapObject.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ImageMapObject.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_image_ImageMapObject_idl__
  31 #define __com_sun_star_image_ImageMapObject_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_XEventsSupplier_idl__
  38 #include <com/sun/star/document/XEventsSupplier.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module image {
  44
  45 //=============================================================================
  46
  47 /** this is a base service for objects inside a image maps.
  48     @see ImageMap
  49     @see ImageMapRectangleObject
  50     @see ImageMapCircleObject
  51     @see ImageMapPolygonObject
  52 */
  53 published service ImageMapObject
  54 {
  55     /** Interface to access the properties of this service. */
  56     interface ::com::sun::star::beans::XPropertySet;
  57
  58     /** This interface gives access to the events bound to
  59         this ImageMapObject.<p>
  60
  61         @see com::sun::star::document::Events
  62     */
  63     interface com::sun::star::document::XEventsSupplier;
  64
  65     /** This is the URL for this object */
  66     [property] string URL;
  67
  68     /** This is an optional description text for the link. */
  69     [property] string Description;
  70
  71     /** This is the target frame */
  72     [property] string Target;
  73
  74     /** Optionally, objects could be named. */
  75     [property] string Name;
  76
  77     /** If an object is not active, it is ignored when
  78         the user clicks on the ImageMap.
  79     */
  80     [property] boolean IsActive;
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif