home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / useful / dist / dev / gui / mui / developer / autodocs / mui_popobject.doc < prev    next >
Text File  |  1994-07-03  |  5KB  |  160 lines
  1. TABLE OF CONTENTS
  2.  
  3. Popobject.mui/Popobject.mui
  4. Popobject.mui/MUIA_Popobject_Follow
  5. Popobject.mui/MUIA_Popobject_Light
  6. Popobject.mui/MUIA_Popobject_Object
  7. Popobject.mui/MUIA_Popobject_ObjStrHook
  8. Popobject.mui/MUIA_Popobject_StrObjHook
  9. Popobject.mui/MUIA_Popobject_Volatile
  10. Popobject.mui/Popobject.mui
  11.  
  12.     Popobject class takes a MUI object as parameter uses this one
  13.     as popup. You can e.g. simply create a listview object with
  14.     some entries and the popobject class will create a window
  15.     around it and display it when the user hits the popup button.
  16.  
  17.     Using this class instead of creating the popup windows yourself
  18.     prevents you from having lots of problems. Think twice before
  19.     deciding to make you own popups!
  20. Popobject.mui/MUIA_Popobject_Follow
  21.  
  22.     NAME
  23.     MUIA_Popobject_Follow -- (V7) [ISG], BOOL
  24.  
  25.     FUNCTION
  26.     Setting this attribute causes the popup window to follow its
  27.     parent window when its moved. Defaults to TRUE.
  28.  
  29.     SEE ALSO
  30.     MUIA_Popobject_Light, MUIA_Popobject_Volatile.
  31. Popobject.mui/MUIA_Popobject_Light
  32.  
  33.     NAME
  34.     MUIA_Popobject_Light -- (V7) [ISG], BOOL
  35.  
  36.     FUNCTION
  37.     This attribute causes the popup window to be border and
  38.     titleless. Defaults to TRUE
  39.  
  40.     SEE ALSO
  41.     MUIA_Popobject_Follow, MUIA_Popobject_Volatile
  42. Popobject.mui/MUIA_Popobject_Object
  43.  
  44.     NAME
  45.     MUIA_Popobject_Object -- (V7) [I.G], Object *
  46.  
  47.     FUNCTION
  48.     Specify the object to pop up. Usually this is a relatively simple
  49.     thing like a single listview, but you can of course use group
  50.     class here and make rather complex popups. As with all other
  51.     MUI classes, the object here gets disposed when the popobject
  52.     is disposed.
  53.  
  54.     EXAMPLE
  55.     pop = PopobjectObject,
  56.        MUIA_Popstring_String, KeyString(0,60,'n'),
  57.        MUIA_Popstring_Button, PopButton(MUII_PopUp),
  58.        MUIA_Popobject_StrObjHook, &StrObjHook,
  59.        MUIA_Popobject_ObjStrHook, &ObjStrHook,
  60.        MUIA_Popobject_Object, ListviewObject,
  61.           MUIA_Listview_List, ListObject,
  62.              InputListFrame,
  63.              MUIA_List_SourceArray, PopNames,
  64.              End,
  65.           End,
  66.        End;
  67.  
  68.    SEE ALSO
  69.     MUIA_Popobject_StrObjHook, MUIA_Popobject_ObjStrHook,
  70.     MUIA_Popobject_Light
  71. Popobject.mui/MUIA_Popobject_ObjStrHook
  72.  
  73.     NAME
  74.     MUIA_Popobject_ObjStrHook -- (V7) [ISG], struct Hook *
  75.  
  76.     FUNCTION
  77.     When a popup is closed, this hook is called. You can examine
  78.     the state of your MUIA_Popobject_Object and set the contents
  79.     of the string gadget respectively. The hook receives a pointer
  80.     to itself in A0, a pointer to your MUIA_Popobject_Object
  81.     in A2 and a pointer to the embedded string object in A1.
  82.  
  83.     The hook will only be called when your popup is closed with
  84.     a success value of TRUE. Otherwise, MUI closes the popup
  85.     without taking further actions, just as if had never opened.
  86.  
  87.     Since MUI doesn't know anything about your MUIA_Popobject_Object,
  88.     it's your task to tell when your popup is finished. You can
  89.     terminate popups at anytime by sending a MUIM_Popstring_Close
  90.     method:
  91.  
  92.     /* A double click terminates the popping list with a successful 
  93.        return value. */
  94.  
  95.     DoMethod(plist,MUIM_Notify,MUIA_Listview_DoubleClick,TRUE,
  96.         pop,2,MUIM_Popstring_Close,TRUE);
  97.  
  98.     EXAMPLE
  99.     SAVEDS ASM VOID ObjStrFunc(REG(a2) Object *list,REG(a1) Object *str)
  100.     {
  101.        char *x;
  102.        DoMethod(list,MUIM_List_GetEntry,MUIV_List_GetEntry_Active,&x);
  103.        set(str,MUIA_String_Contents,x);
  104.     }
  105. Popobject.mui/MUIA_Popobject_StrObjHook
  106.  
  107.     NAME
  108.     MUIA_Popobject_StrObjHook -- (V7) [ISG], struct Hook *
  109.  
  110.     FUNCTION
  111.     Before the popup opens, this hook is called. You can use it
  112.     to prepare your MUIA_Popobject_Object according to the
  113.     contents of the string gadget. The hook receives a pointer
  114.     to itself in A0, a pointer to your MUIA_Popobject_Object
  115.     in A2 and a pointer to the embedded string object in A1.
  116.  
  117.     Return TRUE if you want the popup to appear,
  118.     FALSE otherwise.
  119.  
  120.     EXAMPLE
  121.     SAVEDS ASM LONG StrObjFunc(REG(a2) Object *list,REG(a1) Object *str)
  122.     {
  123.        char *x,*s;
  124.        int i;
  125.  
  126.        get(str,MUIA_String_Contents,&s);
  127.  
  128.        for (i=0;;i++)
  129.        {
  130.           DoMethod(list,MUIM_List_GetEntry,i,&x);
  131.           if (!x)
  132.           {
  133.              set(list,MUIA_List_Active,MUIV_List_Active_Off);
  134.              break;
  135.           }
  136.           else if (!stricmp(x,s))
  137.           {
  138.              set(list,MUIA_List_Active,i);
  139.              break;
  140.           }
  141.        }
  142.        return(TRUE);
  143.     }
  144.  
  145.     SEE ALSO
  146.     MUIA_Popobject_ObjStrHook, MUIA_Popobject_Object
  147. Popobject.mui/MUIA_Popobject_Volatile
  148.  
  149.     NAME
  150.     MUIA_Popobject_Volatile -- (V7) [ISG], BOOL
  151.  
  152.     FUNCTION
  153.     Setting this attribute causes the popup window to disappear when the
  154.     corresponding popobject disappears, e.g. because its in a page group
  155.     and the user toggled the page. When the popobject appears again,
  156.     the popup window appears also. Defaults to TRUE.
  157.  
  158.     SEE ALSO
  159.     MUIA_Popobject_Light, MUIA_Popobject_Follow
  160.