GHOST_SystemX11 Class Reference

#include <GHOST_SystemX11.h>

Inherits GHOST_System.

Public Member Functions
	GHOST_SystemX11 ()
	~GHOST_SystemX11 ()
GHOST_TSuccess	init ()
GHOST_TUns64	getMilliSeconds () const
GHOST_TUns8	getNumDisplays () const
void	getMainDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const
void	getAllDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const
GHOST_IWindow *	createWindow (const char *title, GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height, GHOST_TWindowState state, GHOST_TDrawingContextType type, GHOST_GLSettings glSettings, const bool exclusive=false, const bool is_dialog=false, const GHOST_IWindow *parentWindow=0)
GHOST_IContext *	createOffscreenContext (GHOST_GLSettings glSettings)
GHOST_TSuccess	disposeContext (GHOST_IContext *context)
bool	processEvents (bool waitForEvent)
GHOST_TSuccess	getCursorPosition (GHOST_TInt32 &x, GHOST_TInt32 &y) const
GHOST_TSuccess	setCursorPosition (GHOST_TInt32 x, GHOST_TInt32 y)
GHOST_TSuccess	getModifierKeys (GHOST_ModifierKeys &keys) const
GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const
void	addDirtyWindow (GHOST_WindowX11 *bad_wind)
Display *	getXDisplay ()
void	getClipboard_xcout (const XEvent *evt, Atom sel, Atom target, unsigned char **txt, unsigned long *len, unsigned int *context) const
GHOST_TUns8 *	getClipboard (bool selection) const
void	putClipboard (GHOST_TInt8 *buffer, bool selection) const
int	toggleConsole (int)
Message Box
GHOST_TSuccess	showMessageBox (const char *title, const char *message, const char *help_label, const char *continue_label, const char *link, GHOST_DialogOptions dialog_options) const
Public Member Functions inherited from GHOST_System
GHOST_ITimerTask *	installTimer (GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=NULL)
GHOST_TSuccess	removeTimer (GHOST_ITimerTask *timerTask)
GHOST_TSuccess	disposeWindow (GHOST_IWindow *window)
bool	validWindow (GHOST_IWindow *window)
GHOST_TSuccess	beginFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window, const bool stereoVisual, const bool alphaBackground)
GHOST_TSuccess	updateFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window)
GHOST_TSuccess	endFullScreen (void)
bool	getFullScreen (void)
bool	useNativePixel (void)
void	useWindowFocus (const bool use_focus)
void	dispatchEvents ()
GHOST_TSuccess	addEventConsumer (GHOST_IEventConsumer *consumer)
GHOST_TSuccess	removeEventConsumer (GHOST_IEventConsumer *consumer)
GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKeyMask mask, bool &isDown) const
GHOST_TSuccess	getButtonState (GHOST_TButtonMask mask, bool &isDown) const
void	setTabletAPI (GHOST_TTabletAPI api)
GHOST_TTabletAPI	getTabletAPI (void)
GHOST_TSuccess	pushEvent (GHOST_IEvent *event)
GHOST_TimerManager *	getTimerManager () const
GHOST_EventManager *	getEventManager () const
GHOST_WindowManager *	getWindowManager () const
virtual void	initDebug (bool is_debug_enabled)
virtual bool	isDebugEnabled ()

Public Attributes
struct {
Atom   WM_STATE
Atom   WM_CHANGE_STATE
Atom   _NET_WM_STATE
Atom   _NET_WM_STATE_MAXIMIZED_HORZ
Atom   _NET_WM_STATE_MAXIMIZED_VERT
Atom   _NET_WM_STATE_FULLSCREEN
Atom   _MOTIF_WM_HINTS
Atom   WM_TAKE_FOCUS
Atom   WM_PROTOCOLS
Atom   WM_DELETE_WINDOW
Atom   TARGETS
Atom   STRING
Atom   COMPOUND_TEXT
Atom   TEXT
Atom   CLIPBOARD
Atom   PRIMARY
Atom   XCLIP_OUT
Atom   INCR
Atom   UTF8_STRING
}	m_atom
Public Attributes inherited from GHOST_System
bool	m_nativePixel
bool	m_windowFocus

Additional Inherited Members
Static Public Member Functions inherited from GHOST_ISystem
static GHOST_TSuccess	createSystem ()
static GHOST_TSuccess	disposeSystem ()
static GHOST_ISystem *	getSystem ()
Protected Member Functions inherited from GHOST_System
	GHOST_System ()
virtual	~GHOST_System ()
virtual GHOST_TSuccess	exit ()
GHOST_TSuccess	createFullScreenWindow (GHOST_Window **window, const GHOST_DisplaySetting &settings, const bool stereoVisual, const bool alphaBackground=0)
Protected Member Functions inherited from GHOST_ISystem
	GHOST_ISystem ()
virtual	~GHOST_ISystem ()
Protected Attributes inherited from GHOST_System
GHOST_DisplayManager *	m_displayManager
GHOST_TimerManager *	m_timerManager
GHOST_WindowManager *	m_windowManager
GHOST_EventManager *	m_eventManager
GHOST_DisplaySetting	m_preFullScreenSetting
GHOST_TTabletAPI	m_tabletAPI
bool	m_is_debug_enabled
Static Protected Attributes inherited from GHOST_ISystem
static GHOST_ISystem *	m_system = NULL

Detailed Description

X11 Implementation of GHOST_System class.

See also

GHOST_System.

Definition at line 76 of file GHOST_SystemX11.h.

Constructor & Destructor Documentation

GHOST_SystemX11()

GHOST_SystemX11::GHOST_SystemX11

(

)

Constructor this class should only be instantiated by GHOST_ISystem.

Definition at line 117 of file GHOST_SystemX11.cpp.

References _MOTIF_WM_HINTS, _NET_WM_STATE, _NET_WM_STATE_FULLSCREEN, _NET_WM_STATE_MAXIMIZED_HORZ, _NET_WM_STATE_MAXIMIZED_VERT, CLIPBOARD, COMPOUND_TEXT, GHOST_ASSERT, GHOST_INTERN_ATOM, GHOST_INTERN_ATOM_IF_EXISTS, GHOST_X11_ApplicationErrorHandler(), GHOST_X11_ApplicationIOErrorHandler(), INCR, m_atom, NULL, PRIMARY, STRING, TARGETS, TEXT, UTF8_STRING, WM_CHANGE_STATE, WM_DELETE_WINDOW, WM_PROTOCOLS, WM_STATE, WM_TAKE_FOCUS, and XCLIP_OUT.

~GHOST_SystemX11()

GHOST_SystemX11::~GHOST_SystemX11

(

)

Destructor.

Definition at line 240 of file GHOST_SystemX11.cpp.

Member Function Documentation

addDirtyWindow()

void GHOST_SystemX11::addDirtyWindow

(

GHOST_WindowX11 *

bad_wind

)

Flag a window as dirty. This will generate a GHOST window update event on a call to processEvents()

Definition at line 1734 of file GHOST_SystemX11.cpp.

References GHOST_ASSERT, and NULL.

Referenced by GHOST_WindowX11::invalidate().

createOffscreenContext()

GHOST_IContext * GHOST_SystemX11::createOffscreenContext ( GHOST_GLSettings  glSettings )

virtual

Create a new offscreen context. Never explicitly delete the context, use disposeContext() instead.

Returns

The new context (or 0 if creation failed).

Implements GHOST_System.

Definition at line 397 of file GHOST_SystemX11.cpp.

References context, GHOST_GLSettings::flags, GHOST_glDebugContext, GHOST_OPENGL_EGL_CONTEXT_FLAGS, GHOST_OPENGL_EGL_RESET_NOTIFICATION_STRATEGY, GHOST_OPENGL_GLX_CONTEXT_FLAGS, GHOST_OPENGL_GLX_RESET_NOTIFICATION_STRATEGY, and NULL.

createWindow()

GHOST_IWindow * GHOST_SystemX11::createWindow ( const char *  title, GHOST_TInt32  left, GHOST_TInt32  top, GHOST_TUns32  width, GHOST_TUns32  height, GHOST_TWindowState  state, GHOST_TDrawingContextType  type, GHOST_GLSettings  glSettings, const bool  exclusive = false, const bool  is_dialog = false, const GHOST_IWindow *  parentWindow = 0  )

virtual

Create a new window. The new window is added to the list of windows managed. Never explicitly delete the window, use disposeWindow() instead.

Parameters

title	The name of the window. (displayed in the title bar of the window if the OS supports it).
left	The coordinate of the left edge of the window.
top	The coordinate of the top edge of the window.
width	The width the window.
height	The height the window.
state	The state of the window when opened.
type	The type of drawing context installed in this window.
stereoVisual	Create a stereo visual for quad buffered stereo.
exclusive	Use to show the window ontop and ignore others (used full*screen).
parentWindow	Parent (embedder) window.

Returns

The new window (or 0 if creation failed).

Create a new window. The new window is added to the list of windows managed. Never explicitly delete the window, use disposeWindow() instead.

Parameters

title	The name of the window (displayed in the title bar of the window if the OS supports it).
left	The coordinate of the left edge of the window.
top	The coordinate of the top edge of the window.
width	The width the window.
height	The height the window.
state	The state of the window when opened.
type	The type of drawing context installed in this window.
glSettings	Misc OpenGL settings.
exclusive	Use to show the window on top and ignore others (used full-screen).
parentWindow	Parent window.

Returns

The new window (or 0 if creation failed).

Implements GHOST_ISystem.

Definition at line 341 of file GHOST_SystemX11.cpp.

References GHOST_WindowManager::addWindow(), GHOST_GLSettings::flags, getMilliSeconds(), GHOST_WindowX11::getValid(), GHOST_glAlphaBackground, GHOST_glDebugContext, GHOST_glStereoVisual, GHOST_kEventWindowSize, height, left, GHOST_System::m_windowManager, NULL, GHOST_System::pushEvent(), GHOST_WindowManager::setActiveWindow(), state, top, type, and width.

disposeContext()

GHOST_TSuccess GHOST_SystemX11::disposeContext ( GHOST_IContext *  context )

virtual

Dispose of a context.

Parameters

context

Pointer to the context to be disposed.

Returns

Indication of success.

Implements GHOST_ISystem.

Definition at line 510 of file GHOST_SystemX11.cpp.

References context, and GHOST_kSuccess.

getAllDisplayDimensions()

void GHOST_SystemX11::getAllDisplayDimensions ( GHOST_TUns32 &  width, GHOST_TUns32 &  height  ) const

virtual

Returns the dimensions of all displays on this system.

Returns

The dimension of the main display.

Returns the dimensions of the main display on this system.

Returns

The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 316 of file GHOST_SystemX11.cpp.

References height, and width.

Referenced by getMainDisplayDimensions().

getButtons()

GHOST_TSuccess GHOST_SystemX11::getButtons ( GHOST_Buttons &  buttons ) const

virtual

Returns the state of the mouse buttons (outside the message queue).

Parameters

buttons

The state of the buttons.

Returns

Indication of success.

Implements GHOST_System.

Definition at line 1617 of file GHOST_SystemX11.cpp.

References GHOST_kButtonMaskLeft, GHOST_kButtonMaskMiddle, GHOST_kButtonMaskRight, GHOST_kFailure, GHOST_kSuccess, and GHOST_Buttons::set().

getClipboard()

GHOST_TUns8 * GHOST_SystemX11::getClipboard ( bool  selection ) const

virtual

Returns unsigned char from CUT_BUFFER0

Parameters

selection

Get selection, X11 only feature.

Returns

Returns the Clipboard indicated by Flag.

Implements GHOST_System.

Definition at line 2142 of file GHOST_SystemX11.cpp.

References context, free(), getClipboard_xcout(), GHOST_WindowManager::getWindows(), GHOST_WindowX11::getXWindow(), m_atom, GHOST_System::m_windowManager, NULL, txt_cut_buffer, txt_select_buffer, XCLIB_XCOUT_FALLBACK, XCLIB_XCOUT_FALLBACK_COMP, XCLIB_XCOUT_FALLBACK_TEXT, XCLIB_XCOUT_FALLBACK_UTF8, and XCLIB_XCOUT_NONE.

getClipboard_xcout()

void GHOST_SystemX11::getClipboard_xcout	(	const XEvent *	evt,
		Atom	sel,
		Atom	target,
		unsigned char **	txt,
		unsigned long *	len,
		unsigned int *	context
	)		const

Helped function for get data from the clipboard.

Definition at line 1940 of file GHOST_SystemX11.cpp.

References buffer, context, free(), GHOST_WindowManager::getWindows(), GHOST_WindowX11::getXWindow(), len, m_atom, GHOST_System::m_windowManager, XCLIB_XCOUT_FALLBACK_COMP, XCLIB_XCOUT_FALLBACK_TEXT, XCLIB_XCOUT_FALLBACK_UTF8, XCLIB_XCOUT_INCR, XCLIB_XCOUT_NONE, and XCLIB_XCOUT_SENTCONVSEL.

Referenced by getClipboard().

getCursorPosition()

GHOST_TSuccess GHOST_SystemX11::getCursorPosition ( GHOST_TInt32 &  x, GHOST_TInt32 &  y  ) const

virtual

Returns the current location of the cursor (location in screen coordinates)

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns

Indication of success.

Implements GHOST_ISystem.

Definition at line 1670 of file GHOST_SystemX11.cpp.

References getCursorPosition_impl(), x, and y.

Referenced by setCursorPosition(), and GHOST_WindowX11::setWindowCursorGrab().

getMainDisplayDimensions()

void GHOST_SystemX11::getMainDisplayDimensions ( GHOST_TUns32 &  width, GHOST_TUns32 &  height  ) const

virtual

Returns the dimensions of the main display on this system.

Returns

The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 302 of file GHOST_SystemX11.cpp.

References getAllDisplayDimensions(), height, and width.

getMilliSeconds()

GHOST_TUns64 GHOST_SystemX11::getMilliSeconds ( ) const

virtual

Inherited from GHOST_ISystem

Returns the system time. Returns the number of milliseconds since the start of the system process.

Returns

The number of milliseconds.

Reimplemented from GHOST_System.

Definition at line 282 of file GHOST_SystemX11.cpp.

References GHOST_ASSERT, and NULL.

Referenced by createWindow(), and processEvents().

getModifierKeys()

GHOST_TSuccess GHOST_SystemX11::getModifierKeys ( GHOST_ModifierKeys &  keys ) const

virtual

Returns the state of all modifier keys.

Parameters

keys	The state of all modifier keys (true == pressed).

Returns

Indication of success.

Implements GHOST_System.

Definition at line 1576 of file GHOST_SystemX11.cpp.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, GHOST_kSuccess, and GHOST_ModifierKeys::set().

getNumDisplays()

GHOST_TUns8 GHOST_SystemX11::getNumDisplays ( ) const

virtual

Returns the number of displays on this system.

Returns

The number of displays.

Implements GHOST_ISystem.

Definition at line 293 of file GHOST_SystemX11.cpp.

Referenced by GHOST_DisplayManagerX11::getNumDisplays().

getXDisplay()

Display* GHOST_SystemX11::getXDisplay ( )

inline

return a pointer to the X11 display structure

Definition at line 200 of file GHOST_SystemX11.h.

Referenced by GHOST_DisplayManagerX11::getDisplaySetting(), GHOST_DisplayManagerX11::getNumDisplaySettings(), GHOST_DropTargetX11::GHOST_HandleClientMessage(), and GHOST_DisplayManagerX11::setCurrentDisplaySetting().

init()

GHOST_TSuccess GHOST_SystemX11::init ( void  )

virtual

Initialize the system.

Returns

Indication of success.

Reimplemented from GHOST_System.

Definition at line 264 of file GHOST_SystemX11.cpp.

References GHOST_kFailure, GHOST_kSuccess, GHOST_System::init(), and GHOST_System::m_displayManager.

processEvents()

bool GHOST_SystemX11::processEvents ( bool  waitForEvent )

virtual

Retrieves events from the system and stores them in the queue.

Parameters

waitForEvent

Flag to wait for an event (or return immediately).

Returns

Indication of the presence of events.

Implements GHOST_ISystem.

Definition at line 641 of file GHOST_SystemX11.cpp.

References GHOST_TimerManager::fireTimers(), getMilliSeconds(), GHOST_System::getTimerManager(), GHOST_kEventKeyDown, ghost_key_from_keysym(), GHOST_kFireTimeNever, GHOST_PRINT, next, GHOST_TimerManager::nextFireTime(), NULL, GHOST_System::pushEvent(), and SleepTillEvent().

putClipboard()

void GHOST_SystemX11::putClipboard ( GHOST_TInt8 *  buffer, bool  selection  ) const

virtual

Puts buffer to system clipboard

Parameters

buffer	The buffer to copy to the clipboard.
selection	Set the selection into the clipboard, X11 only feature.

Implements GHOST_System.

Definition at line 2248 of file GHOST_SystemX11.cpp.

References buffer, free(), GHOST_WindowManager::getWindows(), GHOST_WindowX11::getXWindow(), m_atom, GHOST_System::m_windowManager, txt_cut_buffer, and txt_select_buffer.

setCursorPosition()

GHOST_TSuccess GHOST_SystemX11::setCursorPosition ( GHOST_TInt32  x, GHOST_TInt32  y  )

virtual

Updates the location of the cursor (location in screen coordinates). Not all operating systems allow the cursor to be moved (without the input device being moved).

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns

Indication of success.

Implements GHOST_ISystem.

Definition at line 1676 of file GHOST_SystemX11.cpp.

References getCursorPosition(), getCursorPosition_impl(), GHOST_kFailure, GHOST_kSuccess, x, and y.

Referenced by GHOST_WindowX11::beginFullScreen(), and GHOST_WindowX11::setWindowCursorGrab().

showMessageBox()

GHOST_TSuccess GHOST_SystemX11::showMessageBox ( const char *  title, const char *  message, const char *  help_label, const char *  continue_label, const char *  link, GHOST_DialogOptions  dialog_options  ) const

virtual

Show a system message box

Parameters

title	The title of the message box.
message	The message to display.
help_label	Help button label.
continue_label	Continue button label.
link	An optional hyperlink.
dialog_options	Options how to display the message.

Reimplemented from GHOST_System.

Definition at line 2383 of file GHOST_SystemX11.cpp.

References DialogData::drawButton(), e, free(), GHOST_kSuccess, GHOST_PRINTF, DialogData::height, DialogData::isInsideButton(), DialogData::line_height, NULL, DialogData::padding_x, split(), and DialogData::width.

toggleConsole()

int GHOST_SystemX11::toggleConsole ( int  )

inlinevirtual

See also

GHOST_ISystem

Implements GHOST_ISystem.

Definition at line 272 of file GHOST_SystemX11.h.

Member Data Documentation

_MOTIF_WM_HINTS

Atom GHOST_SystemX11::_MOTIF_WM_HINTS

Definition at line 311 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::setDialogHints().

_NET_WM_STATE

Atom GHOST_SystemX11::_NET_WM_STATE

Definition at line 307 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

_NET_WM_STATE_FULLSCREEN

Atom GHOST_SystemX11::_NET_WM_STATE_FULLSCREEN

Definition at line 310 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

_NET_WM_STATE_MAXIMIZED_HORZ

Atom GHOST_SystemX11::_NET_WM_STATE_MAXIMIZED_HORZ

Definition at line 308 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

_NET_WM_STATE_MAXIMIZED_VERT

Atom GHOST_SystemX11::_NET_WM_STATE_MAXIMIZED_VERT

Definition at line 309 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

CLIPBOARD

Atom GHOST_SystemX11::CLIPBOARD

Definition at line 321 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

COMPOUND_TEXT

Atom GHOST_SystemX11::COMPOUND_TEXT

Definition at line 319 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

INCR

Atom GHOST_SystemX11::INCR

Definition at line 324 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

struct { ... } GHOST_SystemX11::m_atom

Referenced by getClipboard(), getClipboard_xcout(), GHOST_SystemX11(), GHOST_WindowX11::GHOST_WindowX11(), putClipboard(), and GHOST_WindowX11::setDialogHints().

PRIMARY

Atom GHOST_SystemX11::PRIMARY

Definition at line 322 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

STRING

Atom GHOST_SystemX11::STRING

Definition at line 318 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

TARGETS

Atom GHOST_SystemX11::TARGETS

Definition at line 317 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

TEXT

Atom GHOST_SystemX11::TEXT

Definition at line 320 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

UTF8_STRING

Atom GHOST_SystemX11::UTF8_STRING

Definition at line 325 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

WM_CHANGE_STATE

Atom GHOST_SystemX11::WM_CHANGE_STATE

Definition at line 306 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

WM_DELETE_WINDOW

Atom GHOST_SystemX11::WM_DELETE_WINDOW

Definition at line 314 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

WM_PROTOCOLS

Atom GHOST_SystemX11::WM_PROTOCOLS

Definition at line 313 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

WM_STATE

Atom GHOST_SystemX11::WM_STATE

Atom used for ICCCM, WM-spec and Motif. We only need get this atom at the start, it's relative to the display not the window and are public for every window that need it.

Definition at line 305 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

WM_TAKE_FOCUS

Atom GHOST_SystemX11::WM_TAKE_FOCUS

Definition at line 312 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11(), and GHOST_WindowX11::GHOST_WindowX11().

XCLIP_OUT

Atom GHOST_SystemX11::XCLIP_OUT

Definition at line 323 of file GHOST_SystemX11.h.

Referenced by GHOST_SystemX11().

---

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

• GHOST_SystemX11.h
• GHOST_SystemX11.cpp