diff options
author | Mathias Bauer <mba@openoffice.org> | 2002-03-27 12:17:48 +0000 |
---|---|---|
committer | Mathias Bauer <mba@openoffice.org> | 2002-03-27 12:17:48 +0000 |
commit | 728e0c4d5cc5491524942aabf7db09e14286c0d0 (patch) | |
tree | f1414fb7b80baf62cbb1d6b5f599c2ad871eaa04 /offapi/com/sun/star/frame | |
parent | 9c04051b812657ec1d201a0e6df55901a0cf3cbd (diff) |
#98405#: new interface for a dispatch recorder
Diffstat (limited to 'offapi/com/sun/star/frame')
-rw-r--r-- | offapi/com/sun/star/frame/XDispatchRecorder.idl | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XDispatchRecorder.idl b/offapi/com/sun/star/frame/XDispatchRecorder.idl new file mode 100644 index 000000000..199815120 --- /dev/null +++ b/offapi/com/sun/star/frame/XDispatchRecorder.idl @@ -0,0 +1,130 @@ +/************************************************************************* + * + * $RCSfile: XDispatchRecorder.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mba $ $Date: 2002-03-27 13:17:48 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_frame_XDispatchRecorder_idl__ +#define __com_sun_star_frame_XDispatchRecorder_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_URL_idl__ +#include <com/sun/star/util/URL.idl> +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include <com/sun/star/beans/PropertyValue.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +interface XFrame; + +//============================================================================= +/** + @deprecated draft + */ +interface XDispatchRecorder: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** + initializes the recorder by passing the frame for which all + macro statements shall be recorded + */ + void startRecording( [in] com::sun::star::frame::XFrame aFrame ); + + //------------------------------------------------------------------------- + /** + records a single dispatch call identified by its command URL + */ + void recordDispatch( [in] com::sun::star::util::URL aURL, + [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); + + //------------------------------------------------------------------------- + /** + records a single dispatch call identified by its command URL, but + comments it out; this way calls that failed on execution can be + documented + */ + void recordDispatchAsComment( [in] com::sun::star::util::URL aURL, + [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); + + //------------------------------------------------------------------------- + /** + stops the recording process + */ + void endRecording(); + + //------------------------------------------------------------------------- + + /** + returns the recorded source code + the result of calling this method before calling endRecording is undefined + */ + string getRecordedMacro(); +}; + +//============================================================================= + +}; }; }; }; + +#endif |