offapi/com/sun/star/frame/XDispatchRecorder.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_XDispatchRecorder_idl__
  28 #define __com_sun_star_frame_XDispatchRecorder_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_URL_idl__
  35 #include <com/sun/star/util/URL.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_PropertyValue_idl__
  39 #include <com/sun/star/beans/PropertyValue.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module frame {
  45
  46  published interface XFrame;
  47
  48 //=============================================================================
  49 /** provides recording functionality of dispatches
  50
  51     <p>
  52     With such recorder it will be possible to record requests of type
  53     <type>XDispatch</type> by using additional interface
  54     <type>XRecordableDispatch</type>. The result of that will be a
  55     a script which can be used to start the dispatch at later time again.
  56     Such recorder objects are available on a <type>XDispatchRecorderSupplier</type>
  57     which is provided by the <type>Frame</type> service.
  58     </p>
  59
  60     @see Frame
  61     @see XDispatchRecorderSupplier
  62
  63     @since OOo 1.1.2
  64  */
  65 published interface XDispatchRecorder: com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68     /** initializes the recorder by passing the frame for which all
  69         macro statements shall be recorded
  70
  71         @param Frame
  72             it includes the document on which such requests shall be recorded
  73     */
  74     void startRecording( [in] com::sun::star::frame::XFrame Frame );
  75
  76         //-------------------------------------------------------------------------
  77     /** stops the recording process
  78
  79         <p>
  80         Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>.
  81         </p>
  82
  83         @attention  The recorder uses this method to control the lifetime of its internal
  84                     used macro buffer. It will be cleared here. So the macro must be fetched
  85                     before endRecording() is called.
  86
  87         @see        getRecordedMacro()
  88     */
  89     void endRecording();
  90
  91     //-------------------------------------------------------------------------
  92     /** records a single dispatch call identified by its command URL
  93
  94         @param URL
  95             the full parsed command URL
  96
  97         @param Arguments
  98             optional arguments for the command URL
  99             <br>
 100             (see <type scope="com::sun::star::document">MediaDescriptor</type>
 101              for further informations)
 102     */
 103     void recordDispatch(
 104         [in] com::sun::star::util::URL URL,
 105         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
 106
 107     //-------------------------------------------------------------------------
 108     /** records a single dispatch call identified by its command URL, but
 109         comments it out
 110
 111         <p>
 112         This way calls that failed on execution can be documented.
 113         </p>
 114
 115         @param URL
 116             the full parsed command URL
 117
 118         @param Arguments
 119             optional arguments for the command URL
 120             <br>
 121             (see <type scope="com::sun::star::document">MediaDescriptor</type>
 122              for further informations)
 123     */
 124     void recordDispatchAsComment(
 125         [in] com::sun::star::util::URL URL,
 126         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
 127
 128     //-------------------------------------------------------------------------
 129     /** returns the recorded source code
 130
 131         <p>
 132         This method must be used before <member>endRecording()</member> is called!
 133         Otherwhise the macro will be relased.
 134         </p>
 135
 136         @returns
 137             the recorded data as a string which can be interpreted as a script
 138     */
 139     string getRecordedMacro();
 140 };
 141
 142 //=============================================================================
 143
 144 }; }; }; };
 145
 146 #endif