xref: /aoo42x/main/offapi/com/sun/star/frame/Desktop.idl (revision a893be29)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_Desktop_idl__
24#define __com_sun_star_frame_Desktop_idl__
25
26#ifndef __com_sun_star_frame_Frame_idl__
27#include <com/sun/star/frame/Frame.idl>
28#endif
29
30#ifndef __com_sun_star_frame_XDesktop_idl__
31#include <com/sun/star/frame/XDesktop.idl>
32#endif
33
34#ifndef __com_sun_star_frame_XComponentLoader_idl__
35#include <com/sun/star/frame/XComponentLoader.idl>
36#endif
37
38#ifndef __com_sun_star_document_XEventBroadcaster_idl__
39#include <com/sun/star/document/XEventBroadcaster.idl>
40#endif
41
42#ifndef __com_sun_star_beans_XPropertySet_idl__
43#include <com/sun/star/beans/XPropertySet.idl>
44#endif
45
46//=============================================================================
47
48 module com {  module sun {  module star {  module frame {
49
50//=============================================================================
51/** is the environment for components which can instantiate within frames
52
53    <p>
54    A desktop environment contains tasks with one or more frames
55    in which components can be loaded. The term "task" or naming a frame as a
56    "task frame" is not in any way related to any additional implemented
57    interfaces, it's  just because these frames use task windows.
58    </p>
59 */
60published service Desktop
61{
62    //-------------------------------------------------------------------------
63    /** make it possible to be the global root of different separated frame trees
64
65        <p>
66        It's not a must for a frame (neither a frame tree) to be a part of this
67        global tree. But such outstanding frames won't be accessible by the normal
68        frame api.
69        </p>
70     */
71    service Frame;
72
73    //-------------------------------------------------------------------------
74    /** regulate life time of desktop environment and support high level
75        access to components of sub frame tree
76     */
77	interface XDesktop;
78
79    //-------------------------------------------------------------------------
80    /** supports simple api for loading components into the frame environment
81     */
82	interface XComponentLoader;
83
84    //-------------------------------------------------------------------------
85    /** @deprecated This interface is a documentation error. It was never thought to be supported
86                    by this service. Please use the service <type cope="com::sun::star::frame">GlobalEventBroadcaster</type>
87                    instead of this interface.
88     */
89    interface com::sun::star::document::XEventBroadcaster;
90};
91
92//=============================================================================
93
94}; }; }; };
95
96#endif
97