offapi/com/sun/star/frame/DispatchRecorder.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: DispatchRecorder.idl,v $
  10  * $Revision: 1.11 $
  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_frame_DispatchRecorder_idl__
  31 #define __com_sun_star_frame_DispatchRecorder_idl__
  32
  33 #ifndef __com_sun_star_frame_XDispatchRecorder_idl__
  34 #include <com/sun/star/frame/XDispatchRecorder.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XIndexReplace_idl__
  38 #include <com/sun/star/container/XIndexReplace.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module frame {
  44
  45 //=============================================================================
  46 /** provides functionality to record <member>XDispatch::dispatch()</member> requests
  47
  48     <p>
  49     It records all neccessary parameters of a call <member>XDispatch::dispatch()</member>
  50     and generate code which can be executed at later time to run same operations
  51     again. Which code will be generated depends from real implementation. So it's
  52     possible to generate e.g. Java/Basic or may Perl code.
  53     By using of a <type>DispatchRecorderSupplier</type>, which is available on
  54     a property of a <member>Frame::DispatchRecorderSupplier</member>, it's possible to change such code generation
  55     for further requests or disable it in general by setting this property to <NULL/>.
  56     </p>
  57
  58     @see DispatchRecorderSupplier
  59     @see Frame::RecorderSupplier
  60
  61     @since OOo 1.1.2
  62  */
  63 published service DispatchRecorder
  64 {
  65     //-------------------------------------------------------------------------
  66     /** provides the record functionality and access on the generated code
  67      */
  68     interface com::sun::star::frame::XDispatchRecorder;
  69     /** provides replacement capability of recorded statements
  70     */
  71     interface com::sun::star::container::XIndexReplace;
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif