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_Controller_idl__
28#define __com_sun_star_frame_Controller_idl__
29
30#ifndef __com_sun_star_frame_XController_idl__
31#include <com/sun/star/frame/XController.idl>
32#endif
33
34#ifndef __com_sun_star_frame_XDispatchProvider_idl__
35#include <com/sun/star/frame/XDispatchProvider.idl>
36#endif
37
38#ifndef __com_sun_star_awt_XWindow_idl__
39#include <com/sun/star/awt/XWindow.idl>
40#endif
41
42#ifndef __com_sun_star_ui_XContextMenuInterception_idl__
43#include <com/sun/star/ui/XContextMenuInterception.idl>
44#endif
45
46#ifndef __com_sun_star_awt_XUserInputInterception_idl__
47#include <com/sun/star/awt/XUserInputInterception.idl>
48#endif
49
50#ifndef __com_sun_star_view_XSelectionSupplier_idl__
51#include <com/sun/star/view/XSelectionSupplier.idl>
52#endif
53
54#ifndef __com_sun_star_datatransfer_XTransferableSupplier_idl__
55#include <com/sun/star/datatransfer/XTransferableSupplier.idl>
56#endif
57
58//=============================================================================
59
60 module com {  module sun {  module star {  module frame {
61
62//=============================================================================
63/** is an abstract service for a component which offers a deeper integration of
64    desktop components than a <type scope="com::sun::star::awt">XWindow</type>
65    can offer
66
67    <p>
68    Such components can be loaded into a <type>Frame</type> inside a <type>Desktop</type>
69    environment. A controller is a richer component then a pure window, but full featured
70    components need a <type>XModel</type> interface too.
71    <br>
72    (see service <type scope="com::sun::star::document">OfficeDocument</type> for further information)
73    <p>
74
75    @see com::sun::star::document::OfficeDocument
76 */
77published service Controller
78{
79    //-------------------------------------------------------------------------
80    /** with this interface, components viewed in a <type>Frame</type> can serve
81        events (by supplying dispatches)
82     */
83    interface XController;
84
85    //-------------------------------------------------------------------------
86    /** for certain functions which are useful at the UI
87
88        <p>
89        Mostly used by the <type>Frame</type> service, which contains this
90        controller object. There will be an interception mechanism for dispatches
91        available too.
92        </p>
93
94        @see XDispatch
95        @see XDispatchProviderInterception
96     */
97    interface XDispatchProvider;
98
99    //-------------------------------------------------------------------------
100    /** this interface enables the controller to get interceptors registered that
101        change context menue or prevent them from beeing executed
102
103        <p>
104        Don't mix it with <type>XDispatchProviderInterception</type> which
105        intercept calls of <member>XDispatch::dispatch()</member>.
106        </p>
107     */
108    [optional] interface com::sun::star::ui::XContextMenuInterception;
109
110    //-------------------------------------------------------------------------
111    /** makes it possible to intercept keyboard and mouse input.
112     */
113    [optional] interface com::sun::star::awt::XUserInputInterception;
114
115    //-------------------------------------------------------------------------
116    /** makes it possible to access and change the selection in a view
117     */
118    [optional] interface com::sun::star::view::XSelectionSupplier;
119
120    //-------------------------------------------------------------------------
121    /** makes it possible to work with clipboard data
122     */
123    [optional] interface com::sun::star::datatransfer::XTransferableSupplier;
124};
125
126//=============================================================================
127
128}; }; }; };
129
130#endif
131