offapi/com/sun/star/frame/XInterceptorInfo.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
  24 /** makes it possible to get information about a registered interceptor and is used by
  25     frame interceptor mechanism to perform interception.
  26
  27     <p>
  28     Frame can call right interceptor directly without calling all of registered ones.
  29     Use it as an additional interface to XDispatchProviderInterceptor.
  30     If any interceptor in list doesn't support this interface - these mechanism will be broken
  31     and normal list of master-slave interceptor objects will be used from top to the bottom.
  32     </p>
  33
  34     @see XDispatchProviderInterception
  35     @see XDispatchProviderInterceptor
  36  */
  37 published interface XInterceptorInfo: com::sun::star::uno::XInterface
  38 {
  39     /** returns the URL list for interception.
  40
  41         <p>
  42         Wildcards inside the URLs are allowed to register the interceptor for
  43         URLs too, which can have optional arguments (e.g. "..#.." or "..?..").
  44         </p>
  45
  46         @return
  47             a list of URLs which are handled by this interceptor
  48      */
  49     sequence< string > getInterceptedURLs();
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */