xref: /AOO41X/main/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_task_XInteractionRequestStringResolver_idl__
28#define __com_sun_star_task_XInteractionRequestStringResolver_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_beans_Optional_idl__
35#include <com/sun/star/beans/Optional.idl>
36#endif
37
38#ifndef __com_sun_star_task_XInteractionRequest_idl__
39#include <com/sun/star/task/XInteractionRequest.idl>
40#endif
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module task {
45
46//=============================================================================
47
48/** Obtains human readable strings from an <type>XInteractionRequest</type>.
49 */
50/* published */
51interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface
52{
53    //-------------------------------------------------------------------------
54
55    /** Obtains a string containing a human readable message from an
56        informational interaction request.
57
58        <p>An informational interaction request contains not more than one
59        interaction continuation (user has no choice; request is just
60        informational). The supplies continuation must either be a
61        <type>XInteractionAbort</type> or <type>XInteractionApprove</type>
62
63        @param Request the interaction request for that the message shall
64        be obtained.
65
66        @returns the message string or an empty
67        <type scope="::com::sun::star::beans">Optional</type>.
68     */
69    com::sun::star::beans::Optional< string >
70        getStringFromInformationalRequest(
71	    [in] com::sun::star::task::XInteractionRequest Request );
72
73};
74
75//=============================================================================
76
77}; }; }; };
78
79/*=============================================================================
80
81=============================================================================*/
82#endif
83