offapi/com/sun/star/ucb/XCommandEnvironment.idl

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