offapi/com/sun/star/task/XInteractionRequestStringResolver.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_task_XInteractionRequestStringResolver_idl__
  20 #define __com_sun_star_task_XInteractionRequestStringResolver_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/Optional.idl>
  25
  26 #include <com/sun/star/task/XInteractionRequest.idl>
  27
  28
  29  module com {  module sun {  module star {  module task {
  30
  31
  32 /** Obtains human readable strings from an XInteractionRequest.
  33  */
  34 /* published */
  35 interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface
  36 {
  37
  38     /** Obtains a string containing a human readable message from an
  39         informational interaction request.
  40
  41         <p>An informational interaction request contains not more than one
  42         interaction continuation (user has no choice; request is just
  43         informational). The supplies continuation must either be a
  44         XInteractionAbort or XInteractionApprove
  45
  46         @param Request the interaction request for that the message shall
  47         be obtained.
  48
  49         @returns the message string or an empty
  50         com::sun::star::beans::Optional.
  51      */
  52     com::sun::star::beans::Optional< string >
  53         getStringFromInformationalRequest(
  54         [in] com::sun::star::task::XInteractionRequest Request );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */