• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kde-workspace API Reference
  • KDE Home
  • Contact Us
 

libkworkspace

  • kde-4.x
  • kde-workspace
  • plasma-workspace
  • libkworkspace
kworkspace.h
Go to the documentation of this file.
1 /* This file is part of the KDE libraries
2  Copyright (C) 1997 Matthias Kalle Dalheimer ([email protected])
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef KWORKSPACE_H
21 #define KWORKSPACE_H
22 
23 #include "kworkspace_export.h"
24 
25 namespace KWorkSpace
26 {
27 
31  enum ShutdownConfirm {
35  ShutdownConfirmDefault = -1,
39  ShutdownConfirmNo = 0,
43  ShutdownConfirmYes = 1
44  };
45 
49  enum ShutdownType {
53  ShutdownTypeDefault = -1,
57  ShutdownTypeNone = 0,
61  ShutdownTypeReboot = 1,
65  ShutdownTypeHalt = 2,
69  // KDE5: kill this
70  ShutdownTypeLogout = 3
71  };
72 
76  // KDE5: this seems fairly useless
77  enum ShutdownMode {
81  ShutdownModeDefault = -1,
86  ShutdownModeSchedule = 0,
90  ShutdownModeTryNow = 1,
94  ShutdownModeForceNow = 2,
98  ShutdownModeInteractive = 3
99  };
100 
114  KWORKSPACE_EXPORT void requestShutDown( ShutdownConfirm confirm = ShutdownConfirmDefault,
115  ShutdownType sdtype = ShutdownTypeDefault,
116  ShutdownMode sdmode = ShutdownModeDefault );
117 
129  KWORKSPACE_EXPORT bool canShutDown( ShutdownConfirm confirm = ShutdownConfirmDefault,
130  ShutdownType sdtype = ShutdownTypeDefault,
131  ShutdownMode sdmode = ShutdownModeDefault );
132 
146  KWORKSPACE_EXPORT void propagateSessionManager();
147 
148 }
149 
150 #endif
KWorkSpace::ShutdownModeTryNow
Shut down, if no sessions are active.
Definition: kworkspace.h:90
KWorkSpace::canShutDown
bool canShutDown(ShutdownConfirm confirm, ShutdownType sdtype, ShutdownMode sdmode)
Used to check whether a requestShutDown call with the same arguments has any chance of succeeding...
Definition: kworkspace.cpp:193
KWorkSpace::ShutdownTypeNone
Only log out.
Definition: kworkspace.h:57
KWorkSpace::ShutdownConfirmYes
Always confirm, ask even if the user turned it off.
Definition: kworkspace.h:43
KWorkSpace::requestShutDown
void requestShutDown(ShutdownConfirm confirm, ShutdownType sdtype, ShutdownMode sdmode)
Asks the session manager to shut the session down.
Definition: kworkspace.cpp:171
KWorkSpace::ShutdownTypeDefault
Select previous action or the default if it's the first time.
Definition: kworkspace.h:53
KWorkSpace::ShutdownModeForceNow
Force shutdown.
Definition: kworkspace.h:94
KWorkSpace::ShutdownTypeLogout
Temporary brain damage.
Definition: kworkspace.h:70
KWorkSpace::ShutdownType
ShutdownType
The possible values for the sdtype parameter of requestShutDown().
Definition: kworkspace.h:49
KWorkSpace::ShutdownMode
ShutdownMode
The possible values for the sdmode parameter of requestShutDown().
Definition: kworkspace.h:77
KWorkSpace::propagateSessionManager
void propagateSessionManager()
Propagates the network address of the session manager in the SESSION_MANAGER environment variable so ...
Definition: kworkspace.cpp:217
KWorkSpace::ShutdownConfirm
ShutdownConfirm
The possible values for the confirm parameter of requestShutDown().
Definition: kworkspace.h:31
KWorkSpace::ShutdownModeSchedule
Schedule a shutdown (halt or reboot) for the time all active sessions have exited.
Definition: kworkspace.h:86
KWorkSpace::ShutdownModeInteractive
Pop up a dialog asking the user what to do if sessions are still active.
Definition: kworkspace.h:98
KWorkSpace::ShutdownTypeReboot
Log out and reboot the machine.
Definition: kworkspace.h:61
KWorkSpace::ShutdownTypeHalt
Log out and halt the machine.
Definition: kworkspace.h:65
KWorkSpace::ShutdownConfirmNo
Don't confirm, shutdown without asking.
Definition: kworkspace.h:39
KWorkSpace::ShutdownConfirmDefault
Obey the user's confirmation setting.
Definition: kworkspace.h:35
KWorkSpace::ShutdownModeDefault
Select previous mode or the default if it's the first time.
Definition: kworkspace.h:81
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Mon Dec 9 2019 01:37:39 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

libkworkspace

Skip menu "libkworkspace"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kde-workspace API Reference

Skip menu "kde-workspace API Reference"
  • KWin
  •   KWin Decoration Library
  •   KWin Effects Library
  • Plasma
  • Plasma
  •   Applets
  •   Engines
  •   libkworkspace
  •   libtaskmanager
  • System Settings
  •   SystemSettingsView

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal