include/vcl/syschild.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_SYSCHILD_HXX
  21 #define INCLUDED_VCL_SYSCHILD_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <vcl/window.hxx>
  25
  26 struct SystemEnvData;
  27 struct SystemWindowData;
  28
  29 class VCL_DLLPUBLIC SystemChildWindow : public vcl::Window
  30 {
  31 private:
  32     using Window::ImplInit;
  33     SAL_DLLPRIVATE void     ImplInitSysChild( vcl::Window* pParent, WinBits nStyle, SystemWindowData *pData, bool bShow = false );
  34
  35     // Copy assignment is forbidden and not implemented.
  36                             SystemChildWindow (const SystemChildWindow &) = delete;
  37                             SystemChildWindow & operator= (const SystemChildWindow &) = delete;
  38
  39 public:
  40     explicit                SystemChildWindow( vcl::Window* pParent, WinBits nStyle );
  41                             // create a SystemChildWindow using the given SystemWindowData
  42     explicit                SystemChildWindow( vcl::Window* pParent, WinBits nStyle, SystemWindowData *pData, bool bShow = true );
  43     virtual                 ~SystemChildWindow() override;
  44     virtual void            dispose() override;
  45
  46     virtual const SystemEnvData* GetSystemData() const override;
  47
  48     //  per default systemchildwindows erase their background for better plugin support
  49     //  however, this might not always be required
  50     void                    EnableEraseBackground( bool bEnable );
  51     void                    SetForwardKey( bool bEnable );
  52     //To avoid annoying flashing under X entering and leaving slides with opengl effects set the leaving
  53     //bitmap as the background pixmap of the opengl child window and the entering bitmap as the background
  54     //pixmap of the non-opengl parent window. If any expose events occur around the start and end of
  55     //the transition then those windows are default filled by X with the desired start/end image so there's
  56     //no visible flash
  57     void                    SetLeaveEnterBackgrounds(const css::uno::Sequence<css::uno::Any>& rLeaveArgs, const css::uno::Sequence<css::uno::Any>& rEnterArgs);
  58     // return the platform specific handle/id of this window;
  59     sal_IntPtr              GetParentWindowHandle();
  60 };
  61
  62 #endif // INCLUDED_VCL_SYSCHILD_HXX
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */