EIC code displayed by LXR master/​include/​opencascade/​Xw_Window.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-05-20 08:18:24

 // Created on: 2013-04-06
 // Created by: Kirill Gavrilov
 // Copyright (c) 2013-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef Xw_Window_HeaderFile
 #define Xw_Window_HeaderFile
 
 #include <Aspect_Window.hxx>
 
 #include <Aspect_VKey.hxx>
 
 class Aspect_DisplayConnection;
 class Aspect_WindowInputListener;
 
 typedef union _XEvent XEvent;
 
 //! This class defines XLib window intended for creation of OpenGL context.
 class Xw_Window : public Aspect_Window
 {
   DEFINE_STANDARD_RTTIEXT(Xw_Window, Aspect_Window)
 public:
   //! Convert X11 virtual key (KeySym) into Aspect_VKey.
   Standard_EXPORT static Aspect_VKey VirtualKeyFromNative(unsigned long theKey);
 
 public:
   //! Creates a XLib window defined by his position and size in pixels.
   //! Throws exception if window can not be created or Display do not support GLX extension.
   Standard_EXPORT Xw_Window(const Handle(Aspect_DisplayConnection)& theXDisplay,
                             const Standard_CString                  theTitle,
                             const Standard_Integer                  thePxLeft,
                             const Standard_Integer                  thePxTop,
                             const Standard_Integer                  thePxWidth,
                             const Standard_Integer                  thePxHeight);
 
   //! Creates a wrapper over existing Window handle
   Standard_EXPORT Xw_Window(const Handle(Aspect_DisplayConnection)& theXDisplay,
                             const Aspect_Drawable                   theXWin,
                             const Aspect_FBConfig                   theFBConfig = NULL);
 
   //! Destroys the Window and all resources attached to it
   Standard_EXPORT ~Xw_Window();
 
   //! Opens the window <me>
   Standard_EXPORT virtual void Map() const Standard_OVERRIDE;
 
   //! Closes the window <me>
   Standard_EXPORT virtual void Unmap() const Standard_OVERRIDE;
 
   //! Applies the resizing to the window <me>
   Standard_EXPORT virtual Aspect_TypeOfResize DoResize() Standard_OVERRIDE;
 
   //! Apply the mapping change to the window <me>
   virtual Standard_Boolean DoMapping() const Standard_OVERRIDE
   {
     return Standard_True; // IsMapped()
   }
 
   //! Returns True if the window <me> is opened
   Standard_EXPORT virtual Standard_Boolean IsMapped() const Standard_OVERRIDE;
 
   //! Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions
   Standard_EXPORT virtual Standard_Real Ratio() const Standard_OVERRIDE;
 
   //! Returns The Window POSITION in PIXEL
   Standard_EXPORT virtual void Position(Standard_Integer& X1,
                                         Standard_Integer& Y1,
                                         Standard_Integer& X2,
                                         Standard_Integer& Y2) const Standard_OVERRIDE;
 
   //! Returns The Window SIZE in PIXEL
   Standard_EXPORT virtual void Size(Standard_Integer& theWidth,
                                     Standard_Integer& theHeight) const Standard_OVERRIDE;
 
   //! @return native Window handle
   Aspect_Drawable XWindow() const { return myXWindow; }
 
   //! @return native Window handle
   virtual Aspect_Drawable NativeHandle() const Standard_OVERRIDE { return myXWindow; }
 
   //! @return parent of native Window handle
   virtual Aspect_Drawable NativeParentHandle() const Standard_OVERRIDE { return 0; }
 
   //! @return native Window FB config (GLXFBConfig on Xlib)
   virtual Aspect_FBConfig NativeFBConfig() const Standard_OVERRIDE { return myFBConfig; }
 
   //! Sets window title.
   Standard_EXPORT virtual void SetTitle(const TCollection_AsciiString& theTitle) Standard_OVERRIDE;
 
   //! Invalidate entire window content through generation of Expose event.
   //! This method does not aggregate multiple calls into single event - dedicated event will be sent
   //! on each call. When NULL display connection is specified, the connection specified on window
   //! creation will be used. Sending exposure messages from non-window thread would require
   //! dedicated display connection opened specifically for this working thread to avoid race
   //! conditions, since Xlib display connection is not thread-safe by default.
   Standard_EXPORT virtual void InvalidateContent(const Handle(Aspect_DisplayConnection)& theDisp)
     Standard_OVERRIDE;
 
   //! Process a single window message.
   //! @param[in][out] theListener  listener to redirect message
   //! @param[in][out] theMsg message to process
   //! @return TRUE if message has been processed
   Standard_EXPORT virtual bool ProcessMessage(Aspect_WindowInputListener& theListener,
                                               XEvent&                     theMsg);
 
 protected:
   Aspect_Drawable  myXWindow;  //!< XLib window handle
   Aspect_FBConfig  myFBConfig; //!< GLXFBConfig
   Standard_Integer myXLeft;    //!< left   position in pixels
   Standard_Integer myYTop;     //!< top    position in pixels
   Standard_Integer myXRight;   //!< right  position in pixels
   Standard_Integer myYBottom;  //!< bottom position in pixels
   // clang-format off
   Standard_Boolean myIsOwnWin; //!< flag to indicate own window handle (to be deallocated on destruction)
   // clang-format on
 };
 
 DEFINE_STANDARD_HANDLE(Xw_Window, Aspect_Window)
 
 #endif // _Xw_Window_H__

This page was automatically generated by the 2.3.7 LXR engine. The LXR team