SmartWin++: Widget Class Reference

List of all members.


Public Member Functions
void	addRemoveExStyle (DWORD addStyle, bool add)
	Use this function to add or remove windows exStyles.
void	addRemoveStyle (DWORD addStyle, bool add)
	Use this function to add or remove windows styles.
Utilities::CriticalSection &	getCriticalSection ()
	Returns a CriticalSection associated with the current Widget object.
HMENU	getCtrlId () const
	Returns the control id of the Widget.
Widget *	getParent () const
	Returns the parent Widget of the Widget.
HWND	handle () const
	Returns the HWND to the Widget.
void	invalidateWidget ()
	Add this widget to the update area.
virtual LRESULT	sendWidgetMessage (HWND hWnd, UINT msg, WPARAM &wPar, LPARAM &lPar)=0
	Send a message to the Widget.
virtual void	subclass (unsigned id)
	Subclasses the dialog item with the given dialog item id.
void	updateWidget ()
	Repaints the whole window.

Detailed Description

Basically (almost) all Widgets derive from this class, this is the root class for (almost) every single Widget type.
This class contains the functionality that all Widgets must or should have support for.
E.g. the handle to the specific Widgets are contained here, plus all the commonalities between Widgets
The Widget class inherits from boost::noncopyable to indicate it's not to be copied

Member Function Documentation

void addRemoveExStyle	(	DWORD	addStyle,
		bool	add
	)

Use this function to add or remove windows exStyles.

The first parameter is the type of style you wish to add/remove.
The second argument is a boolean indicating if you wish to add or remove the style (if true add style, else remove)

void addRemoveStyle	(	DWORD	addStyle,
		bool	add
	)

Use this function to add or remove windows styles.

The first parameter is the type of style you wish to add/remove.
The second argument is a boolean indicating if you wish to add or remove the style (if true add style, else remove)

Utilities::CriticalSection & getCriticalSection ( )

Returns a CriticalSection associated with the current Widget object.

If you need serialized thread safe access to the Widget call this function and either stuff the returned object into a Utilities::ThreadLock or call Utilities::CriticalSection::lock (then you manually have to ensure CriticalSection::unlock is called on it)

HMENU getCtrlId ( ) const

Returns the control id of the Widget.

This one only makes sense for control items, e.g. WidgetButton, WidgetComboBox etc.
Every control in a Widget has got its own control ID, mark that for a WidgetWindow this will always be ZERO

Widget* getParent ( ) const

Returns the parent Widget of the Widget.

Most Widgets have got a parent, this function will retrieve a pointer to the Widgets parent, if the Widget doesn't have a parent it will return a null pointer.

HWND handle ( ) const

Returns the HWND to the Widget.

Returns the HWND to the inner window of the Widget.
If you need to do directly manipulation of the window use this function to retrieve the HWND of the Widget.

void invalidateWidget ( )

Add this widget to the update area.

Same as updateWidget except that this does not force an immediate redraw.

virtual LRESULT sendWidgetMessage	(	HWND	hWnd,
		UINT	msg,
		WPARAM &	wPar,
		LPARAM &	lPar
	)			`[pure virtual]`

Send a message to the Widget.

If you need to be able to send a message to a Widget then use this function as it will unroll into
a SendMessage from the Windows API

void subclass ( unsigned id ) [virtual]

Subclasses the dialog item with the given dialog item id.

Subclasses a dialog item, the id is the dialog item id from the resource editor.
Should normally not be called directly but rather called from e.g. one of the creational functions found in the WidgetFactory class.

void updateWidget ( )

Repaints the whole window.

Invalidate the window and repaints it.

Widget Class Reference

Public Member Functions

Detailed Description

Member Function Documentation