1 // Created on: 2013-04-06
2 // Created by: Kirill Gavrilov
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _Xw_Window_H__
17 #define _Xw_Window_H__
19 #include <Aspect_Window.hxx>
21 #include <Aspect_VKey.hxx>
22 #include <Aspect_Handle.hxx>
24 class Aspect_DisplayConnection;
25 class Aspect_WindowDefinitionError;
26 class Aspect_WindowError;
27 class Aspect_WindowInputListener;
28 class Aspect_Background;
30 class Aspect_GradientBackground;
32 typedef union _XEvent XEvent;
34 //! This class defines XLib window intended for creation of OpenGL context.
35 class Xw_Window : public Aspect_Window
37 DEFINE_STANDARD_RTTIEXT(Xw_Window, Aspect_Window)
40 //! Convert X11 virtual key (KeySym) into Aspect_VKey.
41 Standard_EXPORT static Aspect_VKey VirtualKeyFromNative (unsigned long theKey);
45 //! Creates a XLib window defined by his position and size in pixels.
46 //! Throws exception if window can not be created or Display do not support GLX extension.
47 Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
48 const Standard_CString theTitle,
49 const Standard_Integer thePxLeft,
50 const Standard_Integer thePxTop,
51 const Standard_Integer thePxWidth,
52 const Standard_Integer thePxHeight);
54 //! Creates a wrapper over existing Window handle
55 Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
56 const Aspect_Drawable theXWin,
57 const Aspect_FBConfig theFBConfig = NULL);
59 //! Destroys the Window and all resources attached to it
60 Standard_EXPORT ~Xw_Window();
62 //! Opens the window <me>
63 Standard_EXPORT virtual void Map() const Standard_OVERRIDE;
65 //! Closes the window <me>
66 Standard_EXPORT virtual void Unmap() const Standard_OVERRIDE;
68 //! Applies the resizing to the window <me>
69 Standard_EXPORT virtual Aspect_TypeOfResize DoResize() Standard_OVERRIDE;
71 //! Apply the mapping change to the window <me>
72 virtual Standard_Boolean DoMapping() const Standard_OVERRIDE
74 return Standard_True; // IsMapped()
77 //! Returns True if the window <me> is opened
78 Standard_EXPORT virtual Standard_Boolean IsMapped() const Standard_OVERRIDE;
80 //! Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions
81 Standard_EXPORT virtual Standard_Real Ratio() const Standard_OVERRIDE;
83 //! Returns The Window POSITION in PIXEL
84 Standard_EXPORT virtual void Position (Standard_Integer& X1,
87 Standard_Integer& Y2) const Standard_OVERRIDE;
89 //! Returns The Window SIZE in PIXEL
90 Standard_EXPORT virtual void Size (Standard_Integer& theWidth,
91 Standard_Integer& theHeight) const Standard_OVERRIDE;
93 //! @return native Window handle
94 Aspect_Drawable XWindow() const { return myXWindow; }
96 //! @return native Window handle
97 virtual Aspect_Drawable NativeHandle() const Standard_OVERRIDE
102 //! @return parent of native Window handle
103 virtual Aspect_Drawable NativeParentHandle() const Standard_OVERRIDE
108 //! @return native Window FB config (GLXFBConfig on Xlib)
109 virtual Aspect_FBConfig NativeFBConfig() const Standard_OVERRIDE
114 //! Sets window title.
115 Standard_EXPORT virtual void SetTitle (const TCollection_AsciiString& theTitle) Standard_OVERRIDE;
117 //! Invalidate entire window content through generation of Expose event.
118 //! This method does not aggregate multiple calls into single event - dedicated event will be sent on each call.
119 //! When NULL display connection is specified, the connection specified on window creation will be used.
120 //! Sending exposure messages from non-window thread would require dedicated display connection opened specifically
121 //! for this working thread to avoid race conditions, since Xlib display connection is not thread-safe by default.
122 Standard_EXPORT virtual void InvalidateContent (const Handle(Aspect_DisplayConnection)& theDisp) Standard_OVERRIDE;
124 //! Process a single window message.
125 //! @param theListener [in][out] listener to redirect message
126 //! @param theMsg [in][out] message to process
127 //! @return TRUE if message has been processed
128 Standard_EXPORT virtual bool ProcessMessage (Aspect_WindowInputListener& theListener,
133 Aspect_Drawable myXWindow; //!< XLib window handle
134 Aspect_FBConfig myFBConfig; //!< GLXFBConfig
135 Standard_Integer myXLeft; //!< left position in pixels
136 Standard_Integer myYTop; //!< top position in pixels
137 Standard_Integer myXRight; //!< right position in pixels
138 Standard_Integer myYBottom; //!< bottom position in pixels
139 Standard_Boolean myIsOwnWin; //!< flag to indicate own window handle (to be deallocated on destruction)
143 DEFINE_STANDARD_HANDLE(Xw_Window, Aspect_Window)
145 #endif // _Xw_Window_H__