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 _SV_SYSCHILD_HXX
  21 #define _SV_SYSCHILD_HXX
  22
  23 #include <tools/solar.h>
  24 #include <vcl/dllapi.h>
  25 #include <vcl/window.hxx>
  26
  27 struct SystemEnvData;
  28 struct SystemWindowData;
  29
  30 // ---------------------
  31 // - SystemChildWindow -
  32 // ---------------------
  33
  34 class VCL_DLLPUBLIC SystemChildWindow : public Window
  35 {
  36 private:
  37     using Window::ImplInit;
  38     SAL_DLLPRIVATE void     ImplInitSysChild( Window* pParent, WinBits nStyle, SystemWindowData *pData, sal_Bool bShow = sal_False );
  39     SAL_DLLPRIVATE void     ImplTestJavaException( void* pEnv );
  40
  41     // Copy assignment is forbidden and not implemented.
  42     SAL_DLLPRIVATE          SystemChildWindow (const SystemChildWindow &);
  43     SAL_DLLPRIVATE          SystemChildWindow & operator= (const SystemChildWindow &);
  44
  45 public:
  46     explicit                SystemChildWindow( Window* pParent, WinBits nStyle = 0 );
  47                             // create a SystemChildWindow using the given SystemWindowData
  48     explicit                SystemChildWindow( Window* pParent, WinBits nStyle, SystemWindowData *pData, sal_Bool bShow = sal_True );
  49     virtual                 ~SystemChildWindow();
  50
  51     const SystemEnvData*    GetSystemData() const;
  52
  53     //  per default systemchildwindows erase their background for better plugin support
  54     //  however, this might not always be required
  55     void                    EnableEraseBackground( sal_Bool bEnable = sal_True );
  56     void                    SetForwardKey( sal_Bool bEnable );
  57     // return the platform specific handle/id of this window;
  58     // in case the flag bUseJava is set, a java compatible overlay window
  59     // is created on which other java windows can be created (plugin interface)
  60     sal_IntPtr              GetParentWindowHandle( sal_Bool bUseJava = sal_False );
  61 };
  62
  63 #endif // _SV_SYSCHILD_HXX
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */