GHOST_WindowManager Class Reference

#include <GHOST_WindowManager.hh>

Public Member Functions
	GHOST_WindowManager ()
	~GHOST_WindowManager ()
GHOST_TSuccess	addWindow (GHOST_IWindow *window)
GHOST_TSuccess	removeWindow (const GHOST_IWindow *window)
bool	getWindowFound (const GHOST_IWindow *window) const
GHOST_TSuccess	setActiveWindow (GHOST_IWindow *window)
GHOST_IWindow *	getActiveWindow () const
void	setWindowInactive (const GHOST_IWindow *window)
const std::vector< GHOST_IWindow * > &	getWindows () const
GHOST_IWindow *	getWindowAssociatedWithOSWindow (const void *osWindow)

Protected Attributes
std::vector< GHOST_IWindow * >	m_windows
GHOST_IWindow *	m_activeWindow

Detailed Description

Manages system windows (platform independent implementation).

Definition at line 19 of file GHOST_WindowManager.hh.

Constructor & Destructor Documentation

GHOST_WindowManager()

GHOST_WindowManager::GHOST_WindowManager

(

)

Constructor.

Copyright (C) 2001 NaN Technologies B.V.

Definition at line 18 of file GHOST_WindowManager.cc.

~GHOST_WindowManager()

GHOST_WindowManager::~GHOST_WindowManager ( )

default

Destructor.

Member Function Documentation

addWindow()

GHOST_TSuccess GHOST_WindowManager::addWindow

(

GHOST_IWindow *

window

)

Add a window to our list. It is only added if it is not already in the list.

Parameters

window

Pointer to the window to be added.

Returns

Indication of success.

Definition at line 23 of file GHOST_WindowManager.cc.

References getWindowFound(), GHOST_kFailure, GHOST_kSuccess, and m_windows.

Referenced by GHOST_SystemWayland::createWindow(), GHOST_SystemWin32::createWindow(), and GHOST_SystemX11::createWindow().

getActiveWindow()

GHOST_IWindow * GHOST_WindowManager::getActiveWindow

(

)

const

Returns the active window (the window receiving events). There can be only one window active which should be in the current window list.

Returns

window The active window (or nullptr if there is none).

Definition at line 78 of file GHOST_WindowManager.cc.

References m_activeWindow.

Referenced by GHOST_SystemWin32::driveTrackpad(), gwl_window_activate(), gwl_window_frame_update_from_pending_no_lock(), GHOST_SystemWin32::processTrackpad(), GHOST_NDOFManager::sendMotionEvent(), GHOST_WindowWayland::setWindowCursorShape(), GHOST_WindowWayland::setWindowCustomCursorShape(), and GHOST_NDOFManager::updateButton().

getWindowAssociatedWithOSWindow()

GHOST_IWindow * GHOST_WindowManager::getWindowAssociatedWithOSWindow

(

const void *

osWindow

)

Finds the window associated with an OS window object/handle.

Parameters

osWindow

The OS window object/handle.

Returns

The associated window, null if none corresponds.

Definition at line 95 of file GHOST_WindowManager.cc.

References m_windows.

Referenced by GHOST_SystemWin32::getWindowUnderCursor().

getWindowFound()

bool GHOST_WindowManager::getWindowFound

(

const GHOST_IWindow *

window

)

const

Returns whether the window is in our list.

Parameters

window

Pointer to the window to query.

Returns

A boolean indicator.

Definition at line 51 of file GHOST_WindowManager.cc.

References m_windows, and result.

Referenced by addWindow(), GHOST_System::disposeWindow(), setActiveWindow(), and GHOST_System::validWindow().

getWindows()

const std::vector< GHOST_IWindow * > & GHOST_WindowManager::getWindows

(

)

const

Return a vector of the windows currently managed by this class.

Returns

Constant reference to the vector of windows managed

Definition at line 90 of file GHOST_WindowManager.cc.

References m_windows.

Referenced by GHOST_SystemX11::getClipboard(), GHOST_SystemX11::getClipboard_xcout(), GHOST_System::getWindowUnderCursor(), GHOST_SystemWayland::output_scale_update(), GHOST_SystemWayland::output_unref(), GHOST_SystemWayland::processEvents(), GHOST_SystemX11::putClipboard(), GHOST_SystemWin32::setTabletAPI(), and GHOST_WindowWin32::~GHOST_WindowWin32().

removeWindow()

GHOST_TSuccess GHOST_WindowManager::removeWindow

(

const GHOST_IWindow *

window

)

Remove a window from our list.

Parameters

window

Pointer to the window to be removed.

Returns

Indication of success.

Definition at line 36 of file GHOST_WindowManager.cc.

References GHOST_kFailure, GHOST_kSuccess, m_windows, result, and setWindowInactive().

Referenced by GHOST_System::disposeWindow().

setActiveWindow()

GHOST_TSuccess GHOST_WindowManager::setActiveWindow

(

GHOST_IWindow *

window

)

Sets new window as active window (the window receiving events). There can be only one window active which should be in the current window list.

Parameters

window

The new active window.

Definition at line 64 of file GHOST_WindowManager.cc.

References getWindowFound(), GHOST_kFailure, GHOST_kSuccess, and m_activeWindow.

Referenced by GHOST_WindowWayland::activate(), GHOST_SystemWayland::createWindow(), GHOST_SystemWin32::createWindow(), GHOST_SystemX11::createWindow(), GHOST_SystemWayland::processEvents(), and GHOST_SystemWin32::processWindowEvent().

setWindowInactive()

void GHOST_WindowManager::setWindowInactive

(

const GHOST_IWindow *

window

)

Set this window to be inactive (not receiving events).

Parameters

window

The window to deactivate.

Definition at line 83 of file GHOST_WindowManager.cc.

References m_activeWindow.

Referenced by GHOST_WindowWayland::deactivate(), GHOST_SystemWayland::processEvents(), GHOST_SystemWin32::processWindowEvent(), and removeWindow().

Member Data Documentation

m_activeWindow

GHOST_IWindow* GHOST_WindowManager::m_activeWindow

protected

The active window.

Definition at line 92 of file GHOST_WindowManager.hh.

Referenced by getActiveWindow(), setActiveWindow(), and setWindowInactive().

m_windows

std::vector<GHOST_IWindow *> GHOST_WindowManager::m_windows

protected

The list of windows managed

Definition at line 89 of file GHOST_WindowManager.hh.

Referenced by addWindow(), getWindowAssociatedWithOSWindow(), getWindowFound(), getWindows(), and removeWindow().

---

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

• GHOST_WindowManager.hh
• GHOST_WindowManager.cc