0032308: Configuration - make Xlib dependency optional
[occt.git] / src / Xw / Xw_Window.hxx
1 // Created on: 2013-04-06
2 // Created by: Kirill Gavrilov
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
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.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _Xw_Window_H__
17 #define _Xw_Window_H__
18
19 #include <Aspect_Window.hxx>
20
21 #include <Aspect_VKey.hxx>
22 #include <Aspect_Handle.hxx>
23
24 class Aspect_DisplayConnection;
25 class Aspect_WindowDefinitionError;
26 class Aspect_WindowError;
27 class Aspect_WindowInputListener;
28 class Aspect_Background;
29 class Quantity_Color;
30 class Aspect_GradientBackground;
31
32 typedef union _XEvent XEvent;
33
34 //! This class defines XLib window intended for creation of OpenGL context.
35 class Xw_Window : public Aspect_Window
36 {
37   DEFINE_STANDARD_RTTIEXT(Xw_Window, Aspect_Window)
38 public:
39
40   //! Convert X11 virtual key (KeySym) into Aspect_VKey.
41   Standard_EXPORT static Aspect_VKey VirtualKeyFromNative (unsigned long theKey);
42
43 public:
44
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);
53
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);
58
59   //! Destroys the Window and all resources attached to it
60   Standard_EXPORT ~Xw_Window();
61
62   //! Opens the window <me>
63   Standard_EXPORT virtual void Map() const Standard_OVERRIDE;
64
65   //! Closes the window <me>
66   Standard_EXPORT virtual void Unmap() const Standard_OVERRIDE;
67
68   //! Applies the resizing to the window <me>
69   Standard_EXPORT virtual Aspect_TypeOfResize DoResize() Standard_OVERRIDE;
70
71   //! Apply the mapping change to the window <me>
72   virtual Standard_Boolean DoMapping() const Standard_OVERRIDE
73   {
74     return Standard_True; // IsMapped()
75   }
76
77   //! Returns True if the window <me> is opened
78   Standard_EXPORT virtual Standard_Boolean IsMapped() const Standard_OVERRIDE;
79
80   //! Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions
81   Standard_EXPORT virtual Standard_Real Ratio() const Standard_OVERRIDE;
82
83   //! Returns The Window POSITION in PIXEL
84   Standard_EXPORT virtual void Position (Standard_Integer& X1,
85                                          Standard_Integer& Y1,
86                                          Standard_Integer& X2,
87                                          Standard_Integer& Y2) const Standard_OVERRIDE;
88
89   //! Returns The Window SIZE in PIXEL
90   Standard_EXPORT virtual void Size (Standard_Integer& theWidth,
91                                      Standard_Integer& theHeight) const Standard_OVERRIDE;
92
93   //! @return native Window handle
94   Aspect_Drawable XWindow() const { return myXWindow; }
95
96   //! @return connection to X Display
97   Standard_EXPORT const Handle(Aspect_DisplayConnection)& DisplayConnection() const;
98
99   //! @return native Window handle
100   virtual Aspect_Drawable NativeHandle() const Standard_OVERRIDE
101   {
102     return myXWindow;
103   }
104
105   //! @return parent of native Window handle
106   virtual Aspect_Drawable NativeParentHandle() const Standard_OVERRIDE
107   {
108     return 0;
109   }
110
111   //! @return native Window FB config (GLXFBConfig on Xlib)
112   virtual Aspect_FBConfig NativeFBConfig() const Standard_OVERRIDE
113   {
114     return myFBConfig;
115   }
116
117   //! Sets window title.
118   Standard_EXPORT virtual void SetTitle (const TCollection_AsciiString& theTitle) Standard_OVERRIDE;
119
120   //! Invalidate entire window content through generation of Expose event.
121   //! This method does not aggregate multiple calls into single event - dedicated event will be sent on each call.
122   //! When NULL display connection is specified, the connection specified on window creation will be used.
123   //! Sending exposure messages from non-window thread would require dedicated display connection opened specifically
124   //! for this working thread to avoid race conditions, since Xlib display connection is not thread-safe by default.
125   Standard_EXPORT virtual void InvalidateContent (const Handle(Aspect_DisplayConnection)& theDisp) Standard_OVERRIDE;
126
127   //! Process a single window message.
128   //! @param theListener [in][out] listener to redirect message
129   //! @param theMsg [in][out] message to process
130   //! @return TRUE if message has been processed
131   Standard_EXPORT virtual bool ProcessMessage (Aspect_WindowInputListener& theListener,
132                                                XEvent& theMsg);
133
134 protected:
135
136   Handle(Aspect_DisplayConnection) myDisplay; //!< X Display connection
137   Aspect_Drawable  myXWindow;  //!< XLib window handle
138   Aspect_FBConfig  myFBConfig; //!< GLXFBConfig
139   Standard_Integer myXLeft;    //!< left   position in pixels
140   Standard_Integer myYTop;     //!< top    position in pixels
141   Standard_Integer myXRight;   //!< right  position in pixels
142   Standard_Integer myYBottom;  //!< bottom position in pixels
143   Standard_Boolean myIsOwnWin; //!< flag to indicate own window handle (to be deallocated on destruction)
144
145 };
146
147 DEFINE_STANDARD_HANDLE(Xw_Window, Aspect_Window)
148
149 #endif // _Xw_Window_H__