0027067: Avoid use of virtual methods for implementation of destructors in legacy...
[occt.git] / src / Xw / Xw_Window.hxx
CommitLineData
ed97f43c 1// Created on: 2013-04-06
2// Created by: Kirill Gavrilov
d5f74e42 3// Copyright (c) 2013-2014 OPEN CASCADE SAS
ed97f43c 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
ed97f43c 6//
d5f74e42 7// This library is free software; you can redistribute it and/or modify it under
8// the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 9// by the Free Software Foundation, with special exception defined in the file
10// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11// distribution for complete text of the license and disclaimer of any warranty.
ed97f43c 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
ed97f43c 15
16#ifndef _Xw_Window_H__
17#define _Xw_Window_H__
18
d8d01f6e 19#if !defined(_WIN32) && (!defined(__APPLE__) || defined(MACOSX_USE_GLX)) && !defined(__ANDROID__) && !defined(__QNX__)
ed97f43c 20
21#include <Aspect_Window.hxx>
22
23#include <Aspect_DisplayConnection.hxx>
24#include <Aspect_FillMethod.hxx>
25#include <Aspect_GradientFillMethod.hxx>
26#include <Aspect_Handle.hxx>
27#include <Aspect_TypeOfResize.hxx>
28#include <Standard.hxx>
ec357c5c 29#include <Standard_Type.hxx>
ed97f43c 30#include <Quantity_NameOfColor.hxx>
31#include <Quantity_Parameter.hxx>
32#include <Quantity_Ratio.hxx>
33
34class Aspect_WindowDefinitionError;
35class Aspect_WindowError;
36class Aspect_Background;
37class Quantity_Color;
38class Aspect_GradientBackground;
39
40//! This class defines XLib window intended for creation of OpenGL context.
41class Xw_Window : public Aspect_Window
42{
43
44public:
45
46 //! Creates a XLib window defined by his position and size in pixels.
47 //! Throws exception if window can not be created or Display do not support GLX extension.
48 Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
49 const Standard_CString theTitle,
50 const Standard_Integer thePxLeft,
51 const Standard_Integer thePxTop,
52 const Standard_Integer thePxWidth,
b6bf4ec1 53 const Standard_Integer thePxHeight,
54 const Aspect_FBConfig theFBConfig = NULL);
ed97f43c 55
56 //! Creates a wrapper over existing Window handle
57 Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
b6bf4ec1 58 const Window theXWin,
59 const Aspect_FBConfig theFBConfig = NULL);
ed97f43c 60
e6f550da 61 //! Destroys the Window and all resourses attached to it
62 Standard_EXPORT ~Xw_Window();
ed97f43c 63
64 //! Opens the window <me>
b6bf4ec1 65 Standard_EXPORT virtual void Map() const Standard_OVERRIDE;
ed97f43c 66
67 //! Closes the window <me>
b6bf4ec1 68 Standard_EXPORT virtual void Unmap() const Standard_OVERRIDE;
ed97f43c 69
70 //! Applies the resizing to the window <me>
b6bf4ec1 71 Standard_EXPORT virtual Aspect_TypeOfResize DoResize() const Standard_OVERRIDE;
ed97f43c 72
73 //! Apply the mapping change to the window <me>
b6bf4ec1 74 Standard_EXPORT virtual Standard_Boolean DoMapping() const Standard_OVERRIDE;
ed97f43c 75
76 //! Returns True if the window <me> is opened
b6bf4ec1 77 Standard_EXPORT virtual Standard_Boolean IsMapped() const Standard_OVERRIDE;
ed97f43c 78
79 //! Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions
b6bf4ec1 80 Standard_EXPORT virtual Quantity_Ratio Ratio() const Standard_OVERRIDE;
ed97f43c 81
82 //! Returns The Window POSITION in PIXEL
83 Standard_EXPORT virtual void Position (Standard_Integer& X1,
84 Standard_Integer& Y1,
85 Standard_Integer& X2,
b6bf4ec1 86 Standard_Integer& Y2) const Standard_OVERRIDE;
ed97f43c 87
88 //! Returns The Window SIZE in PIXEL
89 Standard_EXPORT virtual void Size (Standard_Integer& theWidth,
b6bf4ec1 90 Standard_Integer& theHeight) const Standard_OVERRIDE;
ed97f43c 91
92 //! @return native Window handle
93 Standard_EXPORT Window XWindow() const;
94
95 //! @return connection to X Display
96 Standard_EXPORT const Handle(Aspect_DisplayConnection)& DisplayConnection() const;
97
25b97fac 98 //! @return native Window handle
b6bf4ec1 99 virtual Aspect_Drawable NativeHandle() const Standard_OVERRIDE
25b97fac 100 {
101 return (Aspect_Drawable )XWindow();
102 }
103
104 //! @return parent of native Window handle
b6bf4ec1 105 virtual Aspect_Drawable NativeParentHandle() const Standard_OVERRIDE
25b97fac 106 {
107 return 0;
108 }
109
b6bf4ec1 110 //! @return native Window FB config (GLXFBConfig on Xlib)
111 virtual Aspect_FBConfig NativeFBConfig() const Standard_OVERRIDE
112 {
113 return myFBConfig;
114 }
115
ed97f43c 116protected:
117
118 Handle(Aspect_DisplayConnection) myDisplay; //!< X Display connection
119 Window myXWindow; //!< XLib window handle
b6bf4ec1 120 Aspect_FBConfig myFBConfig; //!< GLXFBConfig
ed97f43c 121 Standard_Integer myXLeft; //!< left position in pixels
122 Standard_Integer myYTop; //!< top position in pixels
123 Standard_Integer myXRight; //!< right position in pixels
124 Standard_Integer myYBottom; //!< bottom position in pixels
125 Standard_Boolean myIsOwnWin; //!< flag to indicate own window handle (to be deallocated on destruction)
126
127public:
128
92efcf78 129 DEFINE_STANDARD_RTTIEXT(Xw_Window,Aspect_Window)
ed97f43c 130
131};
132
133DEFINE_STANDARD_HANDLE(Xw_Window, Aspect_Window)
134
135#endif // Win32 or Mac OS X
136#endif // _Xw_Window_H__