vcl/inc/unx/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 INCLUDED_VCL_INC_GENERIC_GENDISP_HXX
  21 #define INCLUDED_VCL_INC_GENERIC_GENDISP_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 <list>
  29 #include <vector>
  30
  31 class SalFrame;
  32 class VCL_DLLPUBLIC SalGenericDisplay
  33 {
  34     mutable osl::Mutex m_aEventGuard;
  35     struct SalUserEvent
  36     {
  37         SalFrame*  m_pFrame;
  38         void*      m_pData;
  39         SalEvent   m_nEvent;
  40
  41         SalUserEvent( SalFrame* pFrame, void* pData,
  42                       SalEvent nEvent )
  43                 : m_pFrame( pFrame ),
  44                   m_pData( pData ),
  45                   m_nEvent( nEvent )
  46         {}
  47     };
  48     std::list< SalUserEvent > m_aUserEvents;
  49 protected:
  50     SalFrame* m_pCapture;
  51     std::list<SalFrame*> m_aFrames;
  52 public:
  53                  SalGenericDisplay();
  54     virtual      ~SalGenericDisplay();
  55
  56     osl::Mutex& getEventGuardMutex() { return m_aEventGuard; }
  57
  58     void registerFrame( SalFrame* pFrame );
  59     virtual void deregisterFrame( SalFrame* pFrame );
  60     void emitDisplayChanged();
  61
  62     // Event handling
  63     virtual void PostUserEvent() = 0;
  64
  65     void SendInternalEvent( SalFrame* pFrame, void* pData, SalEvent nEvent = SalEvent::UserEvent );
  66     void CancelInternalEvent( SalFrame* pFrame, void* pData, SalEvent nEvent );
  67     bool DispatchInternalEvent();
  68     bool HasUserEvents() const;
  69
  70     bool     MouseCaptured( const SalFrame *pFrameData ) const
  71                         { return m_pCapture == pFrameData; }
  72     SalFrame*    GetCaptureFrame() const
  73                         { return m_pCapture; }
  74 };
  75
  76 #endif // INCLUDED_VCL_INC_GENERIC_GENDISP_HXX
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */