xref: /aoo41x/main/offapi/com/sun/star/frame/Desktop.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_frame_Desktop_idl__
28#define __com_sun_star_frame_Desktop_idl__
29
30#ifndef __com_sun_star_frame_Frame_idl__
31#include <com/sun/star/frame/Frame.idl>
32#endif
33
34#ifndef __com_sun_star_frame_XDesktop_idl__
35#include <com/sun/star/frame/XDesktop.idl>
36#endif
37
38#ifndef __com_sun_star_frame_XComponentLoader_idl__
39#include <com/sun/star/frame/XComponentLoader.idl>
40#endif
41
42#ifndef __com_sun_star_document_XEventBroadcaster_idl__
43#include <com/sun/star/document/XEventBroadcaster.idl>
44#endif
45
46#ifndef __com_sun_star_beans_XPropertySet_idl__
47#include <com/sun/star/beans/XPropertySet.idl>
48#endif
49
50//=============================================================================
51
52 module com {  module sun {  module star {  module frame {
53
54//=============================================================================
55/** is the environment for components which can instantiate within frames
56
57    <p>
58    A desktop environment contains tasks with one or more frames
59    in which components can be loaded. The term "task" or naming a frame as a
60    "task frame" is not in any way related to any additional implemented
61    interfaces, it's  just because these frames use task windows.
62    </p>
63 */
64published service Desktop
65{
66    //-------------------------------------------------------------------------
67    /** make it possible to be the global root of different seperated frame trees
68
69        <p>
70        It's not a must for a frame (neither a frame tree) to be a part of this
71        global tree. But such outstanding frames won't be accessible by the normal
72        frame api.
73        </p>
74     */
75    service Frame;
76
77    //-------------------------------------------------------------------------
78    /** regulate life time of desktop environment and support high level
79        access to components of sub frame tree
80     */
81	interface XDesktop;
82
83    //-------------------------------------------------------------------------
84    /** supports simple api for loading components into the frame environment
85     */
86	interface XComponentLoader;
87
88    //-------------------------------------------------------------------------
89    /** @deprecated This interface is a documentation error. It was never thought to be supported
90                    by this service. Please use the service <type cope="com::sun::star::frame">GlobalEventBroadcaster</type>
91                    instead of this interface.
92     */
93    interface com::sun::star::document::XEventBroadcaster;
94};
95
96//=============================================================================
97
98}; }; }; };
99
100#endif
101