offapi/com/sun/star/document/Events.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: Events.idl,v $
  10  * $Revision: 1.8 $
  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_Events_idl__
  31 #define __com_sun_star_document_Events_idl__
  32
  33 #ifndef __com_sun_star_container_XNameReplace_idl__
  34 #include <com/sun/star/container/XNameReplace.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {   module sun {   module star {   module document {
  40
  41 //=============================================================================
  42 /** is a collection of all events supported by a document or content of a
  43     document
  44
  45     <p>
  46     Such Events will be broadcasted by a <type>XEventBroadcaster</type>
  47     to any <type>XEventListener</type> packed as <type>EventObject</type>s.
  48     </p>
  49  */
  50 published service Events
  51 {
  52     //-------------------------------------------------------------------------
  53     /** offers access to the list of <type>EventDescriptor</type>s
  54
  55         <p>
  56         The following events are usually available:
  57         <dl>
  58             <dt>OnAlphaCharInput</dt>
  59             <dt>OnClick</dt>
  60             <dt>OnCloseApp</dt>
  61             <dt>OnCopyTo</dt>
  62             <dt>OnCopyToDone</dt>
  63             <dt>OnError</dt>
  64             <dt>OnFocus</dt>
  65             <dt>OnInsertDone</dt>
  66             <dt>OnInsertStart</dt>
  67             <dt>OnLoad</dt>
  68             <dt>OnLoadCancel</dt>
  69             <dt>OnLoadDone</dt>
  70             <dt>OnLoadError</dt>
  71             <dt>OnLoadFinished</dt>
  72             <dt>OnMailMerge</dt>
  73             <dt>OnMailMergeFinished</dt>
  74             <dt>OnModifyChanged</dt>
  75             <dt>OnMouseOut</dt>
  76             <dt>OnMouseOver</dt>
  77             <dt>OnMove</dt>
  78             <dt>OnNew</dt>
  79             <dt>OnNewMail</dt>
  80             <dt>OnNonAlphaCharInput</dt>
  81             <dt>OnPageCountChange</dt>
  82             <dt>OnPrepareUnload</dt>
  83             <dt>OnPrepareViewClosing</dt>
  84             <dt>OnPrint</dt>
  85             <dt>OnResize</dt>
  86             <dt>OnSave</dt>
  87             <dt>OnSaveAs</dt>
  88             <dt>OnSaveAsDone</dt>
  89             <dt>OnSaveDone</dt>
  90             <dt>OnSaveFinished</dt>
  91             <dt>OnSelect</dt>
  92             <dt>OnStartApp</dt>
  93             <dt>OnToggleFullscreen</dt>
  94             <dt>OnUnfocus</dt>
  95             <dt>OnUnload</dt>
  96             <dt>OnViewCreated</dt>
  97             <dt>OnViewClosed</dt>
  98         </dl>
  99         </p>
 100         */
 101     interface com::sun::star::container::XNameReplace;
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif