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
  20
  21  module com {  module sun {  module star {  module task {
  22
  23
  24 /** Obtains human readable strings from an XInteractionRequest.
  25  */
  26 /* published */
  27 interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface
  28 {
  29
  30     /** Obtains a string containing a human readable message from an
  31         informational interaction request.
  32
  33         <p>An informational interaction request contains not more than one
  34         interaction continuation (user has no choice; request is just
  35         informational). The supplies continuation must either be a
  36         XInteractionAbort or XInteractionApprove
  37
  38         @param Request the interaction request for that the message shall
  39         be obtained.
  40
  41         @returns the message string or an empty
  42         com::sun::star::beans::Optional.
  43      */
  44     com::sun::star::beans::Optional< string >
  45         getStringFromInformationalRequest(
  46         [in] com::sun::star::task::XInteractionRequest Request );
  47
  48 };
  49
  50
  51 }; }; }; };
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */