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