summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/DispatchRecorder.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/DispatchRecorder.idl')
-rw-r--r--offapi/com/sun/star/frame/DispatchRecorder.idl107
1 files changed, 107 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/DispatchRecorder.idl b/offapi/com/sun/star/frame/DispatchRecorder.idl
new file mode 100644
index 000000000..81f3ce68e
--- /dev/null
+++ b/offapi/com/sun/star/frame/DispatchRecorder.idl
@@ -0,0 +1,107 @@
+/*************************************************************************
+ *
+ * $RCSfile: DispatchRecorder.idl,v $
+ *
+ * $Revision: 1.5 $
+ *
+ * last change: $Author: hr $ $Date: 2003-03-26 13:54:26 $
+ *
+ * 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_DispatchRecorder_idl__
+#define __com_sun_star_frame_DispatchRecorder_idl__
+
+#ifndef __com_sun_star_frame_XDispatchRecorder_idl__
+#include <com/sun/star/frame/XDispatchRecorder.idl>
+#endif
+
+#ifndef __com_sun_star_container_XIndexReplace_idl__
+#include <com/sun/star/container/XIndexReplace.idl>
+#endif
+
+//=============================================================================
+
+ module com { module sun { module star { module frame {
+
+//=============================================================================
+/** provides functionality to record <member>XDispatch::dispatch()</member> requests
+
+ <p>
+ It records all neccessary parameters of a call <member>XDispatch::dispatch()</member>
+ and generate code which can be executed at later time to run same operations
+ again. Which code will be generated depends from real implementation. So it's
+ possible to generate e.g. Java/Basic or may Perl code.
+ By using of a <type>DispatchRecorderSupplier</type>, which is available on
+ a property of a <member>Frame::RecorderSupplier</member>, it's possible to change such code generation
+ for further requests or disable it in general by setting this property to <NULL/>.
+ </p>
+
+ @see DispatchRecorderSupplier
+ @see Frame::RecorderSupplier
+ */
+service DispatchRecorder
+{
+ //-------------------------------------------------------------------------
+ /** provides the record functionality and access on the generated code
+ */
+ interface com::sun::star::frame::XDispatchRecorder;
+ /** provides replacement capability of recorded statements
+ */
+ interface com::sun::star::container::XIndexReplace;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif