#include <GHOST_SystemNULL.h>

Inheritance diagram for GHOST_SystemNULL:

Public Member Functions
	GHOST_SystemNULL ()
	~GHOST_SystemNULL ()
bool	processEvents (bool waitForEvent)
int	toggleConsole (int action)
GHOST_TSuccess	getModifierKeys (GHOST_ModifierKeys &keys) const
GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const
GHOST_TUns8 *	getClipboard (bool selection) const
void	putClipboard (GHOST_TInt8 *buffer, bool selection) const
GHOST_TUns64	getMilliSeconds () const
GHOST_TUns8	getNumDisplays () const
GHOST_TSuccess	getCursorPosition (GHOST_TInt32 &x, GHOST_TInt32 &y) const
GHOST_TSuccess	setCursorPosition (GHOST_TInt32 x, GHOST_TInt32 y)
void	getMainDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const
GHOST_TSuccess	init ()
GHOST_IWindow *	createWindow (const STR_String &title, GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height, GHOST_TWindowState state, GHOST_TDrawingContextType type, bool stereoVisual, const GHOST_TUns16 numOfAASamples, const GHOST_TEmbedderWindowID parentWindow)

Detailed Description

Definition at line 38 of file GHOST_SystemNULL.h.

Constructor & Destructor Documentation

GHOST_SystemNULL::GHOST_SystemNULL ( ) [inline]

Definition at line 41 of file GHOST_SystemNULL.h.

GHOST_SystemNULL::~GHOST_SystemNULL ( ) [inline]

Definition at line 42 of file GHOST_SystemNULL.h.

Member Function Documentation

GHOST_IWindow* GHOST_SystemNULL::createWindow	(	const STR_String &	title,
		GHOST_TInt32	left,
		GHOST_TInt32	top,
		GHOST_TUns32	width,
		GHOST_TUns32	height,
		GHOST_TWindowState	state,
		GHOST_TDrawingContextType	type,
		bool	stereoVisual,
		const GHOST_TUns16	numOfAASamples,
		const GHOST_TEmbedderWindowID	parentWindow
	)		`[inline, 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.
numOfAASamples	Number of samples used for AA (zero if no AA)
parentWindow	Parent (embedder) window

Returns:: The new window (or 0 if creation failed).

Implements GHOST_ISystem.

Definition at line 69 of file GHOST_SystemNULL.h.

GHOST_TSuccess GHOST_SystemNULL::getButtons ( GHOST_Buttons & buttons ) const [inline, virtual]

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

Parameters:

buttons The state of the buttons.

Returns:: Indication of success.

Implements GHOST_System.

Definition at line 46 of file GHOST_SystemNULL.h.

References GHOST_kSuccess.

GHOST_TUns8* GHOST_SystemNULL::getClipboard ( bool selection ) const [inline, virtual]

Returns the selection buffer

Parameters:

selection Only used on X11

Returns:: Returns the clipboard data

Implements GHOST_System.

Definition at line 47 of file GHOST_SystemNULL.h.

References NULL.

GHOST_TSuccess GHOST_SystemNULL::getCursorPosition	(	GHOST_TInt32 &	x,
		GHOST_TInt32 &	y
	)		const `[inline, 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 51 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

void GHOST_SystemNULL::getMainDisplayDimensions	(	GHOST_TUns32 &	width,
		GHOST_TUns32 &	height
	)		const `[inline, virtual]`

Returns the dimensions of the main display on this system.

Returns:: The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 53 of file GHOST_SystemNULL.h.

GHOST_TUns64 GHOST_SystemNULL::getMilliSeconds ( ) const [inline, virtual]

Returns the system time. Returns the number of milliseconds since the start of the system process. Based on ANSI clock() routine.

Returns:: The number of milliseconds.

Reimplemented from GHOST_System.

Definition at line 49 of file GHOST_SystemNULL.h.

GHOST_TSuccess GHOST_SystemNULL::getModifierKeys ( GHOST_ModifierKeys & keys ) const [inline, 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 45 of file GHOST_SystemNULL.h.

References GHOST_kSuccess.

GHOST_TUns8 GHOST_SystemNULL::getNumDisplays ( ) const [inline, virtual]

Returns the number of displays on this system.

Returns:: The number of displays.

Implements GHOST_ISystem.

Definition at line 50 of file GHOST_SystemNULL.h.

GHOST_TSuccess GHOST_SystemNULL::init ( ) [inline, virtual]

Initialize the system.

Returns:: Indication of success.

Reimplemented from GHOST_System.

Definition at line 55 of file GHOST_SystemNULL.h.

References GHOST_kFailure, GHOST_kSuccess, and GHOST_System::m_displayManager.

bool GHOST_SystemNULL::processEvents ( bool waitForEvent ) [inline, 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 43 of file GHOST_SystemNULL.h.

void GHOST_SystemNULL::putClipboard	(	GHOST_TInt8 *	buffer,
		bool	selection
	)		const `[inline, virtual]`

Put data to the Clipboard

Parameters:

buffer	The buffer to copy to the clipboard
selection	The clipboard to copy too only used on X11

Implements GHOST_System.

Definition at line 48 of file GHOST_SystemNULL.h.

GHOST_TSuccess GHOST_SystemNULL::setCursorPosition	(	GHOST_TInt32	x,
		GHOST_TInt32	y
	)		`[inline, 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 52 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

int GHOST_SystemNULL::toggleConsole ( int action ) [inline, virtual]

Toggles console 0 - Hides 1 - Shows 2 - Toggles 3 - Hides if it runs not from command line

Does nothing
Returns:
current status (1 -visible, 0 - hidden)

Implements GHOST_ISystem.

Definition at line 44 of file GHOST_SystemNULL.h.

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

GHOST_SystemNULL.h

GHOST_SystemNULL Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation