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     SAL_DLLPRIVATE void     ImplTestJavaException( void* pEnv );
  35
  36     // Copy assignment is forbidden and not implemented.
  37                             SystemChildWindow (const SystemChildWindow &) SAL_DELETED_FUNCTION;
  38                             SystemChildWindow & operator= (const SystemChildWindow &) SAL_DELETED_FUNCTION;
  39
  40 public:
  41     explicit                SystemChildWindow( vcl::Window* pParent, WinBits nStyle = 0 );
  42                             // create a SystemChildWindow using the given SystemWindowData
  43     explicit                SystemChildWindow( vcl::Window* pParent, WinBits nStyle, SystemWindowData *pData, bool bShow = true );
  44     virtual                 ~SystemChildWindow();
  45     virtual void            dispose() SAL_OVERRIDE;
  46
  47     const SystemEnvData*    GetSystemData() const;
  48
  49     //  per default systemchildwindows erase their background for better plugin support
  50     //  however, this might not always be required
  51     void                    EnableEraseBackground( bool bEnable = true );
  52     void                    SetForwardKey( bool bEnable );
  53     // return the platform specific handle/id of this window;
  54     // in case the flag bUseJava is set, a java compatible overlay window
  55     // is created on which other java windows can be created (plugin interface)
  56     sal_IntPtr              GetParentWindowHandle( bool bUseJava = false );
  57 };
  58
  59 #endif // INCLUDED_VCL_SYSCHILD_HXX
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */