applet Class Reference
[Windows Control Panel Library]

#include <winstl/control_panel/applet_module.hpp>

List of all members.

---

Detailed Description

Represents a Control Panel Applet.

Instances of this class are managed by the applet_module class, and available by its subscript operator. For example, the following code retrieves a reference to the first applet and invokes it:

winstl::applet_module &module   = . . . ;
winstl::applet        &applet0  = module[0];

applet0.open();

Examples:

by_library/windows_control_panel/windows_control_panel/windows_control_panel.cpp.

Member Types
typedef applet	class_type
	The type of this class.
typedef stlsoft::basic_simple_string < TCHAR >	string_type
	The string type.
typedef size_t	index_type
	The index type.
Construction
	~applet () throw ()
	Releases any resources associated with the instance.
Public Member Functions
Operations
void	open (HWND hwnd=NULL)
	Invokes the applet, with the given window, if specified, as the dialog parent.
void	open (HWND hwnd, TCHAR const *arguments)
	Invokes the applet passing a parameter string, with the given window, if specified, as the dialog parent.
Attributes
index_type	get_index () const
	The index of the applet in the containing applet module.
string_type	get_name () const
	The applet name.
string_type	get_description () const
	The description of the applet.
HICON	get_icon () const
	The icon associated with the applet.
LONG	get_data () const
	The user-date, if any, associated with the applet.

---

Member Typedef Documentation

typedef applet class_type

The type of this class.

typedef stlsoft:: basic_simple_string<TCHAR> string_type

The string type.

typedef size_t index_type

The index type.

---

Constructor & Destructor Documentation

~applet

(

)

throw ()

Releases any resources associated with the instance.

---

Member Function Documentation

void open

(

HWND

hwnd = NULL

)

Invokes the applet, with the given window, if specified, as the dialog parent.

Parameters:

hwnd

[in] Handle to a window that will act as the parent window for the applet dialog.

void open	(	HWND	hwnd,
		TCHAR const *	arguments
	)

Invokes the applet passing a parameter string, with the given window, if specified, as the dialog parent.

Parameters:

	hwnd	[in] Handle to a window that will act as the parent window for the applet dialog.
	arguments	[in] Arguments to pass to the applet.

index_type get_index

(

)

const

The index of the applet in the containing applet module.

Examples:

by_library/windows_control_panel/windows_control_panel/windows_control_panel.cpp.

string_type get_name

(

)

const

The applet name.

Examples:

by_library/windows_control_panel/windows_control_panel/windows_control_panel.cpp.

string_type get_description

(

)

const

The description of the applet.

Examples:

by_library/windows_control_panel/windows_control_panel/windows_control_panel.cpp.

HICON get_icon

(

)

const

The icon associated with the applet.

LONG get_data

(

)

const

The user-date, if any, associated with the applet.

---

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

• winstl/control_panel/applet_module.hpp