1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchRecorder_idl__ 24cdf0e10cSrcweir#define __com_sun_star_frame_XDispatchRecorder_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_util_URL_idl__ 31cdf0e10cSrcweir#include <com/sun/star/util/URL.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 35cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweirmodule com { module sun { module star { module frame { 41cdf0e10cSrcweir 42cdf0e10cSrcweir published interface XFrame; 43cdf0e10cSrcweir 44cdf0e10cSrcweir//============================================================================= 45cdf0e10cSrcweir/** provides recording functionality of dispatches 46cdf0e10cSrcweir 47cdf0e10cSrcweir <p> 48cdf0e10cSrcweir With such recorder it will be possible to record requests of type 49cdf0e10cSrcweir <type>XDispatch</type> by using additional interface 50cdf0e10cSrcweir <type>XRecordableDispatch</type>. The result of that will be a 51cdf0e10cSrcweir a script which can be used to start the dispatch at later time again. 52cdf0e10cSrcweir Such recorder objects are available on a <type>XDispatchRecorderSupplier</type> 53cdf0e10cSrcweir which is provided by the <type>Frame</type> service. 54cdf0e10cSrcweir </p> 55cdf0e10cSrcweir 56cdf0e10cSrcweir @see Frame 57cdf0e10cSrcweir @see XDispatchRecorderSupplier 58cdf0e10cSrcweir 59cdf0e10cSrcweir @since OOo 1.1.2 60cdf0e10cSrcweir */ 61cdf0e10cSrcweirpublished interface XDispatchRecorder: com::sun::star::uno::XInterface 62cdf0e10cSrcweir{ 63cdf0e10cSrcweir //------------------------------------------------------------------------- 64cdf0e10cSrcweir /** initializes the recorder by passing the frame for which all 65cdf0e10cSrcweir macro statements shall be recorded 66cdf0e10cSrcweir 67cdf0e10cSrcweir @param Frame 68cdf0e10cSrcweir it includes the document on which such requests shall be recorded 69cdf0e10cSrcweir */ 70cdf0e10cSrcweir void startRecording( [in] com::sun::star::frame::XFrame Frame ); 71cdf0e10cSrcweir 72cdf0e10cSrcweir //------------------------------------------------------------------------- 73cdf0e10cSrcweir /** stops the recording process 74cdf0e10cSrcweir 75cdf0e10cSrcweir <p> 76cdf0e10cSrcweir Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>. 77cdf0e10cSrcweir </p> 78cdf0e10cSrcweir 79cdf0e10cSrcweir @attention The recorder uses this method to control the lifetime of its internal 80cdf0e10cSrcweir used macro buffer. It will be cleared here. So the macro must be fetched 81cdf0e10cSrcweir before endRecording() is called. 82cdf0e10cSrcweir 83cdf0e10cSrcweir @see getRecordedMacro() 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir void endRecording(); 86cdf0e10cSrcweir 87cdf0e10cSrcweir //------------------------------------------------------------------------- 88cdf0e10cSrcweir /** records a single dispatch call identified by its command URL 89cdf0e10cSrcweir 90cdf0e10cSrcweir @param URL 91cdf0e10cSrcweir the full parsed command URL 92cdf0e10cSrcweir 93cdf0e10cSrcweir @param Arguments 94cdf0e10cSrcweir optional arguments for the command URL 95cdf0e10cSrcweir <br> 96cdf0e10cSrcweir (see <type scope="com::sun::star::document">MediaDescriptor</type> 97cdf0e10cSrcweir for further informations) 98cdf0e10cSrcweir */ 99cdf0e10cSrcweir void recordDispatch( 100cdf0e10cSrcweir [in] com::sun::star::util::URL URL, 101cdf0e10cSrcweir [in] sequence<com::sun::star::beans::PropertyValue> Arguments); 102cdf0e10cSrcweir 103cdf0e10cSrcweir //------------------------------------------------------------------------- 104cdf0e10cSrcweir /** records a single dispatch call identified by its command URL, but 105cdf0e10cSrcweir comments it out 106cdf0e10cSrcweir 107cdf0e10cSrcweir <p> 108cdf0e10cSrcweir This way calls that failed on execution can be documented. 109cdf0e10cSrcweir </p> 110cdf0e10cSrcweir 111cdf0e10cSrcweir @param URL 112cdf0e10cSrcweir the full parsed command URL 113cdf0e10cSrcweir 114cdf0e10cSrcweir @param Arguments 115cdf0e10cSrcweir optional arguments for the command URL 116cdf0e10cSrcweir <br> 117cdf0e10cSrcweir (see <type scope="com::sun::star::document">MediaDescriptor</type> 118cdf0e10cSrcweir for further informations) 119cdf0e10cSrcweir */ 120cdf0e10cSrcweir void recordDispatchAsComment( 121cdf0e10cSrcweir [in] com::sun::star::util::URL URL, 122cdf0e10cSrcweir [in] sequence<com::sun::star::beans::PropertyValue> Arguments); 123cdf0e10cSrcweir 124cdf0e10cSrcweir //------------------------------------------------------------------------- 125cdf0e10cSrcweir /** returns the recorded source code 126cdf0e10cSrcweir 127cdf0e10cSrcweir <p> 128cdf0e10cSrcweir This method must be used before <member>endRecording()</member> is called! 129cdf0e10cSrcweir Otherwhise the macro will be relased. 130cdf0e10cSrcweir </p> 131cdf0e10cSrcweir 132cdf0e10cSrcweir @returns 133cdf0e10cSrcweir the recorded data as a string which can be interpreted as a script 134cdf0e10cSrcweir */ 135cdf0e10cSrcweir string getRecordedMacro(); 136cdf0e10cSrcweir}; 137cdf0e10cSrcweir 138cdf0e10cSrcweir//============================================================================= 139cdf0e10cSrcweir 140cdf0e10cSrcweir}; }; }; }; 141cdf0e10cSrcweir 142cdf0e10cSrcweir#endif 143