xref: /AOO41X/main/offapi/com/sun/star/ucb/CommandEnvironment.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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
28#ifndef _com_sun_star_ucb_CommandEnvironment_idl_
29#define _com_sun_star_ucb_CommandEnvironment_idl_
30
31#include <com/sun/star/ucb/XCommandEnvironment.idl>
32#include <com/sun/star/task/XInteractionHandler.idl>
33#include <com/sun/star/ucb/XProgressHandler.idl>
34
35module com { module sun { module star { module ucb {
36
37 /* This service implements an <type>XCommandEnvironment</type> that can be
38    initialized with any implementation of
39    <type scope="com::sun::star::task">XInteractionHandler</type> and
40    <type scope="com::sun::star::ucb">XProgressHandler</type>. The respective
41    get methods will simply return these handlers.
42
43    @since OOo 3.3
44 */
45 published service CommandEnvironment : ::com::sun::star::ucb::XCommandEnvironment
46 {
47    //-------------------------------------------------------------------------
48    /** Constructor.
49
50        @param InteractionHandler the interaction handler instance that will be
51                                  returned by this service' implementation of
52                                  <method>XCommandEnvironemt::getInteractionHandler</method>
53
54        @param ProgressHandler    the progress handler instance that will be
55                                  returned by this service' implementation of
56                                  <method>XCommandEnvironemt::getProgressHandler</method>
57    */
58     create( [in] com::sun::star::task::XInteractionHandler InteractionHandler,
59             [in] com::sun::star::ucb::XProgressHandler ProgressHandler );
60 };
61
62};};};};
63
64#endif
65