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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23 /** provides access to the record mechanism of dispatches
  24
  25     <p>
  26     With a XDispatchRecorder it's possible to record calls
  27     of XDispatch::dispatch(). The recorded data (may a script)
  28     can be used to automate recorded dispatch and start it at later time again.
  29     This supplier provides access to the recorder and supports some functionality
  30     to work with the macro recording mechanism in an easy manner.
  31     </p>
  32
  33     @see XDispatchRecorder
  34     @since OOo 1.1.2
  35  */
  36 published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface
  37 {
  38     /** set a dispatch recorder on this supplier
  39
  40         <p>
  41         Setting of a new recorder make it possible to change recording mode.
  42         May there can exist different implementations of a recorder (e.g. to
  43         generate Java, Basic or other formats). Changing between local recording
  44         inside one Frame or global one by using more than ones can be
  45         forced too.
  46         </p>
  47
  48         @param Recorder
  49             the new recorder for this supplier
  50      */
  51     void setDispatchRecorder( [in] com::sun::star::frame::XDispatchRecorder Recorder );
  52
  53     /** provides access on the recorder of this supplier
  54
  55         <p>
  56         Returned recorder can be used to record dispatches manually or to get
  57         recorded data for further using e.g. saving. He is internally used too
  58         due to the method XDispatchRecorderSupplier::dispatchAndRecord().
  59         </p>
  60
  61         @returns
  62             the dispatch recorder of this supplier
  63
  64         @see XDispatchRecorder
  65      */
  66     com::sun::star::frame::XDispatchRecorder getDispatchRecorder();
  67
  68     /** dispatch given URL and record it if recording is enabled
  69
  70         <p>
  71         Parameter <var>Dispatcher</var> is used internally to make the dispatch.
  72         If recording isn't enabled it will be a normal XDispatch::dispatch()
  73         call. Otherwise follow algorithm is used:
  74         <ul>
  75             <li>If <var>Dispatcher</var> doesn't support the interface
  76                 XRecordableDispatch a normal dispatch() call
  77                 will be made and depend from the result state of that
  78                 the request will be recorded. In this case it's possible
  79                 to record the incoming parameter (<var>URL</var> and
  80                 <var>Arguments</var>) only. Parameters of internal processes
  81                 can't be recorded then and will be lost.
  82             </li>
  83             <li>If <var>Dispatcher</var> support the interface
  84                 XRecordableDispatch it will be used
  85                 to dispatch and record all necessary parameters of
  86                 the whole process.
  87             </li>
  88         </ul>
  89         </p>
  90
  91         @see XRecordableDispatch
  92      */
  93     void dispatchAndRecord(
  94         [in] com::sun::star::util::URL URL,
  95         [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
  96         [in] XDispatch Dispatcher);
  97 };
  98
  99
 100 }; }; }; };
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */