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

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