offapi/com/sun/star/document/EventDescriptor.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: EventDescriptor.idl,v $
  10  * $Revision: 1.7 $
  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_document_EventDescriptor_idl__
  31 #define __com_sun_star_document_EventDescriptor_idl__
  32
  33 //=============================================================================
  34
  35 module com {   module sun {   module star {   module document {
  36
  37 //=============================================================================
  38 /** specifies an event binding for a document or a document content
  39
  40     @see Events
  41     @see XEventsSupplier
  42  */
  43 published service EventDescriptor
  44 {
  45     //-------------------------------------------------------------------------
  46     /** specifies the type of the event handler
  47
  48         <p>
  49         Usually this is one of the following:
  50         <ul>
  51             <li>"None"</li>
  52             <li>"StarBasic"</li>
  53             <li>"JavaScript"</li>
  54             <li>"Presentation"</li>
  55         </ul>
  56         This list is extensible.
  57         </p>
  58      */
  59     [property] string EventType;
  60
  61     //-------------------------------------------------------------------------
  62     /** specifies the script source code
  63      */
  64     [property] string Script;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif