#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 * >	windows_
GHOST_IWindow *	active_window_

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.

Definition at line 18 of file GHOST_WindowManager.cc.

References active_window_, and nullptr.

◆ ~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 windows_.

◆ 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 77 of file GHOST_WindowManager.cc.

References active_window_.

Referenced by GHOST_SystemWin32::driveTrackpad(), gwl_window_frame_update_from_pending_no_lock(), and GHOST_SystemWin32::processTrackpad().

◆ 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 94 of file GHOST_WindowManager.cc.

References windows_.

◆ 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 50 of file GHOST_WindowManager.cc.

References result, and windows_.

Referenced by addWindow(), and setActiveWindow().

◆ 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 89 of file GHOST_WindowManager.cc.

References windows_.

Referenced by GHOST_SystemWayland::output_scale_update(), GHOST_SystemWayland::output_unref(), and GHOST_SystemWin32::setTabletAPI().

◆ 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, result, setWindowInactive(), and windows_.

◆ 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 63 of file GHOST_WindowManager.cc.

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

Referenced by 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 82 of file GHOST_WindowManager.cc.

References active_window_.

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

Member Data Documentation

◆ active_window_

GHOST_IWindow* GHOST_WindowManager::active_window_

protected

The active window.

Definition at line 92 of file GHOST_WindowManager.hh.

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

◆ windows_

std::vector<GHOST_IWindow *> GHOST_WindowManager::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:

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_WindowManager()

◆ ~GHOST_WindowManager()

Member Function Documentation

◆ addWindow()

◆ getActiveWindow()

◆ getWindowAssociatedWithOSWindow()

◆ getWindowFound()

◆ getWindows()

◆ removeWindow()

◆ setActiveWindow()

◆ setWindowInactive()

Member Data Documentation

◆ active_window_

◆ windows_