offapi/com/sun/star/task/XInteractionRequestStringResolver.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: XInteractionRequestStringResolver.idl,v $
  10  * $Revision: 1.4 $
  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_task_XInteractionRequestStringResolver_idl__
  31 #define __com_sun_star_task_XInteractionRequestStringResolver_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_Optional_idl__
  38 #include <com/sun/star/beans/Optional.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_task_XInteractionRequest_idl__
  42 #include <com/sun/star/task/XInteractionRequest.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module task {
  48
  49 //=============================================================================
  50
  51 /** Obtains human readable strings from an <type>XInteractionRequest</type>.
  52  */
  53 /* published */
  54 interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** Obtains a string containing a human readable message from an
  59         informational interaction request.
  60
  61         <p>An informational interaction request contains not more than one
  62         interaction continuation (user has no choice; request is just
  63         informational). The supplies continuation must either be a
  64         <type>XInteractionAbort</type> or <type>XInteractionApprove</type>
  65
  66         @param Request the interaction request for that the message shall
  67         be obtained.
  68
  69         @returns the message string or an empty
  70         <type scope="::com::sun::star::beans">Optional</type>.
  71      */
  72     com::sun::star::beans::Optional< string >
  73         getStringFromInformationalRequest(
  74         [in] com::sun::star::task::XInteractionRequest Request );
  75
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 /*=============================================================================
  83
  84 =============================================================================*/
  85 #endif