Aspect_DisplayConnection Class Reference

This class creates and provides connection with X server. Raises exception if can not connect to X server. On Windows and Mac OS X (in case when Cocoa used) platforms this class does nothing. WARNING: Do not close display connection manually! More...

#include <Aspect_DisplayConnection.hxx>

Inheritance diagram for Aspect_DisplayConnection:

Public Member Functions
	Aspect_DisplayConnection ()
	Default constructor. Creates connection with display name taken from "DISPLAY" environment variable.
virtual	~Aspect_DisplayConnection ()
	Destructor. Close opened connection.
	Aspect_DisplayConnection (const TCollection_AsciiString &theDisplayName)
	Constructor. Creates connection with display specified in theDisplayName. Display name should be in format "hostname:number" or "hostname:number.screen_number", where: hostname - Specifies the name of the host machine on which the display is physically attached. number - Specifies the number of the display server on that host machine. screen_number - Specifies the screen to be used on that server. Optional variable.
	Aspect_DisplayConnection (Aspect_XDisplay *theDisplay)
	Constructor wrapping existing Display instance. WARNING! it is a responsibility of application to keep this pointer valid while Aspect_DisplayConnection is alive and to close Display when it is no more needed.
Aspect_XDisplay *	GetDisplayAspect ()
Standard_Boolean	IsOwnDisplay () const
uint64_t	GetAtom (const Aspect_XAtom theAtom) const
const TCollection_AsciiString &	GetDisplayName ()
void	Init (Aspect_XDisplay *theDisplay)
	Open connection with display specified in myDisplayName class field or takes theDisplay parameter when it is not NULL. WARNING! When external Display is specified, it is a responsibility of application to keep this pointer valid while Aspect_DisplayConnection is alive and to close Display when it is no more needed.
Aspect_XVisualInfo *	GetDefaultVisualInfo () const
	Return default window visual or NULL when undefined.
Aspect_FBConfig	GetDefaultFBConfig () const
void	SetDefaultVisualInfo (Aspect_XVisualInfo *theVisual, Aspect_FBConfig theFBConfig)
	Set default window visual; the visual will be deallocated using XFree().
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

This class creates and provides connection with X server. Raises exception if can not connect to X server. On Windows and Mac OS X (in case when Cocoa used) platforms this class does nothing. WARNING: Do not close display connection manually!

Constructor & Destructor Documentation

Aspect_DisplayConnection() [1/3]

Aspect_DisplayConnection::Aspect_DisplayConnection

(

)

Default constructor. Creates connection with display name taken from "DISPLAY" environment variable.

~Aspect_DisplayConnection()

virtual Aspect_DisplayConnection::~Aspect_DisplayConnection ( )

virtual

Destructor. Close opened connection.

Aspect_DisplayConnection() [2/3]

Aspect_DisplayConnection::Aspect_DisplayConnection

(

const TCollection_AsciiString &

theDisplayName

)

Constructor. Creates connection with display specified in theDisplayName. Display name should be in format "hostname:number" or "hostname:number.screen_number", where: hostname - Specifies the name of the host machine on which the display is physically attached. number - Specifies the number of the display server on that host machine. screen_number - Specifies the screen to be used on that server. Optional variable.

Aspect_DisplayConnection() [3/3]

Aspect_DisplayConnection::Aspect_DisplayConnection

(

Aspect_XDisplay *

theDisplay

)

Constructor wrapping existing Display instance. WARNING! it is a responsibility of application to keep this pointer valid while Aspect_DisplayConnection is alive and to close Display when it is no more needed.

Member Function Documentation

GetAtom()

uint64_t Aspect_DisplayConnection::GetAtom ( const Aspect_XAtom theAtom ) const

inline

Returns

identifier(atom) for custom named property associated with windows that use current connection to X server.

GetDefaultFBConfig()

Aspect_FBConfig Aspect_DisplayConnection::GetDefaultFBConfig ( ) const

inline

Returns

native Window FB config (GLXFBConfig on Xlib)

GetDefaultVisualInfo()

Aspect_XVisualInfo * Aspect_DisplayConnection::GetDefaultVisualInfo ( ) const

inline

Return default window visual or NULL when undefined.

GetDisplayAspect()

Aspect_XDisplay * Aspect_DisplayConnection::GetDisplayAspect ( )

inline

Returns

pointer to Display structure that serves as the connection to the X server.

GetDisplayName()

const TCollection_AsciiString & Aspect_DisplayConnection::GetDisplayName ( )

inline

Returns

display name for this connection.

Init()

void Aspect_DisplayConnection::Init

(

Aspect_XDisplay *

theDisplay

)

Open connection with display specified in myDisplayName class field or takes theDisplay parameter when it is not NULL. WARNING! When external Display is specified, it is a responsibility of application to keep this pointer valid while Aspect_DisplayConnection is alive and to close Display when it is no more needed.

Parameters

theDisplay

external pointer to allocated Display, or NULL if new connection should be created

IsOwnDisplay()

Standard_Boolean Aspect_DisplayConnection::IsOwnDisplay ( ) const

inline

Returns

TRUE if X Display has been allocated by this class

SetDefaultVisualInfo()

void Aspect_DisplayConnection::SetDefaultVisualInfo	(	Aspect_XVisualInfo *	theVisual,
		Aspect_FBConfig	theFBConfig )

Set default window visual; the visual will be deallocated using XFree().

---

The documentation for this class was generated from the following file:

• Aspect_DisplayConnection.hxx