Branch data     Line data    Source code

       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 _VCL_SALSESSION_HXX
      21                 :            : #define _VCL_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                 :          0 :     SalSessionEvent( SalSessionEventType eType )
      38                 :          0 :             : m_eType( eType )
      39                 :          0 :     {}
      40                 :            : };
      41                 :            : 
      42                 :            : struct SalSessionInteractionEvent : public SalSessionEvent
      43                 :            : {
      44                 :            :     bool                        m_bInteractionGranted;
      45                 :            : 
      46                 :          0 :     SalSessionInteractionEvent( bool bGranted )
      47                 :            :             : SalSessionEvent( Interaction ),
      48                 :          0 :               m_bInteractionGranted( bGranted )
      49                 :          0 :     {}
      50                 :            : };
      51                 :            : 
      52                 :            : struct SalSessionSaveRequestEvent : public SalSessionEvent
      53                 :            : {
      54                 :            :     bool                        m_bShutdown;
      55                 :            :     bool                        m_bCancelable;
      56                 :            : 
      57                 :          0 :     SalSessionSaveRequestEvent( bool bShutdown, bool bCancelable )
      58                 :            :             : SalSessionEvent( SaveRequest ),
      59                 :            :               m_bShutdown( bShutdown ),
      60                 :          0 :               m_bCancelable( bCancelable )
      61                 :          0 :     {}
      62                 :            : };
      63                 :            : 
      64                 :            : struct SalSessionShutdownCancelEvent : public SalSessionEvent
      65                 :            : {
      66                 :          0 :     SalSessionShutdownCancelEvent()
      67                 :          0 :             : SalSessionEvent( ShutdownCancel )
      68                 :          0 :     {}
      69                 :            : };
      70                 :            : 
      71                 :            : struct SalSessionQuitEvent : public SalSessionEvent
      72                 :            : {
      73                 :          0 :     SalSessionQuitEvent()
      74                 :          0 :             : SalSessionEvent( Quit )
      75                 :          0 :     {}
      76                 :            : };
      77                 :            : 
      78                 :            : typedef void(*SessionProc)(void *pData, SalSessionEvent *pEvent);
      79                 :            : 
      80                 :            : class VCL_PLUGIN_PUBLIC SalSession
      81                 :            : {
      82                 :            :     SessionProc         m_aProc;
      83                 :            :     void *              m_pProcData;
      84                 :            : public:
      85                 :          0 :     SalSession()
      86                 :          0 :             : m_aProc( 0 )
      87                 :          0 :     {}
      88                 :            :     virtual ~SalSession();
      89                 :            : 
      90                 :          0 :     void SetCallback( SessionProc aCallback, void * pCallbackData )
      91                 :            :     {
      92                 :          0 :         m_aProc = aCallback;
      93                 :          0 :         m_pProcData = pCallbackData;
      94                 :          0 :     }
      95                 :          0 :     void CallCallback( SalSessionEvent* pEvent )
      96                 :            :     {
      97                 :          0 :         if( m_aProc )
      98                 :          0 :             m_aProc( m_pProcData, pEvent );
      99                 :          0 :     }
     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 sutdown in progress
     108                 :            :     virtual bool cancelShutdown() = 0;
     109                 :            : };
     110                 :            : 
     111                 :            : #endif
     112                 :            : 
     113                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */