offapi/com/sun/star/frame/DispatchRecorder.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_DispatchRecorder_idl__
  20 #define __com_sun_star_frame_DispatchRecorder_idl__
  21
  22 #include <com/sun/star/frame/XDispatchRecorder.idl>
  23
  24
  25  module com {  module sun {  module star {  module frame {
  26
  27 /** provides functionality to record XDispatch::dispatch() requests
  28
  29     <p>
  30     It records all necessary parameters of a call XDispatch::dispatch()
  31     and generate code which can be executed at later time to run same operations
  32     again. Which code will be generated depends from real implementation. So it's
  33     possible to generate e.g. Java/Basic or may Perl code.
  34     By using of a DispatchRecorderSupplier, which is available on
  35     a property of a Frame::DispatchRecorderSupplier, it's possible to change such code generation
  36     for further requests or disable it in general by setting this property to `NULL`.
  37     </p>
  38
  39     @see DispatchRecorderSupplier
  40     @see Frame::RecorderSupplier
  41
  42     @since OOo 1.1.2
  43  */
  44 published service DispatchRecorder : XDispatchRecorder;
  45
  46
  47 }; }; }; };
  48
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */