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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DispatchRecorderSupplier.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_DispatchRecorderSupplier_idl__
  31 #define __com_sun_star_frame_DispatchRecorderSupplier_idl__
  32
  33 #ifndef __com_sun_star_frame_XDispatchRecorderSupplier_idl__
  34 #include <com/sun/star/frame/XDispatchRecorderSupplier.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module frame {
  40
  41 //=============================================================================
  42 /** provides a <type>DispatchRecorder</type>
  43
  44     <p>
  45     This supplier regulate macro recording of <member>XDispatch::dispatch()</member>
  46     calls. For that it capsulate a reference to a <type>DispatchRecorder</type>.
  47     Such recorder is used internaly and can be used externaly too.
  48     A supplier will be available on a <type>Frame</type> if recording was enabled,
  49     otherwise not. A frame supports a special property for that.
  50     This modular concept of recorder, supplier and frame makes it possible to
  51     implement local recording on one frame; global recording by using all currently
  52     opened frames or only some of them; and so on.
  53     </p>
  54
  55     @see DispatchRecorder
  56     @see Frame
  57     @since OOo 1.1.2
  58  */
  59 published service DispatchRecorderSupplier
  60 {
  61     //-------------------------------------------------------------------------
  62     /** provides access to a <type>DispatchRecorder</type> and helps on recording
  63      */
  64     interface com::sun::star::frame::XDispatchRecorderSupplier;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif