offapi/com/sun/star/frame/DispatchProvider.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: DispatchProvider.idl,v $
  10  * $Revision: 1.7 $
  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_DispatchProvider_idl__
  31 #define __com_sun_star_frame_DispatchProvider_idl__
  32
  33 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  34 #include <com/sun/star/frame/XDispatchProvider.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__
  38 #include <com/sun/star/frame/XDispatchProviderInterception.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module frame {
  44
  45 //=============================================================================
  46 /** provides <type>XDispatch</type> objects for certain functions which
  47     are useful at the UI
  48
  49     <p>
  50     Such dispatch objects must be queried explicitly and used for
  51     queried purposes only. They can handle requests with guaranteed
  52     notifications (<type>XNotifyingDispatch</type>) or with possible
  53     (but not guaranteed) notifications (<type>XDispatch</type>).
  54     </p>
  55
  56     @see XNotifyingDispatch
  57     @see XDispatch
  58     @see XControlNotificationListener
  59  */
  60 published service DispatchProvider
  61 {
  62     //-------------------------------------------------------------------------
  63     /** provides handling of dispatches with defined result state
  64
  65         <p>
  66         Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type>
  67         and can be called for requests if result isn't neccessary for dispatch operation.
  68         </p>
  69
  70         @see XDispatch
  71      */
  72     interface XDispatchProvider;
  73
  74     //-------------------------------------------------------------------------
  75     /** provides dispatch interception
  76
  77         <p>
  78         It makes it possible to register an <type>XDispatchProvider</type> which
  79         intercepts all requests of <type>XDispatch</type> to this instance.
  80         </p>
  81      */
  82     [optional] interface XDispatchProviderInterception;
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif