offapi/com/sun/star/frame/XInterceptorInfo.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: XInterceptorInfo.idl,v $
  10  * $Revision: 1.10 $
  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_XInterceptorInfo_idl__
  31 #define __com_sun_star_frame_XInterceptorInfo_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module frame {
  40
  41 //=============================================================================
  42
  43 /** makes it possible to get information about a registered interceptor and is used by
  44     frame interceptor mechanism to perform interception.
  45
  46     <p>
  47     Frame can call right interceptor directly without calling all of registered ones.
  48     Use it as an additional interface to <type>XDispatchProviderInterceptor</type>.
  49     If any interceptor in list doesn't support this interface - these mechanism will be broken
  50     and normal list of master-slave interceptor objects will be used from top to the bottom.
  51     </p>
  52
  53     @see XDispatchProviderInterception
  54     @see XDispatchProviderInterceptor
  55  */
  56 published interface XInterceptorInfo: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59     /** returns the URL list for interception.
  60
  61         <p>
  62         Wildcards inside the URL's are allowed to register the interceptor for
  63         URL's too, which can have optional arguments (e.g. "..#.." or "..?..").
  64         </p>
  65
  66         @return
  67             a list of URL's wich are handled by this interceptor
  68      */
  69     sequence< string > getInterceptedURLs();
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif