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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCommandEnvironment.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ucb_XCommandEnvironment_idl__
  32 #define __com_sun_star_ucb_XCommandEnvironment_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  39 #include <com/sun/star/task/XInteractionHandler.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_ucb_XProgressHandler_idl__
  43 #include <com/sun/star/ucb/XProgressHandler.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** defines the environment for a command.
  52
  53     @version  1.0
  54     @author   Kai Sommerfeld
  55     @see XCommandProcessor
  56 */
  57 published interface XCommandEnvironment : com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60     /** returns the command's interaction handler.
  61
  62         <p>If called multiple times, this method should consistently return the
  63         same value (to allow caching).
  64
  65         @returns
  66         an interaction handler
  67     */
  68     com::sun::star::task::XInteractionHandler getInteractionHandler();
  69
  70     //-------------------------------------------------------------------------
  71     /** returns the command's progress handler.
  72
  73         <p>If called multiple times, this method should consistently return the
  74         same value (to allow caching).
  75
  76         @returns
  77         a progress handler
  78     */
  79     com::sun::star::ucb::XProgressHandler getProgressHandler();
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif