GRE_CALLBACK_MSG Class Reference

Callback message container. More...

#include <gre/msg.h>

Inheritance diagram for GRE_CALLBACK_MSG:

Inheritance graph
[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_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_RightButtonPress = (16|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_MAXTYPE = 38
}

Public Member Functions

ACTION GetAction () const
ELEMTYPE GetElemType () const
GRE_OBJECTGetObject () const
GRE_VIEWGetView () const
 GRE_CALLBACK_MSG (ACTION action, GRE_OBJECT *object, ELEMTYPE elemtype)
 GRE_CALLBACK_MSG (ACTION action, GRE_OBJECT *object, GRE_VIEW *view=0, ELEMTYPE elemtype=ELEMTYPE_Empty)

Detailed Description

Callback message container.

Definition at line 50 of file msg.h.


Member Enumeration Documentation

enum GRE_CALLBACK_MSG::ACTION
 

Enumeration values:
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 
ACTION_Create  No action (never actually sent to msg handler).
ACTION_Destroy  Object has just been created.
ACTION_Selected  Object is being destroyed.
ACTION_Deselected  Object has been selected in list.
ACTION_Change  Object has been deselected in list.
ACTION_ChangeBegin  Unsequenced change made to object.
ACTION_ChangeEnd  Begin non-specific change to object.
ACTION_ChangeCancel  End non-specific change to object.
ACTION_Expose  Cancel non-specific change to object.
ACTION_Draw  Exposure event occurred for view DrawingArea.
ACTION_DrawBegin  Unsequenced draw operation.
ACTION_DrawEnd  Begin draw operation.
ACTION_DrawCancel  End draw operation.
ACTION_ChangeOrder  Cancel draw operation.
ACTION_ChangeOrderBegin  Change to order of object in list.
ACTION_ChangeOrderEnd  Begin change to order of object in list.
ACTION_CreateChildren  End change to order of object in list.
ACTION_CreateChildrenBegin  Creating children of object.
ACTION_CreateChildrenEnd  Begin creating children of object.
ACTION_DestroyChildren  End creating children of object.
ACTION_DestroyChildrenBegin  Destroying children of object.
ACTION_DestroyChildrenEnd  Begin destroying children of object.
ACTION_ChangeObject  End destroying children of object.
ACTION_ChangeName  Selected object(s) for layer changed.
ACTION_Resized  Object name changed.
ACTION_ElementSelect  Object (view) has been resized.
ACTION_ElementSelectBegin  Change to element highlight set.
ACTION_ElementSelectEnd  Begin change to element highlight set.
ACTION_ChangeActiveElem  End change to element highlight set.
ACTION_RightButtonPress  Active element changed (for layer).
ACTION_ChangeVisible  Right mouse button pressed with no tool position set.
ACTION_ChangeVisibleBegin  Unsequenced visibility change for object.
ACTION_ChangeVisibleEnd  Begin visibility change for object.
ACTION_CursorEnter  End visibility change for object.
ACTION_CursorLeave  Cursor has entered view.
ACTION_CreateView  Cursor has moved out of view.
ACTION_Load  Created view of object.
ACTION_LoadBegin  Load layout/group.
ACTION_LoadEnd  Begin load layout/group.
ACTION_Restore  End load layout/group.
ACTION_RestoreBegin  Restoring view from memory image.
ACTION_RestoreContinue  Begin restoring view from memory image.
ACTION_RestoreEnd  Continue restoring view from memory image.
ACTION_CloseRequest  Begin restoring view from memory image.
ACTION_DataTipShown  User has requested "Close" on object.
ACTION_DataTipHidden  DataTip has been shown in view.
ACTION_DestroyView  DataTip has been hidden in view.
ACTION_DeactivateTool  View of object about to be destroyed.
ACTION_ActivateTool  Active tool for view about to be deactivated.
ACTION_ElementSelectAll  Active tool for view about to be activated.
ACTION_ElementSelectAllBegin  Selecting/deselecting all elements.
ACTION_ElementSelectAllEnd  Begin selecting/deselecting all elements.
ACTION_StyleObjEdited  End selecting/deselecting all elements.
ACTION_OverlayUpdate  Style object for layer has been edited.
ACTION_Edited  Overlay update needed.
ACTION_ExtractedFrom  Object (layer) has been "edited" (for TNTedit).
ACTION_SetComponentSelectable  Object (layer) has been extracted from.
ACTION_SetShowInternalTables  Component has been made selectable/nonselectable.
ACTION_SetShowScaleRanges  Change made to "show internal tables" setting.
ACTION_DrawMatte  Change made to "show scale ranges" setting.
ACTION_DrawMatteBegin  Drawing Matte.
ACTION_DrawMatteEnd  Begin Drawing Matte.
ACTION_ChangeLegend  End Drawing Matte.
ACTION_ChangeLegendBegin  Begin legend change for object.
ACTION_ChangeLegendEnd  Begin legend change for object.
ACTION_MAXTYPE  End legend change for object.

Definition at line 53 of file msg.h.


Constructor & Destructor Documentation

GRE_CALLBACK_MSG::GRE_CALLBACK_MSG ACTION  action,
GRE_OBJECT object,
GRE_VIEW view = 0,
ELEMTYPE  elemtype = ELEMTYPE_Empty
[inline]
 

Definition at line 130 of file msg.h.

GRE_CALLBACK_MSG::GRE_CALLBACK_MSG ACTION  action,
GRE_OBJECT object,
ELEMTYPE  elemtype
[inline]
 

Definition at line 143 of file msg.h.


Member Function Documentation

ACTION GRE_CALLBACK_MSG::GetAction  )  const [inline]
 

Get action which caused this message to be sent.

Returns:
action type

Definition at line 157 of file msg.h.

ELEMTYPE GRE_CALLBACK_MSG::GetElemType  )  const [inline]
 

Get element type if applicable.

Returns:
element type

Definition at line 162 of file msg.h.

GRE_OBJECT* GRE_CALLBACK_MSG::GetObject  )  const [inline]
 

Get object to which message applies.

Returns:
object pointer

Definition at line 167 of file msg.h.

GRE_VIEW* GRE_CALLBACK_MSG::GetView  )  const [inline]
 

Get view message originated from if any.

Returns:
view pointer or 0 if not applicable

Definition at line 172 of file msg.h.


The documentation for this class was generated from the following file:
Generated on Tue Dec 14 13:19:47 2004 for TNTsdk by  doxygen 1.3.8-20040913