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