Texture window manager. More...

#include <gui_window_manager_texture.h>

Inheritance diagram for CL_GUIWindowManagerTexture:

Public Types
Enumerations

enum	CL_WindowManagerType { cl_wm_type_system, cl_wm_type_texture }
Public Member Functions
Construction

	CL_GUIWindowManagerTexture ()
	Constructs a null instance.
	CL_GUIWindowManagerTexture (CL_DisplayWindow display_window)
	Constructs a GUIWindowManagerTexture.
	CL_GUIWindowManagerTexture (const CL_GUIWindowManager &wm)
	~CL_GUIWindowManagerTexture ()
Attributes

CL_GUIWindowManagerProvider_Texture *	get_provider () const
	Retrieves the provider.
std::vector < CL_GUIWindowManagerTextureWindow >	get_windows (bool only_visible=true) const
	Get the window textures.
Events

CL_Callback_v0 &	func_repaint ()
	void func_repaint()
CL_Callback_v1< CL_FrameBuffer & > &	func_setup_framebuffer ()
	void func_setup_framebuffer(CL_FrameBuffer &fb)
CL_Callback_v2< CL_InputEvent &, CL_InputState & > &	func_input_intercept ()
	void func_input_intercept(CL_InputEvent &input_event, CL_InputState &input_state)
Operations

void	set_texture_group (CL_TextureGroup &new_texture_group)
	Set texture group.
void	draw_windows (CL_GraphicContext &gc)
	Draw the windows.
void	process ()
	Process the windows.
Attributes

bool	is_null () const
	Is Null.
CL_WindowManagerType	get_window_manager_type () const
	Get Window manager type.
Operations

void	set_site (CL_GUIWindowManagerSite *site)
	Set site.
void	create_window (CL_GUITopLevelWindow handle, CL_GUITopLevelWindow owner, CL_GUIComponent *component, CL_GUITopLevelDescription description)
void	destroy_window (CL_GUITopLevelWindow *handle)
	Destroy window.
void	enable_window (CL_GUITopLevelWindow *handle, bool enable)
	Enable window.
bool	has_focus (CL_GUITopLevelWindow *handle) const
	Has focus.
void	set_visible (CL_GUITopLevelWindow *handle, bool visible, bool activate_root_win)
	Set visible.
void	set_geometry (CL_GUITopLevelWindow *handle, const CL_Rect &geometry, bool client_area)
	Set geometry.
CL_Rect	get_geometry (CL_GUITopLevelWindow *handle, bool client_area) const
	Get geometry.
CL_Point	screen_to_window (CL_GUITopLevelWindow *handle, const CL_Point &screen_point, bool client_area) const
	Screen to window.
CL_Point	window_to_screen (CL_GUITopLevelWindow *handle, const CL_Point &window_point, bool client_area) const
	Window to screen.
CL_GraphicContext &	get_gc (CL_GUITopLevelWindow *handle) const
	Get gc.
CL_InputContext &	get_ic (CL_GUITopLevelWindow *handle) const
	Get ic.
CL_GraphicContext	begin_paint (CL_GUITopLevelWindow *handle, const CL_Rect &update_region)
	Begin paint.
void	set_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc, const CL_Rect &rect)
	Set cliprect.
void	reset_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc)
	Reset cliprect.
void	push_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc, const CL_Rect &rect)
	Push cliprect.
void	pop_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc)
	Pop cliprect.
void	end_paint (CL_GUITopLevelWindow *handle, const CL_Rect &update_region)
	End paint.
void	request_repaint (CL_GUITopLevelWindow *handle, const CL_Rect &update_region)
	Request repaint.
void	bring_to_front (CL_GUITopLevelWindow *handle)
	Bring to front.
bool	is_minimized (CL_GUITopLevelWindow *handle) const
	Is minimized.
bool	is_maximized (CL_GUITopLevelWindow *handle) const
	Is maximized.
void	process_message ()
	Process message.
void	capture_mouse (CL_GUITopLevelWindow *handle, bool state)
	Capture mouse.
CL_DisplayWindow	get_display_window (CL_GUITopLevelWindow *handle) const
	Get display window.
void	set_cursor (CL_GUITopLevelWindow *handle, const CL_Cursor &cursor)
	Set cursor.
void	set_cursor (CL_GUITopLevelWindow *handle, enum CL_StandardCursor type)
	Set cursor.
void	update ()
	Perform any updates.
void	setup_painting ()
	Initial setup for painting all top level windows.
void	complete_painting ()
	Final completion for painting all top level windows.

Detailed Description

Texture window manager.

Member Enumeration Documentation

enum CL_GUIWindowManager::CL_WindowManagerType [inherited]

Enumerator:

cl_wm_type_system
cl_wm_type_texture

Constructor & Destructor Documentation

CL_GUIWindowManagerTexture::CL_GUIWindowManagerTexture ( )

Constructs a null instance.

CL_GUIWindowManagerTexture::CL_GUIWindowManagerTexture ( CL_DisplayWindow display_window )

Constructs a GUIWindowManagerTexture.

Parameters:

display_window

= Display Window

CL_GUIWindowManagerTexture::CL_GUIWindowManagerTexture ( const CL_GUIWindowManager & wm )

CL_GUIWindowManagerTexture::~CL_GUIWindowManagerTexture ( )

Member Function Documentation

CL_GraphicContext CL_GUIWindowManager::begin_paint	(	CL_GUITopLevelWindow *	handle,
		const CL_Rect &	update_region
	)			`[inherited]`

Begin paint.

Parameters:

	handle	= GUITop Level Window
	update_region	= Rect

Returns:: Graphic Context

void CL_GUIWindowManager::bring_to_front ( CL_GUITopLevelWindow * handle ) [inherited]

Bring to front.

Parameters:

handle

= GUITop Level Window

void CL_GUIWindowManager::capture_mouse	(	CL_GUITopLevelWindow *	handle,
		bool	state
	)			`[inherited]`

Capture mouse.

Parameters:

	handle	= GUITop Level Window
	state	= bool

void CL_GUIWindowManager::complete_painting ( ) [inherited]

Final completion for painting all top level windows.

void CL_GUIWindowManager::create_window	(	CL_GUITopLevelWindow *	handle,
		CL_GUITopLevelWindow *	owner,
		CL_GUIComponent *	component,
		CL_GUITopLevelDescription	description
	)			`[inherited]`

void CL_GUIWindowManager::destroy_window ( CL_GUITopLevelWindow * handle ) [inherited]

Destroy window.

Parameters:

handle

= GUITop Level Window

void CL_GUIWindowManagerTexture::draw_windows ( CL_GraphicContext & gc )

Draw the windows.

This is a convenience function than can be used when func_repaint() is overridden

Parameters:

gc

= Graphic Context

void CL_GUIWindowManager::enable_window	(	CL_GUITopLevelWindow *	handle,
		bool	enable
	)			`[inherited]`

Enable window.

Parameters:

	handle	= GUITop Level Window
	enable	= bool

void CL_GUIWindowManager::end_paint	(	CL_GUITopLevelWindow *	handle,
		const CL_Rect &	update_region
	)			`[inherited]`

End paint.

Parameters:

	handle	= GUITop Level Window
	update_region	= Rect

CL_Callback_v2<CL_InputEvent &, CL_InputState &>& CL_GUIWindowManagerTexture::func_input_intercept ( )

void func_input_intercept(CL_InputEvent &input_event, CL_InputState &input_state)

CL_Callback_v0& CL_GUIWindowManagerTexture::func_repaint ( )

void func_repaint()

CL_Callback_v1<CL_FrameBuffer &>& CL_GUIWindowManagerTexture::func_setup_framebuffer ( )

void func_setup_framebuffer(CL_FrameBuffer &fb)

CL_DisplayWindow CL_GUIWindowManager::get_display_window ( CL_GUITopLevelWindow * handle ) const [inherited]

Get display window.

Parameters:

handle

= GUITop Level Window

Returns:: Display Window

CL_GraphicContext& CL_GUIWindowManager::get_gc ( CL_GUITopLevelWindow * handle ) const [inherited]

Get gc.

Parameters:

handle

= GUITop Level Window

Returns:: Graphic Context

CL_Rect CL_GUIWindowManager::get_geometry	(	CL_GUITopLevelWindow *	handle,
		bool	client_area
	)			const `[inherited]`

Get geometry.

Parameters:

	handle	= GUITop Level Window
	client_area	= bool

Returns:: Rect

CL_InputContext& CL_GUIWindowManager::get_ic ( CL_GUITopLevelWindow * handle ) const [inherited]

Get ic.

Parameters:

handle

= GUITop Level Window

Returns:: Input Context

CL_GUIWindowManagerProvider_Texture* CL_GUIWindowManagerTexture::get_provider ( ) const

Retrieves the provider.

Reimplemented from CL_GUIWindowManager.

CL_WindowManagerType CL_GUIWindowManager::get_window_manager_type ( ) const [inherited]

Get Window manager type.

Returns:: window_manager_type

std::vector<CL_GUIWindowManagerTextureWindow> CL_GUIWindowManagerTexture::get_windows ( bool only_visible = true ) const

Get the window textures.

Parameters:

only_visible

= True = Only return windows when they are visible

Returns:: The window textures

bool CL_GUIWindowManager::has_focus ( CL_GUITopLevelWindow * handle ) const [inherited]

Has focus.

Parameters:

handle

= GUITop Level Window

Returns:: bool

bool CL_GUIWindowManager::is_maximized ( CL_GUITopLevelWindow * handle ) const [inherited]

Is maximized.

Parameters:

handle

= GUITop Level Window

Returns:: bool

bool CL_GUIWindowManager::is_minimized ( CL_GUITopLevelWindow * handle ) const [inherited]

Is minimized.

Parameters:

handle

= GUITop Level Window

Returns:: bool

bool CL_GUIWindowManager::is_null ( ) const [inherited]

Is Null.

Returns:: true = null

void CL_GUIWindowManager::pop_cliprect	(	CL_GUITopLevelWindow *	handle,
		CL_GraphicContext &	gc
	)			`[inherited]`

Pop cliprect.

Parameters:

	handle	= GUITop Level Window
	gc	= Graphic Context

void CL_GUIWindowManagerTexture::process ( )

Process the windows.

Can you use this function if you do not want the CL_GUIManager to control the application main loop
Use draw_windows() after this to draw the windows to the screen

void CL_GUIWindowManager::process_message ( ) [inherited]

Process message.

void CL_GUIWindowManager::push_cliprect	(	CL_GUITopLevelWindow *	handle,
		CL_GraphicContext &	gc,
		const CL_Rect &	rect
	)			`[inherited]`

Push cliprect.

Parameters:

	handle	= GUITop Level Window
	gc	= Graphic Context
	rect	= Clip rect

void CL_GUIWindowManager::request_repaint	(	CL_GUITopLevelWindow *	handle,
		const CL_Rect &	update_region
	)			`[inherited]`

Request repaint.

Parameters:

	handle	= GUITop Level Window
	update_region	= Rect

void CL_GUIWindowManager::reset_cliprect	(	CL_GUITopLevelWindow *	handle,
		CL_GraphicContext &	gc
	)			`[inherited]`

Reset cliprect.

Parameters:

	handle	= GUITop Level Window
	gc	= Graphic Context

CL_Point CL_GUIWindowManager::screen_to_window	(	CL_GUITopLevelWindow *	handle,
		const CL_Point &	screen_point,
		bool	client_area
	)			const `[inherited]`

Screen to window.

Parameters:

	handle	= GUITop Level Window
	screen_point	= Point
	client_area	= bool

Returns:: Point

void CL_GUIWindowManager::set_cliprect	(	CL_GUITopLevelWindow *	handle,
		CL_GraphicContext &	gc,
		const CL_Rect &	rect
	)			`[inherited]`

Set cliprect.

Parameters:

	handle	= GUITop Level Window
	gc	= Graphic Context
	rect	= Rect

void CL_GUIWindowManager::set_cursor	(	CL_GUITopLevelWindow *	handle,
		const CL_Cursor &	cursor
	)			`[inherited]`

Set cursor.

Parameters:

	handle	= GUITop Level Window
	cursor	= Cursor

void CL_GUIWindowManager::set_cursor	(	CL_GUITopLevelWindow *	handle,
		enum CL_StandardCursor	type
	)			`[inherited]`

Set cursor.

Parameters:

	handle	= GUITop Level Window
	type	= CL_StandardCursor

void CL_GUIWindowManager::set_geometry	(	CL_GUITopLevelWindow *	handle,
		const CL_Rect &	geometry,
		bool	client_area
	)			`[inherited]`

Set geometry.

Parameters:

	handle	= GUITop Level Window
	geometry	= Rect
	client_area	= bool

void CL_GUIWindowManager::set_site ( CL_GUIWindowManagerSite * site ) [inherited]

Set site.

Parameters:

site

= GUIWindow Manager Site

void CL_GUIWindowManagerTexture::set_texture_group ( CL_TextureGroup & new_texture_group )

Set texture group.

Parameters:

new_texture_group

= Texture Group

void CL_GUIWindowManager::set_visible	(	CL_GUITopLevelWindow *	handle,
		bool	visible,
		bool	activate_root_win
	)			`[inherited]`

Set visible.

Parameters:

	handle	= GUITop Level Window
	visible	= bool
	activate_root_win	= bool

void CL_GUIWindowManager::setup_painting ( ) [inherited]

Initial setup for painting all top level windows.

void CL_GUIWindowManager::update ( ) [inherited]

Perform any updates.

This is called by CL_GUIManager::exec(), after all messages has been processed

CL_Point CL_GUIWindowManager::window_to_screen	(	CL_GUITopLevelWindow *	handle,
		const CL_Point &	window_point,
		bool	client_area
	)			const `[inherited]`

Window to screen.

Parameters:

	handle	= GUITop Level Window
	window_point	= Point
	client_area	= bool

Returns:: Point

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

gui_window_manager_texture.h

CL_GUIWindowManagerTexture Class Reference [clanGUI System]

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

CL_GUIWindowManagerTexture Class Reference
[clanGUI System]