xref: /trunk/main/offapi/com/sun/star/ucb/XCommandEnvironment.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XCommandEnvironment_idl__
25cdf0e10cSrcweir#define __com_sun_star_ucb_XCommandEnvironment_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_task_XInteractionHandler_idl__
32cdf0e10cSrcweir#include <com/sun/star/task/XInteractionHandler.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XProgressHandler_idl__
36cdf0e10cSrcweir#include <com/sun/star/ucb/XProgressHandler.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir/** defines the environment for a command.
45cdf0e10cSrcweir
46cdf0e10cSrcweir    @version  1.0
47cdf0e10cSrcweir    @author   Kai Sommerfeld
48cdf0e10cSrcweir    @see XCommandProcessor
49cdf0e10cSrcweir*/
50cdf0e10cSrcweirpublished interface XCommandEnvironment : com::sun::star::uno::XInterface
51cdf0e10cSrcweir{
52cdf0e10cSrcweir    //-------------------------------------------------------------------------
53cdf0e10cSrcweir    /** returns the command's interaction handler.
54cdf0e10cSrcweir
55cdf0e10cSrcweir        <p>If called multiple times, this method should consistently return the
56cdf0e10cSrcweir        same value (to allow caching).
57cdf0e10cSrcweir
58cdf0e10cSrcweir        @returns
59cdf0e10cSrcweir        an interaction handler
60cdf0e10cSrcweir    */
61cdf0e10cSrcweir    com::sun::star::task::XInteractionHandler getInteractionHandler();
62cdf0e10cSrcweir
63cdf0e10cSrcweir    //-------------------------------------------------------------------------
64cdf0e10cSrcweir    /** returns the command's progress handler.
65cdf0e10cSrcweir
66cdf0e10cSrcweir        <p>If called multiple times, this method should consistently return the
67cdf0e10cSrcweir        same value (to allow caching).
68cdf0e10cSrcweir
69cdf0e10cSrcweir        @returns
70cdf0e10cSrcweir        a progress handler
71cdf0e10cSrcweir    */
72cdf0e10cSrcweir    com::sun::star::ucb::XProgressHandler getProgressHandler();
73cdf0e10cSrcweir};
74cdf0e10cSrcweir
75cdf0e10cSrcweir//=============================================================================
76cdf0e10cSrcweir
77cdf0e10cSrcweir}; }; }; };
78cdf0e10cSrcweir
79cdf0e10cSrcweir#endif
80