offapi/com/sun/star/frame/XDispatchRecorder.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_XDispatchRecorder_idl__
  20 #define __com_sun_star_frame_XDispatchRecorder_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/util/URL.idl>
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25
  26
  27 module com {  module sun {  module star {  module frame {
  28
  29  published interface XFrame;
  30
  31 /** provides recording functionality of dispatches
  32
  33     <p>
  34     With such recorder it will be possible to record requests of type
  35     <type>XDispatch</type> by using additional interface
  36     <type>XRecordableDispatch</type>. The result of that will be a
  37     a script which can be used to start the dispatch at later time again.
  38     Such recorder objects are available on a <type>XDispatchRecorderSupplier</type>
  39     which is provided by the <type>Frame</type> service.
  40     </p>
  41
  42     @see Frame
  43     @see XDispatchRecorderSupplier
  44
  45     @since OOo 1.1.2
  46  */
  47 published interface XDispatchRecorder: com::sun::star::uno::XInterface
  48 {
  49     /** initializes the recorder by passing the frame for which all
  50         macro statements shall be recorded
  51
  52         @param Frame
  53             it includes the document on which such requests shall be recorded
  54     */
  55     void startRecording( [in] com::sun::star::frame::XFrame Frame );
  56
  57     /** stops the recording process
  58
  59         <p>
  60         Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>.
  61         </p>
  62
  63         @attention  The recorder uses this method to control the lifetime of its internal
  64                     used macro buffer. It will be cleared here. So the macro must be fetched
  65                     before endRecording() is called.
  66
  67         @see        getRecordedMacro()
  68     */
  69     void endRecording();
  70
  71     /** records a single dispatch call identified by its command URL
  72
  73         @param URL
  74             the full parsed command URL
  75
  76         @param Arguments
  77             optional arguments for the command URL
  78             <br>
  79             (see <type scope="com::sun::star::document">MediaDescriptor</type>
  80              for further information)
  81     */
  82     void recordDispatch(
  83         [in] com::sun::star::util::URL URL,
  84         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
  85
  86     /** records a single dispatch call identified by its command URL, but
  87         comments it out
  88
  89         <p>
  90         This way calls that failed on execution can be documented.
  91         </p>
  92
  93         @param URL
  94             the full parsed command URL
  95
  96         @param Arguments
  97             optional arguments for the command URL
  98             <br>
  99             (see <type scope="com::sun::star::document">MediaDescriptor</type>
 100              for further information)
 101     */
 102     void recordDispatchAsComment(
 103         [in] com::sun::star::util::URL URL,
 104         [in] sequence<com::sun::star::beans::PropertyValue> Arguments);
 105
 106     /** returns the recorded source code
 107
 108         <p>
 109         This method must be used before <member>endRecording()</member> is called!
 110         Otherwise the macro will be released.
 111         </p>
 112
 113         @returns
 114             the recorded data as a string which can be interpreted as a script
 115     */
 116     string getRecordedMacro();
 117 };
 118
 119
 120 }; }; }; };
 121
 122 #endif
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */