workbench/libs/datatypes/getdttriggermethods.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8 #define USE_BOOPSI_STUBS
   9 #include <proto/intuition.h>
  10 #include <intuition/classusr.h>
  11 #include <datatypes/datatypesclass.h>
  12 #include <clib/boopsistubs.h>
  13 #include "datatypes_intern.h"
  14
  15 /*****************************************************************************
  16
  17     NAME */
  18 #include <proto/datatypes.h>
  19
  20         AROS_LH1(struct DTMethod *, GetDTTriggerMethods,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(Object *, object, A0),
  24
  25 /*  LOCATION */
  26         struct Library *, DataTypesBase, 18, DataTypes)
  27
  28 /*  FUNCTION
  29
  30     Get a list of the trigger methods an object supports.
  31
  32     INPUTS
  33
  34     object  --  pointer to a data type object
  35
  36     RESULT
  37
  38     A pointer to a STM_DONE terminated DTMethod list. This list in only valid
  39     until the object is disposed of.
  40
  41     NOTES
  42
  43     Some trigger methods requires an argument (calling these with a NULL
  44     argument is wrong). Use GetDTTriggerMethodDataFlags() to obtain the
  45     type of the requested argument.
  46
  47     EXAMPLE
  48
  49     To call the specific method, do the following:
  50
  51     DoMethod(object, DTM_TRIGGER, myMethod);
  52
  53     BUGS
  54
  55     SEE ALSO
  56
  57     GetDTMethods()
  58
  59     INTERNALS
  60
  61     HISTORY
  62
  63 *****************************************************************************/
  64 {
  65     AROS_LIBFUNC_INIT
  66
  67     struct DTMethod *dtm = NULL;
  68     struct opGet      opGet;
  69
  70     if(object == NULL)
  71         return NULL;
  72
  73     opGet.MethodID    = OM_GET;
  74     opGet.opg_AttrID  = DTA_TriggerMethods;
  75     opGet.opg_Storage = (IPTR *)&dtm;
  76
  77     if(!DoMethodA(object, (Msg)&opGet))
  78         dtm = NULL;
  79
  80     return dtm;
  81
  82     AROS_LIBFUNC_EXIT
  83 } /* GetDTTriggerMethods */