office-gobmx/vcl/inc/unx/sessioninhibitor.hxx
Noel Grandin cc60e2eacd reduce symbol visibility in vcl
Change-Id: Ia56bb092a4634e301ff8922ae63e6f7ede874d80
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164865
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-03-16 07:31:14 +01:00

77 lines
3.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#pragma once
#include <X11/Xlib.h>
#include <X11/Xmd.h>
#include <vcl/dllapi.h>
#include <optional>
#include <string_view>
enum ApplicationInhibitFlags
{
APPLICATION_INHIBIT_LOGOUT = (1 << 0),
APPLICATION_INHIBIT_IDLE = (1 << 3) // Inhibit the session being marked as idle
};
class VCL_PLUGIN_PUBLIC SessionManagerInhibitor
{
public:
void inhibit(bool bInhibit, std::u16string_view sReason, ApplicationInhibitFlags eType,
unsigned int window_system_id, std::optional<Display*> pDisplay,
const char* application_id = nullptr);
private:
// These are all used as guint, however this header may be included
// in kde/tde/etc backends, where we would ideally avoid having
// any glib dependencies, hence the direct use of unsigned int.
std::optional<unsigned int> mnFDOSSCookie; // FDO ScreenSaver Inhibit
std::optional<unsigned int> mnFDOPMCookie; // FDO PowerManagement Inhibit
std::optional<unsigned int> mnGSMCookie;
std::optional<unsigned int> mnMSMCookie;
std::optional<int> mnXScreenSaverTimeout;
#if !defined(__sun)
BOOL mbDPMSWasEnabled;
CARD16 mnDPMSStandbyTimeout;
CARD16 mnDPMSSuspendTimeout;
CARD16 mnDPMSOffTimeout;
#endif
// There are a bunch of different dbus based inhibition APIs. Some call
// themselves ScreenSaver inhibition, some are PowerManagement inhibition,
// but they appear to have the same effect. There doesn't appear to be one
// all encompassing standard, hence we should just try all of them.
//
// The current APIs we have: (note: the list of supported environments is incomplete)
// FDSSO: org.freedesktop.ScreenSaver::Inhibit - appears to be supported only by KDE?
// FDOPM: org.freedesktop.PowerManagement.Inhibit::Inhibit - XFCE, (KDE) ?
// (KDE: doesn't inhibit screensaver, but does inhibit PowerManagement)
// GSM: org.gnome.SessionManager::Inhibit - gnome 3
// MSM: org.mate.Sessionmanager::Inhibit - Mate <= 1.10, is identical to GSM
// (This is replaced by the GSM interface from Mate 1.12 onwards)
//
// Note: the Uninhibit call has different spelling in FDOSS (UnInhibit) vs GSM (Uninhibit)
SAL_DLLPRIVATE void inhibitFDOSS(bool bInhibit, const char* appname, const char* reason);
SAL_DLLPRIVATE void inhibitFDOPM(bool bInhibit, const char* appname, const char* reason);
SAL_DLLPRIVATE void inhibitGSM(bool bInhibit, const char* appname, const char* reason,
ApplicationInhibitFlags eType, unsigned int window_system_id);
SAL_DLLPRIVATE void inhibitMSM(bool bInhibit, const char* appname, const char* reason,
ApplicationInhibitFlags eType, unsigned int window_system_id);
SAL_DLLPRIVATE void inhibitXScreenSaver(bool bInhibit, Display* pDisplay);
SAL_DLLPRIVATE static void inhibitXAutoLock(bool bInhibit, Display* pDisplay);
SAL_DLLPRIVATE void inhibitDPMS(bool bInhibit, Display* pDisplay);
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */