offapi/com/sun/star/frame/XRecordableDispatch.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: XRecordableDispatch.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_XRecordableDispatch_idl__
  31 #define __com_sun_star_frame_XRecordableDispatch_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XDispatchRecorder_idl__
  38 #include <com/sun/star/frame/XDispatchRecorder.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_URL_idl__
  42 #include <com/sun/star/util/URL.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module frame {
  48
  49 //=============================================================================
  50 /** extends an existing <type>XDispatch</type> implementation with functionality
  51     for dispatch recording
  52
  53     <p>
  54     This interface can be implemented as an additional one beside an existing
  55     <type>XDispatch</type> one to provide record functionality of dispatches.
  56     Because it's an additional interface the status events are available there
  57     and not at this interface.
  58     </p>
  59
  60     <p>
  61     But normaly this interface mustn't be used directly.
  62     If a dispatch object is well known and recording was enabled
  63     on a <type>XDispatchRecorderSupplier</type> it's possible to use method
  64     <member>XDispatchRecorderSupplier::dispatchAndRecord()</member> of it
  65     to make dispatch and recording automaticly. The interface XRecordableDispatch
  66     is used transparently there.
  67     </p>
  68
  69     @example
  70     <listing>
  71         <i>XDispatch</i> xDispatcher = xFrame.queryDispatch(aURL,"",0);
  72         <i>XRecordableDispatch</i> xRecordable = (<i>XRecordableDispatch</i>)UnoRuntime.queryInterface(
  73         &nbsp;&nbsp;XRecordableDispatch.class,
  74         &nbsp;&nbsp;xDispatcher);
  75
  76         xDispatcher.addStatusListener(this,aURL);
  77
  78         <b>if</b> (xRecordable!=<b>null</b>)
  79         &nbsp;&nbsp;xRecordable.dispatchAndRecord(aURL,lArguments,xRecorder);
  80         else
  81         &nbsp;&nbsp;xDispatcher.dispatch(aURL,lArguments);
  82         ...
  83         xDispatcher.removeStatusListener(this,aURL);
  84     </listing>
  85
  86     @see XDispatchRecorderSupplier
  87     @see XDispatch
  88
  89     @since OOo 1.1.2
  90  */
  91 published interface XRecordableDispatch: com::sun::star::uno::XInterface
  92 {
  93     //-------------------------------------------------------------------------
  94     /** dispatch and record it
  95
  96         @param URL
  97             full parsed URL wich describe the feature which should be dispatched (executed)
  98
  99         @param Arguments
 100             optional arguments for this request
 101             (see <type scope="com::sun::star::document">MediaDescriptor</type> for details)
 102
 103         @param Recorder
 104             object which can be used to record the request
 105             (available on <member>XDispatchRecorderSupplier::getDispatchRecorder()</member>)
 106      */
 107     [oneway] void dispatchAndRecord(
 108         [in] com::sun::star::util::URL URL,
 109         [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
 110         [in] XDispatchRecorder Recorder);
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 #endif