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 #if !defined(_WIN32) && (!defined(__APPLE__) || defined(MACOSX_USE_GLX)) && !defined(__ANDROID__) && !defined(__QNX__) && !defined(__EMSCRIPTEN__)
  20
  21 #include <Aspect_Window.hxx>
  22
  23 #include <Aspect_VKey.hxx>
  24 #include <Aspect_DisplayConnection.hxx>
  25 #include <Aspect_FillMethod.hxx>
  26 #include <Aspect_GradientFillMethod.hxx>
  27 #include <Aspect_Handle.hxx>
  28 #include <Aspect_TypeOfResize.hxx>
  29 #include <Standard.hxx>
  30 #include <Standard_Type.hxx>
  31 #include <Quantity_NameOfColor.hxx>
  32
  33 class Aspect_WindowDefinitionError;
  34 class Aspect_WindowError;
  35 class Aspect_WindowInputListener;
  36 class Aspect_Background;
  37 class Quantity_Color;
  38 class Aspect_GradientBackground;
  39
  40 //! This class defines XLib window intended for creation of OpenGL context.
  41 class Xw_Window : public Aspect_Window
  42 {
  43 public:
  44
  45   //! Convert X11 virtual key (KeySym) into Aspect_VKey.
  46   Standard_EXPORT static Aspect_VKey VirtualKeyFromNative (unsigned long theKey);
  47
  48 public:
  49
  50   //! Creates a XLib window defined by his position and size in pixels.
  51   //! Throws exception if window can not be created or Display do not support GLX extension.
  52   Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
  53                              const Standard_CString theTitle,
  54                              const Standard_Integer thePxLeft,
  55                              const Standard_Integer thePxTop,
  56                              const Standard_Integer thePxWidth,
  57                              const Standard_Integer thePxHeight);
  58
  59   //! Creates a wrapper over existing Window handle
  60   Standard_EXPORT Xw_Window (const Handle(Aspect_DisplayConnection)& theXDisplay,
  61                              const Window theXWin,
  62                              const Aspect_FBConfig theFBConfig = NULL);
  63
  64   //! Destroys the Window and all resourses attached to it
  65   Standard_EXPORT ~Xw_Window();
  66
  67   //! Opens the window <me>
  68   Standard_EXPORT virtual void Map() const Standard_OVERRIDE;
  69
  70   //! Closes the window <me>
  71   Standard_EXPORT virtual void Unmap() const Standard_OVERRIDE;
  72
  73   //! Applies the resizing to the window <me>
  74   Standard_EXPORT virtual Aspect_TypeOfResize DoResize() Standard_OVERRIDE;
  75
  76   //! Apply the mapping change to the window <me>
  77   Standard_EXPORT virtual Standard_Boolean DoMapping() const Standard_OVERRIDE;
  78
  79   //! Returns True if the window <me> is opened
  80   Standard_EXPORT virtual Standard_Boolean IsMapped() const Standard_OVERRIDE;
  81
  82   //! Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions
  83   Standard_EXPORT virtual Standard_Real Ratio() const Standard_OVERRIDE;
  84
  85   //! Returns The Window POSITION in PIXEL
  86   Standard_EXPORT virtual void Position (Standard_Integer& X1,
  87                                          Standard_Integer& Y1,
  88                                          Standard_Integer& X2,
  89                                          Standard_Integer& Y2) const Standard_OVERRIDE;
  90
  91   //! Returns The Window SIZE in PIXEL
  92   Standard_EXPORT virtual void Size (Standard_Integer& theWidth,
  93                                      Standard_Integer& theHeight) const Standard_OVERRIDE;
  94
  95   //! @return native Window handle
  96   Standard_EXPORT Window XWindow() const;
  97
  98   //! @return connection to X Display
  99   Standard_EXPORT const Handle(Aspect_DisplayConnection)& DisplayConnection() const;
 100
 101   //! @return native Window handle
 102   virtual Aspect_Drawable NativeHandle() const Standard_OVERRIDE
 103   {
 104     return (Aspect_Drawable )XWindow();
 105   }
 106
 107   //! @return parent of native Window handle
 108   virtual Aspect_Drawable NativeParentHandle() const Standard_OVERRIDE
 109   {
 110     return 0;
 111   }
 112
 113   //! @return native Window FB config (GLXFBConfig on Xlib)
 114   virtual Aspect_FBConfig NativeFBConfig() const Standard_OVERRIDE
 115   {
 116     return myFBConfig;
 117   }
 118
 119   //! Sets window title.
 120   Standard_EXPORT virtual void SetTitle (const TCollection_AsciiString& theTitle) Standard_OVERRIDE;
 121
 122   //! Invalidate entire window content through generation of Expose event.
 123   //! This method does not aggregate multiple calls into single event - dedicated event will be sent on each call.
 124   //! When NULL display connection is specified, the connection specified on window creation will be used.
 125   //! Sending exposure messages from non-window thread would require dedicated display connection opened specifically
 126   //! for this working thread to avoid race conditions, since Xlib display connection is not thread-safe by default.
 127   Standard_EXPORT virtual void InvalidateContent (const Handle(Aspect_DisplayConnection)& theDisp) Standard_OVERRIDE;
 128
 129   //! Process a single window message.
 130   //! @param theListener [in][out] listener to redirect message
 131   //! @param theMsg [in][out] message to process
 132   //! @return TRUE if message has been processed
 133   Standard_EXPORT virtual bool ProcessMessage (Aspect_WindowInputListener& theListener,
 134                                                XEvent& theMsg);
 135
 136 protected:
 137
 138   Handle(Aspect_DisplayConnection) myDisplay; //!< X Display connection
 139   Window           myXWindow;  //!< XLib window handle
 140   Aspect_FBConfig  myFBConfig; //!< GLXFBConfig
 141   Standard_Integer myXLeft;    //!< left   position in pixels
 142   Standard_Integer myYTop;     //!< top    position in pixels
 143   Standard_Integer myXRight;   //!< right  position in pixels
 144   Standard_Integer myYBottom;  //!< bottom position in pixels
 145   Standard_Boolean myIsOwnWin; //!< flag to indicate own window handle (to be deallocated on destruction)
 146
 147 public:
 148
 149   DEFINE_STANDARD_RTTIEXT(Xw_Window,Aspect_Window)
 150
 151 };
 152
 153 DEFINE_STANDARD_HANDLE(Xw_Window, Aspect_Window)
 154
 155 #endif //  Win32 or Mac OS X
 156 #endif // _Xw_Window_H__