vcl/inc/salsession.hxx

   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 #ifndef INCLUDED_VCL_INC_SALSESSION_HXX
  21 #define INCLUDED_VCL_INC_SALSESSION_HXX
  22
  23 #include <vcl/dllapi.h>
  24
  25 enum SalSessionEventType
  26 {
  27     Interaction,
  28     SaveRequest,
  29     ShutdownCancel,
  30     Quit
  31 };
  32
  33 struct SalSessionEvent
  34 {
  35     SalSessionEventType         m_eType;
  36
  37     SalSessionEvent( SalSessionEventType eType )
  38             : m_eType( eType )
  39     {}
  40 };
  41
  42 struct SalSessionInteractionEvent : public SalSessionEvent
  43 {
  44     bool                        m_bInteractionGranted;
  45
  46     SalSessionInteractionEvent( bool bGranted )
  47             : SalSessionEvent( Interaction ),
  48               m_bInteractionGranted( bGranted )
  49     {}
  50 };
  51
  52 struct SalSessionSaveRequestEvent : public SalSessionEvent
  53 {
  54     bool                        m_bShutdown;
  55
  56     SalSessionSaveRequestEvent( bool bShutdown )
  57             : SalSessionEvent( SaveRequest ),
  58               m_bShutdown( bShutdown )
  59     {}
  60 };
  61
  62 struct SalSessionShutdownCancelEvent : public SalSessionEvent
  63 {
  64     SalSessionShutdownCancelEvent()
  65             : SalSessionEvent( ShutdownCancel )
  66     {}
  67 };
  68
  69 struct SalSessionQuitEvent : public SalSessionEvent
  70 {
  71     SalSessionQuitEvent()
  72             : SalSessionEvent( Quit )
  73     {}
  74 };
  75
  76 typedef void(*SessionProc)(void *pData, SalSessionEvent *pEvent);
  77
  78 class VCL_PLUGIN_PUBLIC SalSession
  79 {
  80     SessionProc         m_aProc;
  81     void *              m_pProcData;
  82 public:
  83     SalSession()
  84         : m_aProc(nullptr)
  85         , m_pProcData(nullptr)
  86     {
  87     }
  88     virtual ~SalSession();
  89
  90     void SetCallback( SessionProc aCallback, void * pCallbackData )
  91     {
  92         m_aProc = aCallback;
  93         m_pProcData = pCallbackData;
  94     }
  95     void CallCallback( SalSessionEvent* pEvent )
  96     {
  97         if( m_aProc )
  98             m_aProc( m_pProcData, pEvent );
  99     }
 100
 101     // query the session manager for a user interaction slot
 102     virtual void queryInteraction() = 0;
 103     // signal the session manager that we're done with user interaction
 104     virtual void interactionDone() = 0;
 105     // signal that we're done saving
 106     virtual void saveDone() = 0;
 107     // try to cancel the shutdown in progress
 108     virtual bool cancelShutdown() = 0;
 109 };
 110
 111 #endif // INCLUDED_VCL_INC_SALSESSION_HXX
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */