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
28#ifndef __com_sun_star_configuration_backend_InteractionHandler_idl__
29#define __com_sun_star_configuration_backend_InteractionHandler_idl__
30
31module com { module sun { module star {
32    module lang { published interface XInitialization; };
33    module task { published interface XInteractionHandler; };
34}; }; };
35
36module com { module sun { module star { module configuration { module backend {
37
38//============================================================================
39/** An interaction request handler that lets the user handle a number of well
40    known requests via GUI dialogs.
41
42    <P>The well known requests handled by this service include
43    <UL>
44        <LI><type>MergeRecoveryRequest</type>*</LI>
45    </UL>
46    The requests marked with an asterisk are only handled if (a) their
47    continuations match certain restrictions (see below), and (b) the
48    necessary resource strings are available (this can be exploited by
49    applications that carry only a subset of all resource files with
50    them).</P>
51
52    <P>The continuation restrictions are as follows:  Let <VAR>C</VAR> be the
53    subset of the provided continuations that are of type
54    <type scope="com::sun::star::task">XInteractionApprove</type>,
55    <type scope="com::sun::star::task">XInteractionDisapprove</type>,
56    <type scope="com::sun::star::task">XInteractionRetry</type>, or
57    <type scope="com::sun::star::task">XInteractionAbort</type> (or of a
58    derived type).  All other continuations are ignored for these requests.
59    The request is only handled if the set <VAR>C</VAR> is any of the
60    following:
61    <UL>
62        <LI>Abort</LI>
63        <LI>Retry, Abort</LI>
64        <LI>Approve</LI>
65        <LI>Approve, Abort</LI>
66        <LI>Approve, Disapprove</LI>
67        <LI>Approve, Disapprove, Abort</LI>
68    </UL></P>
69
70    @since OOo 2.0
71
72    @see com::sun::star::task::InteractionHandler
73 */
74published service InteractionHandler
75{
76    //------------------------------------------------------------------------
77    /** Handle an interaction request.
78     */
79    interface com::sun::star::task::XInteractionHandler;
80
81    //------------------------------------------------------------------------
82    /** Initialize the interaction handler.
83
84        <P>The arguments must be a sequence of
85        <type scope="com::sun::star::beans">PropertyValue</type>s.  The
86        currently supported properties are:
87        <UL>
88            <LI><code>"Parent"</code> of type
89            <type scope="com::sun::star::awt">XWindow</type> denotes the
90            parent window for any GUI dialogs the interaction handler pops up;
91            it is strongly recommended that this property is supplied;</LI>
92            <LI><code>"Context"</code> of type <atom>string</atom> is a
93            textual description of the current context (used, e.g., as a first
94            line of text in error boxes); this property is optional.</LI>
95        </UL></P>
96     */
97    interface com::sun::star::lang::XInitialization;
98};
99
100}; }; }; }; };
101
102#endif
103