offapi/com/sun/star/frame/XSessionManagerClient.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: XSessionManagerClient.idl,v $
  10  * $Revision: 1.4 $
  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 #ifndef __com_sun_star_frame_XSessionManagerClient_idl__
  31 #define __com_sun_star_frame_XSessionManagerClient_idl__
  32
  33 #ifndef __com_sun_star_frame_XSessionManagerListener_idl__
  34 #include <com/sun/star/frame/XSessionManagerListener.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module frame {
  40
  41 //=============================================================================
  42 /** Connect to a session manager to get information about pending
  43     desktop shutdown
  44
  45  */
  46     interface XSessionManagerClient : com::sun::star::uno::XInterface
  47     {
  48
  49         /** addSessionManagerListener registers a listener for session management events
  50
  51         @param xListener
  52         listener for session management events
  53
  54         @see XSessionManagerListener
  55         @see XSessionManagerClient::removeSessionManagerListener()
  56         */
  57         [oneway] void addSessionManagerListener( [in] XSessionManagerListener xListener );
  58
  59         /** removeSessionManagerListener deregisters a listener for session events
  60
  61         @param xListener
  62             listener to be removed
  63
  64         @see XSessionManagerListener
  65         @see XSessionManagerClient::addSessionManagerListener()
  66         */
  67         [oneway] void removeSessionManagerListener( [in] XSessionManagerListener xListener );
  68
  69         /** queryInteraction issues a request for a user interaction slot
  70             from the session manager
  71
  72         @param xListener
  73         the listener requesting user interaction
  74
  75         @see XSessionManagerListener
  76         */
  77         [oneway] void queryInteraction( [in] XSessionManagerListener xListener );
  78
  79         /** interactionDone is called when a listener has finished user interaction
  80
  81         @param xListener
  82         the listener done with user interaction
  83
  84         @see XSessionManagerListener
  85         */
  86         [oneway] void interactionDone( [in] XSessionManagerListener xListener );
  87
  88         /** saveDone signals that a listener has processed a save request
  89
  90         @param listener
  91         the listener having finished save request processing
  92
  93         @see XSessionManagerListener
  94         */
  95         [oneway] void saveDone( [in] XSessionManagerListener xListener );
  96
  97         /** Call cancelShutdown to try to cancel a desktop shutdown in progress
  98
  99         @returns
 100         <TRUE/> if shutdown was canceled,
 101         <FALSE/> else.
 102         */
 103         boolean cancelShutdown();
 104     };
 105
 106 }; }; }; };
 107
 108
 109 #endif