offapi/com/sun/star/frame/DispatchRecorderSupplier.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_DispatchRecorderSupplier_idl__
  20 #define __com_sun_star_frame_DispatchRecorderSupplier_idl__
  21
  22 #include <com/sun/star/frame/XDispatchRecorderSupplier.idl>
  23
  24
  25  module com {  module sun {  module star {  module frame {
  26
  27 /** provides a DispatchRecorder
  28
  29     <p>
  30     This supplier regulate macro recording of XDispatch::dispatch()
  31     calls. For that it encapsulates a reference to a DispatchRecorder.
  32     Such recorder is used internally and can be used externally too.
  33     A supplier will be available on a Frame if recording was enabled,
  34     otherwise not. A frame supports a special property for that.
  35     This modular concept of recorder, supplier and frame makes it possible to
  36     implement local recording on one frame; global recording by using all currently
  37     opened frames or only some of them; and so on.
  38     </p>
  39
  40     @see DispatchRecorder
  41     @see Frame
  42     @since OOo 1.1.2
  43  */
  44 published service DispatchRecorderSupplier : XDispatchRecorderSupplier;
  45
  46
  47 }; }; }; };
  48
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */