GRE::MSG Class Reference

Message container. More...

#include <gre/msg.h>

Inheritance diagram for GRE::MSG:

[legend]

List of all members.

Public Types
enum	ACTION {   ACTION_SeqNone = 0x0000, ACTION_SeqBegin = 0x1000, ACTION_SeqEnd = 0x2000, ACTION_SeqContinue = 0x4000,   ACTION_SeqCancel = 0x8000, ACTION_SeqMask = 0xF000, ACTION_None = (0), ACTION_Create = (1|ACTION_SeqNone),   ACTION_Destroy = (2|ACTION_SeqNone), ACTION_Selected = (3|ACTION_SeqNone), ACTION_Deselected = (4|ACTION_SeqNone), ACTION_Change = (5|ACTION_SeqNone),   ACTION_ChangeBegin = (5|ACTION_SeqBegin), ACTION_ChangeEnd = (5|ACTION_SeqEnd), ACTION_ChangeCancel = (5|ACTION_SeqCancel), ACTION_Expose = (6|ACTION_SeqNone),   ACTION_Draw = (7|ACTION_SeqNone), ACTION_DrawBegin = (7|ACTION_SeqBegin), ACTION_DrawEnd = (7|ACTION_SeqEnd), ACTION_DrawCancel = (7|ACTION_SeqCancel),   ACTION_ChangeOrder = (8|ACTION_SeqNone), ACTION_ChangeOrderBegin = (8|ACTION_SeqBegin), ACTION_ChangeOrderEnd = (8|ACTION_SeqEnd), ACTION_CreateChildren = (9|ACTION_SeqNone),   ACTION_CreateChildrenBegin = (9|ACTION_SeqBegin), ACTION_CreateChildrenEnd = (9|ACTION_SeqEnd), ACTION_CreateChildrenCancel = (9|ACTION_SeqCancel), ACTION_DestroyChildren = (10|ACTION_SeqNone),   ACTION_DestroyChildrenBegin = (10|ACTION_SeqBegin), ACTION_DestroyChildrenEnd = (10|ACTION_SeqEnd), ACTION_ChangeObject = (11|ACTION_SeqNone), ACTION_ChangeName = (12|ACTION_SeqNone),   ACTION_Resized = (13|ACTION_SeqNone), ACTION_ElementSelect = (14|ACTION_SeqNone), ACTION_ElementSelectBegin = (14|ACTION_SeqBegin), ACTION_ElementSelectEnd = (14|ACTION_SeqEnd),   ACTION_ChangeActiveElem = (15|ACTION_SeqNone), ACTION_ChangeVisible = (17|ACTION_SeqNone), ACTION_ChangeVisibleBegin = (17|ACTION_SeqBegin), ACTION_ChangeVisibleEnd = (17|ACTION_SeqEnd),   ACTION_CursorEnter = (18|ACTION_SeqNone), ACTION_CursorLeave = (19|ACTION_SeqNone), ACTION_CreateView = (20|ACTION_SeqNone), ACTION_Load = (21|ACTION_SeqNone),   ACTION_LoadBegin = (21|ACTION_SeqBegin), ACTION_LoadEnd = (21|ACTION_SeqEnd), ACTION_Restore = (22|ACTION_SeqNone), ACTION_RestoreBegin = (22|ACTION_SeqBegin),   ACTION_RestoreContinue = (22|ACTION_SeqContinue), ACTION_RestoreEnd = (22|ACTION_SeqEnd), ACTION_CloseRequest = (23|ACTION_SeqNone), ACTION_DataTipShown = (24|ACTION_SeqNone),   ACTION_DataTipHidden = (25|ACTION_SeqNone), ACTION_DestroyView = (26|ACTION_SeqNone), ACTION_DeactivateTool = (27|ACTION_SeqNone), ACTION_ActivateTool = (28|ACTION_SeqNone),   ACTION_ElementSelectAll = (29|ACTION_SeqNone), ACTION_ElementSelectAllBegin = (29|ACTION_SeqBegin), ACTION_ElementSelectAllEnd = (29|ACTION_SeqEnd), ACTION_StyleObjEdited = (30|ACTION_SeqNone),   ACTION_OverlayUpdate = (31|ACTION_SeqNone), ACTION_Edited = (32|ACTION_SeqNone), ACTION_ExtractedFrom = (33|ACTION_SeqNone), ACTION_SetComponentSelectable = (34|ACTION_SeqNone),   ACTION_SetShowInternalTables = (35|ACTION_SeqNone), ACTION_SetShowScaleRanges = (36|ACTION_SeqNone), ACTION_DrawMatte = (37|ACTION_SeqNone), ACTION_DrawMatteBegin = (37|ACTION_SeqBegin),   ACTION_DrawMatteEnd = (37|ACTION_SeqEnd), ACTION_ChangeLegend = (38|ACTION_SeqNone), ACTION_ChangeLegendBegin = (38|ACTION_SeqBegin), ACTION_ChangeLegendEnd = (38|ACTION_SeqEnd),   ACTION_ChangeDispParm = (39|ACTION_SeqNone), ACTION_UserRefresh = (40|ACTION_SeqNone), ACTION_Reclassify = (41|ACTION_SeqNone), ACTION_ChangeViewPoint3d = (42|ACTION_SeqNone),   ACTION_ChangeViewPoint3dDragging = (42|ACTION_SeqContinue), ACTION_SetDrawStereo = (43|ACTION_SeqNone), ACTION_MAXTYPE = 43 }
Public Member Functions
	MSG (ACTION action, GRE::OBJECT *object, ELEMTYPE elemtype)
	MSG (ACTION action, GRE::OBJECT *object, GRE::VIEW *view=0, ELEMTYPE elemtype=ELEMTYPE_Empty)
ACTION	GetAction () const
ELEMTYPE	GetElemType () const
GRE::OBJECT *	GetObject () const
GRE::VIEW *	GetView () const

---

Detailed Description

Message container.

---

Member Enumeration Documentation

enum GRE::MSG::ACTION

Enumerator:

ACTION_SeqNone	No sequence associated with action.
ACTION_SeqBegin	Beginning of action, will be followed (eventually) by same action with SeqEnd or SeqCancel.
ACTION_SeqEnd	Ending of action.
ACTION_SeqContinue	Continuing action.
ACTION_SeqCancel	Action cancelled.
ACTION_SeqMask	Mask for sequence.
ACTION_None	No action (never actually sent to msg handler).
ACTION_Create	Object has just been created.
ACTION_Destroy	Object is being destroyed.
ACTION_Selected	Object has been selected in list.
ACTION_Deselected	Object has been deselected in list.
ACTION_Change	Unsequenced change made to object.
ACTION_ChangeBegin	Begin non-specific change to object.
ACTION_ChangeEnd	End non-specific change to object.
ACTION_ChangeCancel	Cancel non-specific change to object.
ACTION_Expose	Exposure event occurred for view DrawingArea.
ACTION_Draw	Unsequenced draw operation.
ACTION_DrawBegin	Begin draw operation.
ACTION_DrawEnd	End draw operation.
ACTION_DrawCancel	Cancel draw operation.
ACTION_ChangeOrder	Change to order of object in list.
ACTION_ChangeOrderBegin	Begin change to order of object in list.
ACTION_ChangeOrderEnd	End change to order of object in list.
ACTION_CreateChildren	Creating children of object.
ACTION_CreateChildrenBegin	Begin creating children of object.
ACTION_CreateChildrenEnd	End creating children of object.
ACTION_CreateChildrenCancel	Cancel creating children of object.
ACTION_DestroyChildren	Destroying children of object.
ACTION_DestroyChildrenBegin	Begin destroying children of object.
ACTION_DestroyChildrenEnd	End destroying children of object.
ACTION_ChangeObject	Selected object(s) for layer changed.
ACTION_ChangeName	Object name changed.
ACTION_Resized	Object (view) has been resized.
ACTION_ElementSelect	Change to element highlight set.
ACTION_ElementSelectBegin	Begin change to element highlight set.
ACTION_ElementSelectEnd	End change to element highlight set.
ACTION_ChangeActiveElem	Active element changed (for layer).
ACTION_ChangeVisible	Unsequenced visibility change for object.
ACTION_ChangeVisibleBegin	Begin visibility change for object.
ACTION_ChangeVisibleEnd	End visibility change for object.
ACTION_CursorEnter	Cursor has entered view.
ACTION_CursorLeave	Cursor has moved out of view.
ACTION_CreateView	Created view of object.
ACTION_Load	Load layout/group.
ACTION_LoadBegin	Begin load layout/group.
ACTION_LoadEnd	End load layout/group.
ACTION_Restore	Restoring view from memory image.
ACTION_RestoreBegin	Begin restoring view from memory image.
ACTION_RestoreContinue	Continue restoring view from memory image.
ACTION_RestoreEnd	Begin restoring view from memory image.
ACTION_CloseRequest	User has requested "Close" on object.
ACTION_DataTipShown	DataTip has been shown in view.
ACTION_DataTipHidden	DataTip has been hidden in view.
ACTION_DestroyView	View of object about to be destroyed.
ACTION_DeactivateTool	Active tool for view about to be deactivated.
ACTION_ActivateTool	Active tool for view about to be activated.
ACTION_ElementSelectAll	Selecting/deselecting all elements.
ACTION_ElementSelectAllBegin	Begin selecting/deselecting all elements.
ACTION_ElementSelectAllEnd	End selecting/deselecting all elements.
ACTION_StyleObjEdited	Style object for layer has been edited.
ACTION_OverlayUpdate	Overlay update needed.
ACTION_Edited	Object (layer) has been "edited" (for TNTedit).
ACTION_ExtractedFrom	Object (layer) has been extracted from.
ACTION_SetComponentSelectable	Component has been made selectable/nonselectable.
ACTION_SetShowInternalTables	Change made to "show internal tables" setting.
ACTION_SetShowScaleRanges	Change made to "show scale ranges" setting.
ACTION_DrawMatte	Drawing Matte.
ACTION_DrawMatteBegin	Begin Drawing Matte.
ACTION_DrawMatteEnd	End Drawing Matte.
ACTION_ChangeLegend	Begin legend change for object.
ACTION_ChangeLegendBegin	Begin legend change for object.
ACTION_ChangeLegendEnd	End legend change for object.
ACTION_ChangeDispParm	DispParm has been changed.
ACTION_UserRefresh	User pressed "Refresh" button on view.
ACTION_Reclassify	Reclassify operation was done on layer.
ACTION_ChangeViewPoint3d	3D viewpoint change
ACTION_ChangeViewPoint3dDragging	3D viewpoint changing by user dragging, expect to get ACTION_ChangeViewPoint3d when done
ACTION_SetDrawStereo	View setting for whether to draw stereo toggled.
ACTION_MAXTYPE	Maximum action type.

---

Constructor & Destructor Documentation

GRE::MSG::MSG	(	ACTION	action,
		GRE::OBJECT *	object,
		GRE::VIEW *	view = 0,
		ELEMTYPE	elemtype = ELEMTYPE_Empty
	)			[inline]

GRE::MSG::MSG	(	ACTION	action,
		GRE::OBJECT *	object,
		ELEMTYPE	elemtype
	)			[inline]

---

Member Function Documentation

ACTION GRE::MSG::GetAction

(

)

const [inline]

Get action which caused this message to be sent.

Returns:

action type

ELEMTYPE GRE::MSG::GetElemType

(

)

const [inline]

Get element type if applicable.

Returns:

element type

GRE::OBJECT* GRE::MSG::GetObject

(

)

const [inline]

Get object to which message applies.

Returns:

object pointer

GRE::VIEW* GRE::MSG::GetView

(

)

const [inline]

Get view message originated from if any.

Returns:

view pointer or 0 if not applicable

---

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

• gre/msg.h