xref: /AOO41X/main/offapi/com/sun/star/ucb/XCommandEnvironment.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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
24#ifndef __com_sun_star_ucb_XCommandEnvironment_idl__
25#define __com_sun_star_ucb_XCommandEnvironment_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_task_XInteractionHandler_idl__
32#include <com/sun/star/task/XInteractionHandler.idl>
33#endif
34
35#ifndef __com_sun_star_ucb_XProgressHandler_idl__
36#include <com/sun/star/ucb/XProgressHandler.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module ucb {
42
43//=============================================================================
44/** defines the environment for a command.
45
46    @version  1.0
47    @author   Kai Sommerfeld
48    @see XCommandProcessor
49*/
50published interface XCommandEnvironment : com::sun::star::uno::XInterface
51{
52    //-------------------------------------------------------------------------
53    /** returns the command's interaction handler.
54
55        <p>If called multiple times, this method should consistently return the
56        same value (to allow caching).
57
58        @returns
59        an interaction handler
60    */
61    com::sun::star::task::XInteractionHandler getInteractionHandler();
62
63    //-------------------------------------------------------------------------
64    /** returns the command's progress handler.
65
66        <p>If called multiple times, this method should consistently return the
67        same value (to allow caching).
68
69        @returns
70        a progress handler
71    */
72    com::sun::star::ucb::XProgressHandler getProgressHandler();
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80