a1200   NEWS   APPS   DOCS   ABOUT
a1200
----
a1200
----
Autodocs
 Libraries:
 gadtools.library
  CreateContext
  CreateGadgetA
  CreateMenusA
  DrawBevelBoxA
  FreeGadgets
  FreeMenus
  FreeVisualInfo
  GT_BeginRefresh
  GT_EndRefresh
  GT_FilterIMsg
  GT_GetGadgetAttrsA
  GT_GetIMsg
  GT_PostFilterIMsg
  GT_RefreshWindow
  GT_ReplyIMsg
  GT_SetGadgetAttrsA
  GetVisualInfoA
  LayoutMenuItemsA
  LayoutMenusA
Include
GuruMeditation
Docs » Autodocs » gadtools.library » GT_FilterIMsg

NAME

	GT_FilterIMsg -- filter an IntuiMessage through GadTools. (V36)

SYNOPSIS

	modimsg = GT_FilterIMsg(imsg)
D0 A1
struct IntuiMessage *GT_FilterIMsg(struct IntuiMessage *);

FUNCTION

	NOTE WELL:  Extremely few programs will actually need this function.
You almost certainly should be using GT_GetIMsg() and GT_ReplyIMsg()
only, and not GT_FilterIMsg() and GT_PostFilterIMsg().
GT_FilterIMsg() takes the supplied IntuiMessage and asks the
Gadget Toolkit to consider and possibly act on it. Returns
NULL if the message was only of significance to a GadTools gadget
(i.e. not to you), else returns a pointer to a modified IDCMP
message, which may contain additional information.
You should examine the Class, Code, and IAddress fields of
the returned message to learn what happened. Do not make
interpretations based on the original imsg.
You should use GT_PostFilterIMsg() to revert to the original
IntuiMessage once you are done with the modified one.

INPUTS

	imsg - an IntuiMessage you obtained from a Window's UserPort.

RESULT

	modimsg - a modified IntuiMessage, possibly with extra information
from GadTools, or NULL. When NULL, the message passed in to
the function should be sent back to Intuition via ReplyMsg()

NOTES

	Starting with V39, this function actually expects and returns
pointers to ExtIntuiMessage structures, but the prototype was not
changed for source code compatibility with older software.

WARNING

	If this function returns NULL, you must call ReplyMsg() on the
IntuiMessage you passed in to GT_FilterIMsg(). That is, if the
message was processed by the toolkit you must reply this message
to Intuition since gadtools will not do this automatically.

SEE ALSO

GT_GetIMsg(), GT_PostFilterIMsg()

Comments

Name:
E-mail: Use this if you want a message if you get a response, will not be shown.
Comment:
Select correct short for:

Future Crew

FC
AOA
PDX
ATX

Comments:

$VER: d0.se 1.14 Copyright © 2011-2021 Tobias Geijersson support at d0 dot se