xref: /aoo41x/main/offapi/com/sun/star/ucb/CommandEnvironment.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef _com_sun_star_ucb_CommandEnvironment_idl_
#define _com_sun_star_ucb_CommandEnvironment_idl_

#include <com/sun/star/ucb/XCommandEnvironment.idl>
#include <com/sun/star/task/XInteractionHandler.idl>
#include <com/sun/star/ucb/XProgressHandler.idl>

module com { module sun { module star { module ucb {

 /* This service implements an <type>XCommandEnvironment</type> that can be
    initialized with any implementation of
    <type scope="com::sun::star::task">XInteractionHandler</type> and
    <type scope="com::sun::star::ucb">XProgressHandler</type>. The respective
    get methods will simply return these handlers.

    @since OOo 3.3
 */
 published service CommandEnvironment : ::com::sun::star::ucb::XCommandEnvironment
 {
    //-------------------------------------------------------------------------
    /** Constructor.

        @param InteractionHandler the interaction handler instance that will be
                                  returned by this service' implementation of
                                  <method>XCommandEnvironemt::getInteractionHandler</method>

        @param ProgressHandler    the progress handler instance that will be
                                  returned by this service' implementation of
                                  <method>XCommandEnvironemt::getProgressHandler</method>
    */
     create( [in] com::sun::star::task::XInteractionHandler InteractionHandler,
             [in] com::sun::star::ucb::XProgressHandler ProgressHandler );
 };

};};};};

#endif