1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_configuration_backend_InteractionHandler_idl__
25#define __com_sun_star_configuration_backend_InteractionHandler_idl__
26
27module com { module sun { module star {
28    module lang { published interface XInitialization; };
29    module task { published interface XInteractionHandler; };
30}; }; };
31
32module com { module sun { module star { module configuration { module backend {
33
34//============================================================================
35/** An interaction request handler that lets the user handle a number of well
36    known requests via GUI dialogs.
37
38    <P>The well known requests handled by this service include
39    <UL>
40        <LI><type>MergeRecoveryRequest</type>*</LI>
41    </UL>
42    The requests marked with an asterisk are only handled if (a) their
43    continuations match certain restrictions (see below), and (b) the
44    necessary resource strings are available (this can be exploited by
45    applications that carry only a subset of all resource files with
46    them).</P>
47
48    <P>The continuation restrictions are as follows:  Let <VAR>C</VAR> be the
49    subset of the provided continuations that are of type
50    <type scope="com::sun::star::task">XInteractionApprove</type>,
51    <type scope="com::sun::star::task">XInteractionDisapprove</type>,
52    <type scope="com::sun::star::task">XInteractionRetry</type>, or
53    <type scope="com::sun::star::task">XInteractionAbort</type> (or of a
54    derived type).  All other continuations are ignored for these requests.
55    The request is only handled if the set <VAR>C</VAR> is any of the
56    following:
57    <UL>
58        <LI>Abort</LI>
59        <LI>Retry, Abort</LI>
60        <LI>Approve</LI>
61        <LI>Approve, Abort</LI>
62        <LI>Approve, Disapprove</LI>
63        <LI>Approve, Disapprove, Abort</LI>
64    </UL></P>
65
66    @since OOo 2.0
67
68    @see com::sun::star::task::InteractionHandler
69 */
70published service InteractionHandler
71{
72    //------------------------------------------------------------------------
73    /** Handle an interaction request.
74     */
75    interface com::sun::star::task::XInteractionHandler;
76
77    //------------------------------------------------------------------------
78    /** Initialize the interaction handler.
79
80        <P>The arguments must be a sequence of
81        <type scope="com::sun::star::beans">PropertyValue</type>s.  The
82        currently supported properties are:
83        <UL>
84            <LI><code>"Parent"</code> of type
85            <type scope="com::sun::star::awt">XWindow</type> denotes the
86            parent window for any GUI dialogs the interaction handler pops up;
87            it is strongly recommended that this property is supplied;</LI>
88            <LI><code>"Context"</code> of type <atom>string</atom> is a
89            textual description of the current context (used, e.g., as a first
90            line of text in error boxes); this property is optional.</LI>
91        </UL></P>
92     */
93    interface com::sun::star::lang::XInitialization;
94};
95
96}; }; }; }; };
97
98#endif
99