1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchRecorder_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_frame_XDispatchRecorder_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_util_URL_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/util/URL.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir//============================================================================= 43*cdf0e10cSrcweir 44*cdf0e10cSrcweirmodule com { module sun { module star { module frame { 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir published interface XFrame; 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir//============================================================================= 49*cdf0e10cSrcweir/** provides recording functionality of dispatches 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir <p> 52*cdf0e10cSrcweir With such recorder it will be possible to record requests of type 53*cdf0e10cSrcweir <type>XDispatch</type> by using additional interface 54*cdf0e10cSrcweir <type>XRecordableDispatch</type>. The result of that will be a 55*cdf0e10cSrcweir a script which can be used to start the dispatch at later time again. 56*cdf0e10cSrcweir Such recorder objects are available on a <type>XDispatchRecorderSupplier</type> 57*cdf0e10cSrcweir which is provided by the <type>Frame</type> service. 58*cdf0e10cSrcweir </p> 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir @see Frame 61*cdf0e10cSrcweir @see XDispatchRecorderSupplier 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir @since OOo 1.1.2 64*cdf0e10cSrcweir */ 65*cdf0e10cSrcweirpublished interface XDispatchRecorder: com::sun::star::uno::XInterface 66*cdf0e10cSrcweir{ 67*cdf0e10cSrcweir //------------------------------------------------------------------------- 68*cdf0e10cSrcweir /** initializes the recorder by passing the frame for which all 69*cdf0e10cSrcweir macro statements shall be recorded 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir @param Frame 72*cdf0e10cSrcweir it includes the document on which such requests shall be recorded 73*cdf0e10cSrcweir */ 74*cdf0e10cSrcweir void startRecording( [in] com::sun::star::frame::XFrame Frame ); 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir //------------------------------------------------------------------------- 77*cdf0e10cSrcweir /** stops the recording process 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir <p> 80*cdf0e10cSrcweir Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>. 81*cdf0e10cSrcweir </p> 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir @attention The recorder uses this method to control the lifetime of its internal 84*cdf0e10cSrcweir used macro buffer. It will be cleared here. So the macro must be fetched 85*cdf0e10cSrcweir before endRecording() is called. 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @see getRecordedMacro() 88*cdf0e10cSrcweir */ 89*cdf0e10cSrcweir void endRecording(); 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir //------------------------------------------------------------------------- 92*cdf0e10cSrcweir /** records a single dispatch call identified by its command URL 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir @param URL 95*cdf0e10cSrcweir the full parsed command URL 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir @param Arguments 98*cdf0e10cSrcweir optional arguments for the command URL 99*cdf0e10cSrcweir <br> 100*cdf0e10cSrcweir (see <type scope="com::sun::star::document">MediaDescriptor</type> 101*cdf0e10cSrcweir for further informations) 102*cdf0e10cSrcweir */ 103*cdf0e10cSrcweir void recordDispatch( 104*cdf0e10cSrcweir [in] com::sun::star::util::URL URL, 105*cdf0e10cSrcweir [in] sequence<com::sun::star::beans::PropertyValue> Arguments); 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir //------------------------------------------------------------------------- 108*cdf0e10cSrcweir /** records a single dispatch call identified by its command URL, but 109*cdf0e10cSrcweir comments it out 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir <p> 112*cdf0e10cSrcweir This way calls that failed on execution can be documented. 113*cdf0e10cSrcweir </p> 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir @param URL 116*cdf0e10cSrcweir the full parsed command URL 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir @param Arguments 119*cdf0e10cSrcweir optional arguments for the command URL 120*cdf0e10cSrcweir <br> 121*cdf0e10cSrcweir (see <type scope="com::sun::star::document">MediaDescriptor</type> 122*cdf0e10cSrcweir for further informations) 123*cdf0e10cSrcweir */ 124*cdf0e10cSrcweir void recordDispatchAsComment( 125*cdf0e10cSrcweir [in] com::sun::star::util::URL URL, 126*cdf0e10cSrcweir [in] sequence<com::sun::star::beans::PropertyValue> Arguments); 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir //------------------------------------------------------------------------- 129*cdf0e10cSrcweir /** returns the recorded source code 130*cdf0e10cSrcweir 131*cdf0e10cSrcweir <p> 132*cdf0e10cSrcweir This method must be used before <member>endRecording()</member> is called! 133*cdf0e10cSrcweir Otherwhise the macro will be relased. 134*cdf0e10cSrcweir </p> 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir @returns 137*cdf0e10cSrcweir the recorded data as a string which can be interpreted as a script 138*cdf0e10cSrcweir */ 139*cdf0e10cSrcweir string getRecordedMacro(); 140*cdf0e10cSrcweir}; 141*cdf0e10cSrcweir 142*cdf0e10cSrcweir//============================================================================= 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir}; }; }; }; 145*cdf0e10cSrcweir 146*cdf0e10cSrcweir#endif 147