vcl/inc/generic/gendisp.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 _VCL_GEN_DISP_HXX
  21 #define _VCL_GEN_DISP_HXX
  22
  23 #include <sal/types.h>
  24 #include <osl/mutex.h>
  25 #include <osl/conditn.hxx>
  26 #include <salwtype.hxx>
  27 #include <vcl/dllapi.h>
  28 #include <tools/gen.hxx>
  29 #include <list>
  30 #include <vector>
  31
  32 class SalFrame;
  33 class VCL_DLLPUBLIC SalGenericDisplay
  34 {
  35     oslMutex m_aEventGuard;
  36     struct SalUserEvent
  37     {
  38         SalFrame*  m_pFrame;
  39         void*      m_pData;
  40         sal_uInt16 m_nEvent;
  41
  42         SalUserEvent( SalFrame* pFrame, void* pData,
  43                       sal_uInt16 nEvent )
  44                 : m_pFrame( pFrame ),
  45                   m_pData( pData ),
  46                   m_nEvent( nEvent )
  47         {}
  48     };
  49     std::list< SalUserEvent > m_aUserEvents;
  50 protected:
  51     SalFrame* m_pCapture;
  52     std::list<SalFrame*> m_aFrames;
  53 public:
  54                  SalGenericDisplay();
  55     virtual      ~SalGenericDisplay();
  56
  57     inline void  EventGuardAcquire() { osl_acquireMutex( m_aEventGuard ); }
  58     inline void  EventGuardRelease() { osl_releaseMutex( m_aEventGuard ); }
  59
  60     virtual void registerFrame( SalFrame* pFrame );
  61     virtual void deregisterFrame( SalFrame* pFrame );
  62             void emitDisplayChanged();
  63
  64     // Event handling
  65     virtual void PostUserEvent() = 0;
  66
  67     virtual void SendInternalEvent( SalFrame* pFrame, void* pData, sal_uInt16 nEvent = SALEVENT_USEREVENT );
  68     virtual void CancelInternalEvent( SalFrame* pFrame, void* pData, sal_uInt16 nEvent );
  69     virtual bool DispatchInternalEvent();
  70     bool         HasUserEvents() const;
  71
  72     sal_Bool     MouseCaptured( const SalFrame *pFrameData ) const
  73                         { return m_pCapture == pFrameData; }
  74     SalFrame*    GetCaptureFrame() const
  75                         { return m_pCapture; }
  76 };
  77
  78
  79 #endif // _VCL_GEN_DISP_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */