offapi/com/sun/star/frame/XInterceptorInfo.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_XInterceptorInfo_idl__
  28 #define __com_sun_star_frame_XInterceptorInfo_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module frame {
  37
  38 //=============================================================================
  39
  40 /** makes it possible to get information about a registered interceptor and is used by
  41     frame interceptor mechanism to perform interception.
  42
  43     <p>
  44     Frame can call right interceptor directly without calling all of registered ones.
  45     Use it as an additional interface to <type>XDispatchProviderInterceptor</type>.
  46     If any interceptor in list doesn't support this interface - these mechanism will be broken
  47     and normal list of master-slave interceptor objects will be used from top to the bottom.
  48     </p>
  49
  50     @see XDispatchProviderInterception
  51     @see XDispatchProviderInterceptor
  52  */
  53 published interface XInterceptorInfo: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /** returns the URL list for interception.
  57
  58         <p>
  59         Wildcards inside the URL's are allowed to register the interceptor for
  60         URL's too, which can have optional arguments (e.g. "..#.." or "..?..").
  61         </p>
  62
  63         @return
  64             a list of URL's wich are handled by this interceptor
  65      */
  66     sequence< string > getInterceptedURLs();
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif