offapi/com/sun/star/frame/XSessionManagerClient.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module frame {
  22
  23 /** Connect to a session manager to get information about pending
  24     desktop shutdown
  25
  26  */
  27     interface XSessionManagerClient : com::sun::star::uno::XInterface
  28     {
  29
  30         /** addSessionManagerListener registers a listener for session management events
  31
  32         @param xListener
  33         listener for session management events
  34
  35         @see XSessionManagerListener
  36         @see XSessionManagerClient::removeSessionManagerListener()
  37         */
  38         void addSessionManagerListener( [in] XSessionManagerListener xListener );
  39
  40         /** removeSessionManagerListener deregisters a listener for session events
  41
  42         @param xListener
  43             listener to be removed
  44
  45         @see XSessionManagerListener
  46         @see XSessionManagerClient::addSessionManagerListener()
  47         */
  48         void removeSessionManagerListener( [in] XSessionManagerListener xListener );
  49
  50         /** queryInteraction issues a request for a user interaction slot
  51             from the session manager
  52
  53         @param xListener
  54         the listener requesting user interaction
  55
  56         @see XSessionManagerListener
  57         */
  58         void queryInteraction( [in] XSessionManagerListener xListener );
  59
  60         /** interactionDone is called when a listener has finished user interaction
  61
  62         @param xListener
  63         the listener done with user interaction
  64
  65         @see XSessionManagerListener
  66         */
  67         void interactionDone( [in] XSessionManagerListener xListener );
  68
  69         /** saveDone signals that a listener has processed a save request
  70
  71         @param xListener
  72         the listener having finished save request processing
  73
  74         @see XSessionManagerListener
  75         */
  76         void saveDone( [in] XSessionManagerListener xListener );
  77
  78         /** Call cancelShutdown to try to cancel a desktop shutdown in progress
  79
  80         @returns
  81         `TRUE` if shutdown was canceled,
  82         `FALSE` else.
  83         */
  84         boolean cancelShutdown();
  85     };
  86
  87 }; }; }; };
  88
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */