offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_XDispatchRecorderSupplier_idl__
  20 #define __com_sun_star_frame_XDispatchRecorderSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/frame/XDispatch.idl>
  24 #include <com/sun/star/frame/XDispatchRecorder.idl>
  25
  26
  27  module com {  module sun {  module star {  module frame {
  28
  29 /** provides access to the record mechanism of dispatches
  30
  31     <p>
  32     With a XDispatchRecorder it's possible to record calls
  33     of XDispatch::dispatch(). The recorded data (may a script)
  34     can be used to automate recorded dispatch and start it at later time again.
  35     This supplier provides access to the recorder and supports some functionality
  36     to work with the macro recording mechanism in an easy manner.
  37     </p>
  38
  39     @see XDispatchRecorder
  40     @since OOo 1.1.2
  41  */
  42 published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface
  43 {
  44     /** set a dispatch recorder on this supplier
  45
  46         <p>
  47         Setting of a new recorder make it possible to change recording mode.
  48         May there can exist different implementations of a recorder (e.g. to
  49         generate Java, Basic or other formats). Changing between local recording
  50         inside one Frame or global one by using more than ones can be
  51         forced too.
  52         </p>
  53
  54         @param Recorder
  55             the new recorder for this supplier
  56      */
  57     void setDispatchRecorder( [in] com::sun::star::frame::XDispatchRecorder Recorder );
  58
  59     /** provides access on the recorder of this supplier
  60
  61         <p>
  62         Returned recorder can be used to record dispatches manually or to get
  63         recorded data for further using e.g. saving. He is internally used too
  64         due to the method XDispatchRecorderSupplier::dispatchAndRecord().
  65         </p>
  66
  67         @returns
  68             the dispatch recorder of this supplier
  69
  70         @see XDispatchRecorder
  71      */
  72     com::sun::star::frame::XDispatchRecorder getDispatchRecorder();
  73
  74     /** dispatch given URL and record it if recording is enabled
  75
  76         <p>
  77         Parameter <var>Dispatcher</var> is used internally to make the dispatch.
  78         If recording isn't enabled it will be a normal XDispatch::dispatch()
  79         call. Otherwise follow algorithm is used:
  80         <ul>
  81             <li>If <var>Dispatcher</var> doesn't support the interface
  82                 XRecordableDispatch a normal dispatch() call
  83                 will be made and depend from the result state of that
  84                 the request will be recorded. In this case it's possible
  85                 to record the incoming parameter (<var>URL</var> and
  86                 <var>Arguments</var>) only. Parameters of internal processes
  87                 can't be recorded then and will be lost.
  88             </li>
  89             <li>If <var>Dispatcher</var> support the interface
  90                 XRecordableDispatch it will be used
  91                 to dispatch and record all necessary parameters of
  92                 the whole process.
  93             </li>
  94         </ul>
  95         </p>
  96
  97         @see XRecordableDispatch
  98      */
  99     void dispatchAndRecord(
 100         [in] com::sun::star::util::URL URL,
 101         [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
 102         [in] XDispatch Dispatcher);
 103 };
 104
 105
 106 }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */