offapi/com/sun/star/frame/XFrame2.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 XFrame2
  27 {
  28     /** contains user defined attributes.
  29
  30         @see com::sun::star::xml::AttributeContainer
  31      */
  32     [attribute, readonly] com::sun::star::container::XNameContainer UserDefinedAttributes;
  33
  34     /** provides access to dispatchers for the frame.
  35
  36         <p>
  37         What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(),
  38         and how the returned dispatcher handles dispatches is completely implementation dependent
  39         (though of course the restrictions of XDispatchProvider must be met).
  40         Frame implementations may (optionally) support special targets in the call to
  41         XDispatchProvider::queryDispatch().
  42         Such special targets are passed as target frame name. They may, in addition,
  43         require special frame search flags (see FrameSearchFlag), or,
  44         in opposite, limit the set of allowed flags.<br>
  45         Common special targets include:
  46         <ul>
  47                         <li><b>_blank</b><br> is used to create a new frame when dispatching the URL.</li>
  48             <li><b>_default</b><br> is used to recycle empty or create a new frame when dispatching the URL.</li>
  49             <li><b>_self</b><br> forces the frame to dispatch the URL into itself. ("" means the same)</li>
  50                         <li><b>_parent</b><br> dispatches the URL into the parent frame.</li>
  51                         <li><b>_top</b><br> dispatches the URL into the top level frame, the frame where this is invoked belongs to.</li>
  52         </ul>
  53         </p>
  54
  55         @see XDispatch
  56         @see XFrame::findFrame()
  57     */
  58     interface XDispatchProvider;
  59
  60     /** provides information about supported commands
  61
  62         @since OOo 2.0
  63     */
  64     interface XDispatchInformationProvider;
  65
  66     /** supports interception mechanism for dispatched URLs
  67
  68         <p>
  69         Registered objects can intercept, suppress or reroute dispatched URLs.
  70         If they support another interface too (XInterceptorInfo)
  71         it's possible to perform it by directly calling of right interceptor without
  72         using list of all registered ones.
  73         </p>
  74      */
  75     interface XDispatchProviderInterception;
  76
  77     /** Provides access to sub frames within this frame,
  78         and via its XFrame sub-interface: Allows the component to be loaded and accessed
  79         within the frame; it is the main connection to the
  80         environment of the component.
  81      */
  82     interface XFramesSupplier; // -> XFrame
  83
  84     /** supplies access to com::sun::star::task::XStatusIndicator objects
  85         for the component within the frame to show progresses
  86      */
  87     interface com::sun::star::task::XStatusIndicatorFactory;
  88
  89     /** if possible it sets/gets the UI title on/from the frame container window
  90
  91         <p>
  92         It depends from the type of the frame container window. If it is a system
  93         task window all will be OK. Otherwise the title can't be set.
  94         Setting/getting of the pure value of this property must be possible in every
  95         case. Only showing on the UI can be fail.
  96         </p>
  97      */
  98     [attribute] string Title;
  99
 100     /** provides access to the dispatch recorder of the frame
 101
 102         <p>
 103         Such recorder can be used to record dispatch requests.
 104         The supplier contains a dispatch recorder and provide the functionality
 105         to use it for any dispatch object from outside which supports the interface
 106         XDispatch. A supplier is available only, if recording was enabled.
 107         That means: if someone wishes to enable recoding on a frame he must set
 108         a supplier with a recorder object inside of it. Every user of dispatches
 109         has to check then if such supplier is available at this frame property.
 110         If value of this property is `NULL` he must call XDispatch::dispatch()
 111         on the original dispatch object. If it's a valid value he must use the supplier
 112         by calling his method XDispatchRecorderSupplier::dispatchAndRecord()
 113         with the original dispatch object as argument.
 114         </p>
 115
 116         <p>
 117         Note:<br>
 118         It's not recommended to cache an already gotten supplier. Because there exist
 119         no possibility to check for enabled/disabled recording then.
 120         </p>
 121
 122     @since OOo 1.1.2
 123      */
 124     [attribute] XDispatchRecorderSupplier DispatchRecorderSupplier;
 125
 126     /** Provides access to the LayoutManager of the frame.
 127         This is actually of type XLayoutManager, but this API is still experimental (unpublished).
 128     */
 129     [attribute] com::sun::star::uno::XInterface LayoutManager;
 130 };
 131
 132
 133 }; }; }; };
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */