offapi/com/sun/star/configuration/backend/InteractionHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: InteractionHandler.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_configuration_backend_InteractionHandler_idl__
  32 #define __com_sun_star_configuration_backend_InteractionHandler_idl__
  33
  34 module com { module sun { module star {
  35     module lang { published interface XInitialization; };
  36     module task { published interface XInteractionHandler; };
  37 }; }; };
  38
  39 module com { module sun { module star { module configuration { module backend {
  40
  41 //============================================================================
  42 /** An interaction request handler that lets the user handle a number of well
  43     known requests via GUI dialogs.
  44
  45     <P>The well known requests handled by this service include
  46     <UL>
  47         <LI><type>MergeRecoveryRequest</type>*</LI>
  48     </UL>
  49     The requests marked with an asterisk are only handled if (a) their
  50     continuations match certain restrictions (see below), and (b) the
  51     necessary resource strings are available (this can be exploited by
  52     applications that carry only a subset of all resource files with
  53     them).</P>
  54
  55     <P>The continuation restrictions are as follows:  Let <VAR>C</VAR> be the
  56     subset of the provided continuations that are of type
  57     <type scope="com::sun::star::task">XInteractionApprove</type>,
  58     <type scope="com::sun::star::task">XInteractionDisapprove</type>,
  59     <type scope="com::sun::star::task">XInteractionRetry</type>, or
  60     <type scope="com::sun::star::task">XInteractionAbort</type> (or of a
  61     derived type).  All other continuations are ignored for these requests.
  62     The request is only handled if the set <VAR>C</VAR> is any of the
  63     following:
  64     <UL>
  65         <LI>Abort</LI>
  66         <LI>Retry, Abort</LI>
  67         <LI>Approve</LI>
  68         <LI>Approve, Abort</LI>
  69         <LI>Approve, Disapprove</LI>
  70         <LI>Approve, Disapprove, Abort</LI>
  71     </UL></P>
  72
  73     @since OOo 2.0.0
  74
  75     @see com::sun::star::task::InteractionHandler
  76  */
  77 published service InteractionHandler
  78 {
  79     //------------------------------------------------------------------------
  80     /** Handle an interaction request.
  81      */
  82     interface com::sun::star::task::XInteractionHandler;
  83
  84     //------------------------------------------------------------------------
  85     /** Initialize the interaction handler.
  86
  87         <P>The arguments must be a sequence of
  88         <type scope="com::sun::star::beans">PropertyValue</type>s.  The
  89         currently supported properties are:
  90         <UL>
  91             <LI><code>"Parent"</code> of type
  92             <type scope="com::sun::star::awt">XWindow</type> denotes the
  93             parent window for any GUI dialogs the interaction handler pops up;
  94             it is strongly recommended that this property is supplied;</LI>
  95             <LI><code>"Context"</code> of type <atom>string</atom> is a
  96             textual description of the current context (used, e.g., as a first
  97             line of text in error boxes); this property is optional.</LI>
  98         </UL></P>
  99      */
 100     interface com::sun::star::lang::XInitialization;
 101 };
 102
 103 }; }; }; }; };
 104
 105 #endif