offapi/com/sun/star/frame/XNotifyingDispatch.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_XNotifyingDispatch_idl__
  20 #define __com_sun_star_frame_XNotifyingDispatch_idl__
  21
  22 #include <com/sun/star/frame/XDispatch.idl>
  23 #include <com/sun/star/frame/XDispatchResultListener.idl>
  24
  25 module com {  module sun {  module star {  module frame {
  26
  27 /** dispatch with guaranteed notify (instead of XDispatch)
  28
  29     @see XDispatch
  30     @see XStatusListener
  31  */
  32 published interface XNotifyingDispatch: XDispatch
  33 {
  34     /** Do the same like XDispatch::dispatch() but notifies
  35         listener in every case. Should be used if result must be known.
  36
  37         @param URL
  38             full parsed URL describes the feature which should be dispatched (executed)
  39
  40         @param Arguments
  41             optional arguments for this request
  42             (see com::sun::star::document::MediaDescriptor)
  43
  44         @param Listener
  45             optional listener for guaranteed notifications of this request
  46     */
  47     void dispatchWithNotification(
  48         [in] com::sun::star::util::URL URL,
  49         [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
  50         [in] XDispatchResultListener Listener);
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */