offapi/com/sun/star/frame/XDesktop2.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   @since LibreOffice 4.1
  25 */
  26 published interface XDesktop2
  27 {
  28     /** provides access to dispatchers for the frame.
  29
  30         <p>
  31         What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(),
  32         and how the returned dispatcher handles dispatches is completely implementation dependent
  33         (though of course the restrictions of XDispatchProvider must be met).
  34         Frame implementations may (optionally) support special targets in the call to
  35         XDispatchProvider::queryDispatch().
  36         Such special targets are passed as target frame name. They may, in addition,
  37         require special frame search flags (see FrameSearchFlag), or,
  38         in opposite, limit the set of allowed flags.<br>
  39         Common special targets include:
  40         <ul>
  41                         <li><b>_blank</b><br> is used to create a new frame when dispatching the URL.</li>
  42             <li><b>_default</b><br> is used to recycle empty or create a new frame when dispatching the URL.</li>
  43             <li><b>_self</b><br> forces the frame to dispatch the URL into itself. ("" means the same)</li>
  44                         <li><b>_parent</b><br> dispatches the URL into the parent frame.</li>
  45                         <li><b>_top</b><br> dispatches the URL into the top level frame, the frame where this is invoked belongs to.</li>
  46         </ul>
  47         </p>
  48
  49         @see XDispatch
  50         @see XFrame::findFrame()
  51     */
  52     interface XDispatchProvider;
  53
  54     /** supports interception mechanism for dispatched URLs
  55
  56         <p>
  57         Registered objects can intercept, suppress or reroute dispatched URLs.
  58         If they support another interface too (XInterceptorInfo)
  59         it's possible to perform it by directly calling of right interceptor without
  60         using list of all registered ones.
  61         </p>
  62      */
  63     interface XDispatchProviderInterception;
  64
  65     /** provides access to sub frames within this frame
  66      */
  67     interface XFramesSupplier;
  68
  69     /** regulate life time of desktop environment and support high level
  70         access to components of sub frame tree
  71      */
  72     interface XDesktop;
  73
  74     /** supports simple API for loading components into the frame environment
  75      */
  76     interface XComponentLoader;
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */