Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: frame ::
interface XFrame2
  Base Interfaces
      XFrame2
      ┣ XDispatchProvider
      ┣ XDispatchInformationProvider
      ┣ XDispatchProviderInterception
      ┣ XFramesSupplier
      ┃ ┗ XFrame
      ┃    ┗ ::com::sun::star::lang::XComponent
      ┗ ::com::sun::star::task::XStatusIndicatorFactory
  XDispatchProvider | Description provides access to dispatchers for the frame. What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(), and how the returned dispatcher handles dispatches is completely implementation dependent (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to XDispatchProvider::queryDispatch(). Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags. Common special targets include: _blank is used to create a new frame when dispatching the URL. _default is used to recycle empty or create a new frame when dispatching the URL. _self forces the frame to dispatch the URL into itself. ("" means the same) _parent dispatches the URL into the parent frame. _top dispatches the URL into the top level frame, the frame where this is invoked belongs to. See also XDispatch, XFrame::findFrame()
  XDispatchInformationProvider | Description provides information about supported commands Since OOo 2.0
  XDispatchProviderInterception | Description supports interception mechanism for dispatched URLs Registered objects can intercept, suppress or reroute dispatched URLs. If they support another interface too (XInterceptorInfo) it's possible to perform it by directly calling of right interceptor without using list of all registered ones.
  XFramesSupplier | Description Provides access to sub frames within this frame, and via it's XFrame sub-interface: Allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component.
  ::com::sun::star::task::XStatusIndicatorFactory | Description supplies access to ::com::sun::star::task::XStatusIndicator objects for the component within the frame to show progresses
Since LibreOffice 4.1

Attributes' Summary
UserDefinedAttributes | contains user defined attributes.
Title | if possible it sets/gets the UI title on/from the frame container window
DispatchRecorderSupplier | provides access to the dispatch recorder of the frame
LayoutManager | Provides access to the LayoutManager of the frame. This is actually of type XLayoutManager, but this API is still experimental (unpublished).

Attributes' Details
UserDefinedAttributes
[ readonly ] ::com::sun::star::container::XNameContainer UserDefinedAttributes; Description contains user defined attributes.
Title
string Title; Description if possible it sets/gets the UI title on/from the frame container window It depends from the type of the frame container window. If it is a system task window all will be OK. Otherwise the title can't be set. Setting/getting of the pure value of this property must be possible in every case. Only showing on the UI can be fail.
DispatchRecorderSupplier
XDispatchRecorderSupplier DispatchRecorderSupplier; Description provides access to the dispatch recorder of the frame Such recorder can be used to record dispatch requests. The supplier contains a dispatch recorder and provide the functionality to use it for any dispatch object from outside which supports the interface XDispatch. A supplier is available only, if recording was enabled. That means: if someone wishes to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. If value of this property is NULL he must call XDispatch::dispatch() on the original dispatch object. If it's a valid value he must use the supplier by calling his method XDispatchRecorderSupplier::dispatchAndRecord() with the original dispatch object as argument. Note: It's not recommended to cache an already gotten supplier. Because there exist no possibility to check for enabled/disabled recording then. Since OOo 1.1.2
LayoutManager
::com::sun::star::uno::XInterface LayoutManager; Description Provides access to the LayoutManager of the frame. This is actually of type XLayoutManager, but this API is still experimental (unpublished).

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.