LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
List of all members
Frame Service Referencepublished

represents the environment for a desktop component More...

import "Frame.idl";

Inheritance diagram for Frame:
XFrame2 XDispatchProvider XDispatchInformationProvider XDispatchProviderInterception XFramesSupplier XStatusIndicatorFactory XInterface XInterface XInterface XFrame XInterface XComponent XInterface

Additional Inherited Members

- Exported Interfaces inherited from XFrame2
interface XDispatchProvider
 provides access to dispatchers for the frame. More...
 
interface XDispatchInformationProvider
 provides information about supported commands More...
 
interface XDispatchProviderInterception
 supports interception mechanism for dispatched URLs More...
 
interface XFramesSupplier
 Provides access to sub frames within this frame, and via its 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. More...
 
interface com::sun::star::task::XStatusIndicatorFactory
 supplies access to com::sun::star::task::XStatusIndicator objects for the component within the frame to show progresses More...
 
- Public Member Functions inherited from XDispatchProvider
XDispatch queryDispatch ([in] com::sun::star::util::URL URL,[in] string TargetFrameName,[in] long SearchFlags)
 searches for an XDispatch for the specified URL within the specified target frame. More...
 
sequence< XDispatchqueryDispatches ([in] sequence< DispatchDescriptor > Requests)
 actually this method is redundant to XDispatchProvider::queryDispatch() to avoid multiple remote calls. More...
 
- Public Member Functions inherited from XDispatchInformationProvider
sequence< short > getSupportedCommandGroups ()
 returns all supported command groups. More...
 
sequence< DispatchInformationgetConfigurableDispatchInformation ([in] short CommandGroup)
 returns additional information about supported commands of a given command group. More...
 
- Public Member Functions inherited from XDispatchProviderInterception
void registerDispatchProviderInterceptor ([in] XDispatchProviderInterceptor Interceptor)
 registers an XDispatchProviderInterceptor, which will become the first interceptor in the chain of registered interceptors. More...
 
void releaseDispatchProviderInterceptor ([in] XDispatchProviderInterceptor Interceptor)
 removes an XDispatchProviderInterceptor which was previously registered More...
 
- Public Member Functions inherited from XFramesSupplier
XFrames getFrames ()
 provides access to this container and to all other XFramesSupplier which are available from this node of frame tree More...
 
XFrame getActiveFrame ()
 gets the current active frame of this container (not of any other available supplier) More...
 
void setActiveFrame ([in] XFrame Frame)
 is called on activation of a direct sub-frame. More...
 
- Public Member Functions inherited from XStatusIndicatorFactory
com::sun::star::task::XStatusIndicator createStatusIndicator ()
 create a new status indicator instance More...
 
- Public Attributes inherited from XFrame2
com::sun::star::container::XNameContainer UserDefinedAttributes
 contains user defined attributes. More...
 
string Title
 if possible it sets/gets the UI title on/from the frame container window More...
 
XDispatchRecorderSupplier DispatchRecorderSupplier
 provides access to the dispatch recorder of the frame More...
 
com::sun::star::uno::XInterface LayoutManager
 Provides access to the LayoutManager of the frame. More...
 

Detailed Description

represents the environment for a desktop component

Frames are the anchors for the office components and they are the component's link to the outside world. They create a skeleton for the whole office API infrastructure by building frame hierarchies. These hierarchies contains all currently loaded documents and make it possible to walk during these trees. A special service Desktop can(!) combine different of such trees to a global one which life time will be controlled by it.

See Also
Desktop
Developers Guide
OfficeDev - Creating Frames Manually - Frame Creation
OfficeDev - Frames - Linking Components and Windows

The documentation for this service was generated from the following file: