offapi/com/sun/star/frame/SessionManager.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 /** The SessionManager service provides an interface to the session manager
  24     of the desktop. A session manager keeps track of applications that are
  25     running when the desktop shuts down and starts them again in the same
  26     state they were left when the desktop starts up the next time. To be able
  27     to do this the session manager needs cooperation from applications;
  28     applications have to provide sufficient information to be started again as
  29     well as restore the state they were left in. The normal flow of operation
  30     looks like this:
  31
  32     <ol>
  33     <li>The user starts the desktop shutdown.</li>
  34     <li>The session manager informs all its connected applications
  35     about the pending shutdown.</li>
  36     <li>Each application saves its current state; while doing this it may
  37         <ul>
  38         <li>The application may request to interact with the user (e.g. to ask
  39         where to save documents). This request is necessary because at any one
  40         time only one application can interact with the user. The session manager
  41         coordinates these requests and grants every application in need of user
  42         interaction a timeslot in which it may interact with the user</li>
  43         <li>try to cancel the whole shutdown; the session manager may or may
  44         not honor that request.</li>
  45        </ul>
  46      </li>
  47      <li>After saving is done the session manager signals all applications
  48      to exit.</li>
  49      <li>Applications answer the exit message by disconnecting from the
  50      session manager.</li>
  51      <li>After all applications have exited or a reasonable timeout the
  52      session manager kills all remaining applications and finally lets the
  53      desktop shut down.</li>
  54      </ol>
  55 */
  56 service SessionManager
  57 {
  58     /** XSessionManagerClient (of which there can only be one instance per
  59         process) provides an application's interface to the session manager.
  60         It keeps track of every listener inside the application and multiplexes
  61         the session manager's signals as well as requests to the session manager.
  62     */
  63     interface XSessionManagerClient;
  64
  65 };
  66
  67 }; }; }; };
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */