window_icon_scope Class Reference
[Windows Window Library]

#include <winstl/window/window_icon_scope.hpp>

List of all members.

---

Detailed Description

Provides scoping of the icon(s) of a window.

This class provides scoping of the icon(s) of a window via the WM_SETICON message.

Public Types
typedef window_icon_scope	class_type
	This type.
Public Member Functions
	window_icon_scope (HWND wnd, int iconType, HICON hicon)
	Toggles the icon of a window.
	window_icon_scope (HWND wnd, int iconType, HINSTANCE hinst, LPCTSTR iconName)
	Toggles the icon of a window.
	window_icon_scope (HWND wnd, int iconType, HINSTANCE hinst, int iconId)
	Toggles the icon of a window.
template<typename W>
	window_icon_scope (W &wnd, int iconType, HICON hicon)
	Toggles the window enable state.
template<typename W>
	window_icon_scope (W &wnd, int iconType, HINSTANCE hinst, LPCTSTR iconName)
	Toggles the window enable state.
template<typename W>
	window_icon_scope (W &wnd, int iconType, HINSTANCE hinst, int iconId)
	Toggles the window enable state.
	~window_icon_scope () throw ()
	Resets the window's original icon.

---

Member Typedef Documentation

typedef window_icon_scope class_type

This type.

---

Constructor & Destructor Documentation

window_icon_scope	(	HWND	wnd,
		int	iconType,
		HICON	hicon
	)			[inline]

Toggles the icon of a window.

Takes a HWND and sets its icon, which is then reset to the original in the destructor.

Parameters:

	wnd	The window whose enable state is to be controlled
	iconType	The identifier of the window's icon property to be changed. Should be either ICON_BIG or ICON_SMALL
	hicon	The handle of the icon to associate with the given window's identified icon property

window_icon_scope	(	HWND	wnd,
		int	iconType,
		HINSTANCE	hinst,
		LPCTSTR	iconName
	)			[inline]

Toggles the icon of a window.

Takes a HWND and sets its icon, which is then reset to the original in the destructor.

Parameters:

	wnd	The window whose enable state is to be controlled
	iconType	The identifier of the window's icon property to be changed. Should be either ICON_BIG or ICON_SMALL
	hinst	The module from which the named icon is to be loaded
	iconName	The name of the icon to associate with the given window's identified icon property

window_icon_scope	(	HWND	wnd,
		int	iconType,
		HINSTANCE	hinst,
		int	iconId
	)			[inline]

Toggles the icon of a window.

Takes a HWND and sets its icon, which is then reset to the original in the destructor.

Parameters:

	wnd	The window whose enable state is to be controlled
	iconType	The identifier of the window's icon property to be changed. Should be either ICON_BIG or ICON_SMALL
	hinst	The module from which the named icon is to be loaded
	iconId	The resource identifier of the icon to associate with the given window's identified icon property

window_icon_scope	(	W &	wnd,
		int	iconType,
		HICON	hicon
	)			[inline]

Toggles the window enable state.

Takes a window and sets its icon, which is then reset to the original in the destructor.

Parameters:

	wnd	The window whose enable state is to be controlled
	iconType	The identifier of the window's icon property to be changed. Should be either ICON_BIG or ICON_SMALL
	hicon	The handle of the icon to associate with the given window's identified icon property

window_icon_scope	(	W &	wnd,
		int	iconType,
		HINSTANCE	hinst,
		LPCTSTR	iconName
	)			[inline]

Toggles the window enable state.

Takes a window and sets its icon, which is then reset to the original in the destructor.

Parameters:

	wnd	The window whose enable state is to be controlled
	iconType	The identifier of the window's icon property to be changed. Should be either ICON_BIG or ICON_SMALL
	hinst	The module from which the named icon is to be loaded
	iconName	The name of the icon to associate with the given window's identified icon property

window_icon_scope	(	W &	wnd,
		int	iconType,
		HINSTANCE	hinst,
		int	iconId
	)			[inline]

Toggles the window enable state.

Takes a window and sets its icon, which is then reset to the original in the destructor.

Parameters:

	wnd	The window whose enable state is to be controlled
	iconType	The identifier of the window's icon property to be changed. Should be either ICON_BIG or ICON_SMALL
	hinst	The module from which the named icon is to be loaded
	iconId	The resource identifier of the icon to associate with the given window's identified icon property

~window_icon_scope

(

)

throw () [inline]

Resets the window's original icon.

References STLSOFT_RAW_OFFSETOF, and WINSTL_STATIC_ASSERT.

---

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

• winstl/window/window_icon_scope.hpp