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