offapi/com/sun/star/ucb/XInteractionHandlerSupplier.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: XInteractionHandlerSupplier.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_ucb_XInteractionHandlerSupplier_idl__
  31 #define __com_sun_star_ucb_XInteractionHandlerSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** This interface should be implemented by an internal
  44     <type>XCommandEnvironment</type> that can not supply an
  45     <type scope="com::sun::star::task">XInteractionHandler</type>, but instead
  46     wants interaction requests to be handled by other internal error handling
  47     mechanism.
  48 */
  49 published interface XInteractionHandlerSupplier: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52     /** Returns whether an
  53         <type scope="com::sun::star::task">XInteractionHandler</type> can be
  54         supplied.
  55
  56         @returns
  57         <TRUE/>, if an
  58         <type scope="com::sun::star::task">XInteractionHandler</type> can be
  59         supplied, <FALSE/> otherwise.
  60     */
  61     boolean hasInteractionHandler();
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 #endif