offapi/com/sun/star/frame/XRecordableDispatch.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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23 /** extends an existing XDispatch implementation with functionality
  24     for dispatch recording
  25
  26     <p>
  27     This interface can be implemented as an additional one beside an existing
  28     XDispatch one to provide record functionality of dispatches.
  29     Because it's an additional interface the status events are available there
  30     and not at this interface.
  31     </p>
  32
  33     <p>
  34     But normally this interface mustn't be used directly.
  35     If a dispatch object is well known and recording was enabled
  36     on a XDispatchRecorderSupplier it's possible to use method
  37     XDispatchRecorderSupplier::dispatchAndRecord() of it
  38     to make dispatch and recording automatically. The interface XRecordableDispatch
  39     is used transparently there.
  40     </p>
  41
  42     @code{.java}
  43         XDispatch xDispatcher = xFrame.queryDispatch(aURL,"",0);
  44         XRecordableDispatch xRecordable =
  45             (XRecordableDispatch)UnoRuntime.queryInterface(
  46                 XRecordableDispatch.class,
  47                 xDispatcher);
  48
  49         xDispatcher.addStatusListener(this,aURL);
  50
  51         if (xRecordable != null)
  52             xRecordable.dispatchAndRecord(aURL,lArguments,xRecorder);
  53         else
  54             xDispatcher.dispatch(aURL,lArguments);
  55         ...
  56         xDispatcher.removeStatusListener(this,aURL);
  57     @endcode
  58
  59     @see XDispatchRecorderSupplier
  60     @see XDispatch
  61
  62     @since OOo 1.1.2
  63  */
  64 published interface XRecordableDispatch: com::sun::star::uno::XInterface
  65 {
  66     /** dispatch and record it
  67
  68         @param URL
  69             full parsed URL which describe the feature which should be dispatched (executed)
  70
  71         @param Arguments
  72             optional arguments for this request
  73             (see com::sun::star::document::MediaDescriptor for details)
  74
  75         @param Recorder
  76             object which can be used to record the request
  77             (available on XDispatchRecorderSupplier::getDispatchRecorder())
  78      */
  79     void dispatchAndRecord(
  80         [in] com::sun::star::util::URL URL,
  81         [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
  82         [in] XDispatchRecorder Recorder);
  83 };
  84
  85
  86 }; }; }; };
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */