home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 18 / amigaformatcd18.iso / mui / mui_developer / autodocs / mui_cycle.doc < prev    next >
Text File  |  1997-03-10  |  2KB  |  74 lines
  1. TABLE OF CONTENTS
  2.  
  3. Cycle.mui/Cycle.mui
  4. Cycle.mui/MUIA_Cycle_Active
  5. Cycle.mui/MUIA_Cycle_Entries
  6. Cycle.mui/Cycle.mui
  7.  
  8.     Cycle class generates the well known cycle gadgets.
  9.     However, MUI cycle gadgets feature a (configurable)
  10.     popup menu to avoid clicking through many entries.
  11. Cycle.mui/MUIA_Cycle_Active
  12.  
  13.     NAME
  14.     MUIA_Cycle_Active -- (V4 ) [ISG], LONG
  15.  
  16.     SPECIAL INPUTS
  17.     MUIV_Cycle_Active_Next
  18.     MUIV_Cycle_Active_Prev
  19.  
  20.     FUNCTION
  21.     This attributes defines the number of the active
  22.     entry in the cycle gadgets. Valid range is from
  23.     0 for the first entry to NumEntries-1 for the last.
  24.  
  25.     Setting MUIA_Cycle_Active causes the gadget to
  26.     be updated. On the other hand, when the user
  27.     plays around with the gadget, MUIA_Cycle_Active
  28.     will always reflects the current state.
  29.  
  30.     Using MUIV_Cycle_Active_Next and MUIV_Cycle_Active_Prev
  31.     as attribute value during set causes the gadget to
  32.     cycle through its entries in the given direction.
  33.  
  34.     EXAMPLE
  35.     set(cycleobj,MUIA_Cycle_Active,3);
  36.  
  37.     SEE ALSO
  38.     MUIA_Cycle_Entries
  39. Cycle.mui/MUIA_Cycle_Entries
  40.  
  41.     NAME
  42.     MUIA_Cycle_Entries -- (V4 ) [I..], STRPTR *
  43.  
  44.     FUNCTION
  45.     Here you can define what entries shall be displayed
  46.     in your cycle gadget. You must supply a pointer to
  47.     a string array, containing one entry for each item
  48.     and terminated with a NULL.
  49.  
  50.     Remember that cycle gadget entries may contain any
  51.     text formatting code such as bold, italic or
  52.     underlined characters.
  53.  
  54.     Cycle gadgets set the preparse string for all entries
  55.     to "\33c", this means that they will automatically
  56.     appear centered. Of course you can override this by
  57.     simply preceding your entries with own formatting code.
  58.  
  59.     EXAMPLES
  60.     static const char *CYA_GroupTitleColor[] =
  61.     {
  62.        "normal",
  63.        "highlight",
  64.        "3-dimensional",
  65.        NULL
  66.     };
  67.  
  68.         CY_Title = CycleObject,
  69.        MUIA_Cycle_Entries, CYA_GroupTitleColor,
  70.        End;
  71.  
  72.     SEE ALSO
  73.     MUIA_Cycle_Active, MUIA_Text_Contents
  74.