ParamMap2UserDlgProc Class Reference

This reference page is linked to from the following overview topics: Parameter Block UI, Parameter Block UI Specification Arguments.

---

Search for all occurrences

---

Detailed Description

See also:

Class ParamBlockDesc2, Class ClassDesc2.

Description:

If there are controls which require custom handling you can create an object from this class and set it as the parameter map's user callback (usually using SetUserDialogProc()).

#include <iparamm2.h>

Inheritance diagram for ParamMap2UserDlgProc:

List of all members.

Public Member Functions
virtual	~ParamMap2UserDlgProc ()
virtual INT_PTR	DlgProc (TimeValue t, IParamMap2 *map, HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)=0
virtual void	DeleteThis ()=0
virtual void	SetThing (ReferenceTarget *m)
virtual void	Update (TimeValue t)
virtual void	SetParamBlock (IParamBlock2 *pb)
virtual void	Update (TimeValue t, Interval &valid, IParamMap2 *pmap)

---

Constructor & Destructor Documentation

virtual ~ParamMap2UserDlgProc

(

)

[inline, virtual]

Remarks:

Destructor

{ }

---

Member Function Documentation

virtual INT_PTR DlgProc	(	TimeValue	t,
		IParamMap2 *	map,
		HWND	hWnd,
		UINT	msg,
		WPARAM	wParam,
		LPARAM	lParam
	)		[pure virtual]

Search for all occurrences

virtual void DeleteThis

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method is called to delete this object. If the DlgProc is non-NULL when the ParamMap is deleted this method will be called.

virtual void SetThing

(

ReferenceTarget *

m

)

[inline, virtual]

Search for all occurrences

Remarks:

This gets called if the DlgProc is registered with a parameter map associated with one of the IAutoXXXParamDlg instances and that dialog has SetThing() called on it. This provides a simple way for the user dialog proc to track changes to the underlying object in the parameter map.

Parameters:

ReferenceTarget *m

The item that was set.

Default Implementation:

{}

{ }

virtual void Update

(

TimeValue

t

)

[inline, virtual]

Search for all occurrences

{ }

virtual void SetParamBlock

(

IParamBlock2 *

pb

)

[inline, virtual]

Search for all occurrences

{ }

virtual void Update	(	TimeValue	t,
		Interval &	valid,
		IParamMap2 *	pmap
	)		[inline, virtual]

Search for all occurrences

Remarks:

This is a variant of Update() method in ParamMap2UserDlgProc used to supply more context, including the pmap itself and its validity interval. Changes you make to the validity internal passed in affect the validity interval of the whole parammap.

Parameters:

TimeValue t

The time at which the update is taking place.

Interval& valid

The validity interval of the parameter map.

IParamMap2 *pmap

The parameter map the user dialog proc is associated with.

{ this->Update(t); }