home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d846 / iobject.lha / IObject / doc / IObject.docEng < prev    next >
Encoding:
Text File  |  1993-03-31  |  21.3 KB  |  932 lines
  1. TABLE OF CONTENTS
  2.  
  3.  
  4. IObject.lib/ActivateObject
  5. IObject.lib/AddObjectToWindow
  6. IObject.lib/AdjustBox
  7. IObject.lib/ClearTextArea
  8. IObject.lib/CreateObject
  9. IObject.lib/CreateTextArea
  10. IObject.lib/DisplayObject
  11. IObject.lib/Draw3DBox
  12. IObject.lib/EraseObject
  13. IObject.lib/ExitEasyGadget
  14. IObject.lib/FindObjectMsg
  15. IObject.lib/FreeObject
  16. IObject.lib/FreeTextArea
  17. IObject.lib/GetHotKey
  18. IObject.lib/GetObjectID
  19. IObject.lib/InitEasyGadget
  20. IObject.lib/ModifyObject
  21. IObject.lib/ObjectValue
  22. IObject.lib/OffObject
  23. IObject.lib/OnObject
  24. IObject.lib/RemoveObjectFromWindow
  25. IObject.lib/SendMsgToObject
  26. IObject.lib/SetIObjectColors
  27. IObject.lib/SetTextAreaPen
  28. IObject.lib/TAPrint
  29. IObject.lib/TAPrintf
  30. IObject.lib/TAPuts
  31.  
  32.  
  33. IObject.lib/ActivateObject                         IObject.lib/ActivateObject
  34.  
  35.   NAME  ActivateObject() -- Simulate activation of a IObject
  36.  
  37.     ActivateObject(object);
  38.  
  39.     VOID ActivateObject(CPTR);
  40.  
  41.   DESCRIPTION
  42.     Simulate IObject activation by a user, by this way you can simulate hot-
  43.     keys. This fonction doesn't works with all IObjects (for ex. activate a
  44.     Scroller don't have any meaning).
  45.  
  46.   INPUTS
  47.     object  - pointer to IObject.
  48.  
  49.   RESULT
  50.     none
  51.  
  52.   BUGS
  53.     none known
  54.  
  55.  
  56. IObject.lib/AddObjectToWindow                   IObject.lib/AddObjectToWindow
  57.  
  58.   NAME  AddObjectToWindow() -- Ajoute un IObject à une fenêtre
  59.  
  60.     AddObjectToWindow(object, window, requester);
  61.  
  62.     VOID AddObjectToWindow(CPTR, struct Window *, struct Requester *);
  63.  
  64.   DESCRIPTION
  65.     Add an IObject to a window, the IObject is not displayed on the window.
  66.     (You must use DisplayObject() to display it.). The window must have the
  67.     IDCMP flags associated to IObjects set (IDCMP_xxxx).
  68.  
  69.   INPUTS
  70.     object    - pointer to IObject.
  71.     window    - pointer to the window for the IObject.
  72.     requester - pointer to requester for the IObject.
  73.  
  74.   RESULT
  75.     none
  76.  
  77.   BUGS
  78.     By now, you can add an IObject to a requester. You must put NULL for the
  79.     requester.
  80.  
  81.   SEE ALSO
  82.     RemoveObjectFromWindow()
  83.  
  84.  
  85. IObject.lib/AdjustBox                                   IObject.lib/AdjustBox
  86.  
  87.   NAME  AdjustBox() -- Calculate a box in a border
  88.  
  89.     AdjustBox(box, simple);
  90.  
  91.     VOID AdjustBox(struct Box *, BOOL);
  92.  
  93.   DESCRIPTION
  94.     You can calculate the size and the position of a box in a border (single
  95.     or double) defined by box.
  96.  
  97.   INPUTS
  98.     box    - the box to be adjusted. (box is modified)
  99.     simple - TRUE if it's a single border (BOX_1IN or BOX_1OUT).
  100.  
  101.   RESULT
  102.     none
  103.  
  104.   BUGS
  105.     none known
  106.  
  107.  
  108. IObject.lib/ClearTextArea                           IObject.lib/ClearTextArea
  109.  
  110.   NAME  ClearTextArea() -- clear the TextArea
  111.  
  112.     ClearTextArea(textarea);
  113.  
  114.     VOID ClearTextArea(CPTR);
  115.  
  116.   DESCRIPTION
  117.     Clear the TextArea, and move the current position to top left.
  118.  
  119.   INPUTS
  120.     textarea - pointer to textarea.
  121.  
  122.   RESULT
  123.     none
  124.  
  125.  
  126. IObject.lib/Createxxxx                                 IObject.lib/Createxxxx
  127.  
  128.   NAME  Createxxxx() -- Create an IObject
  129.  
  130.     object = Createxxxx(new, id);
  131.  
  132.     CPTR Createxxxx(struct Newxxxx *, ULONG);
  133.  
  134.   DESCRIPTION
  135.  
  136.     Each classe of IObjects owns a structure NewObject:
  137.  
  138.       struct NewObject
  139.       {
  140.         UWORD  LeftEdge, TopEdge;
  141.         UWORD  Width, Height;
  142.         UWORD  Flags;
  143.         UWORD  ClassFlags;
  144.         STRPTR LabelText;
  145.         struct TextAttr *Font;
  146.       };
  147.  
  148.     LeftEdge, TopEdge - Position of the IObjet in the window.
  149.     Width, Height     - Size of IObject.
  150.     Flags             - Flags for all classes of IObject. To put the label
  151.                         regarding to IOject (LABEL_ABOVE above the IObject,
  152.                         LABEL_BELOW below the IObject, LABEL_RIGHT at right,
  153.                         LABEL_LEFT at left, LABEL_INSIDE inside), with
  154.                         LABEL_HOT_KEY the car next '_' in the label will be
  155.                         underlined, LABEL_PEN2 will use Pen2 color to display
  156.                         the label (Pen1 is uesd by default),with OBJ_DISABLED
  157.                         the IObject will be ghosted.
  158.     ClassFlags        - flags for eache classe (See further).
  159.     LabelText         - Label text (may be NULL).
  160.     Font              - Font for the IObject (label and text). A programm
  161.                         which use IObject.lib must declare DiskfontBase, if
  162.                         you don't open the diskfont.library, put NULL into
  163.                         DiskfontBase, you will only be able to use ROM fonts.
  164.                         If the font can't be opened or if Font is NULL,
  165.                         IObject.lib will use the font Topaz 8.
  166.  
  167.   CLASS_CYCLE:
  168.  
  169.     CPTR CreateCycle(struct NewCycle *, ULONG);
  170.  
  171.     Create an IObject to choose une option among several options.
  172.  
  173.       struct NewCycle
  174.       {
  175.         struct NewObject NewObj;
  176.         STRPTR *TextArray;
  177.       };
  178.  
  179.     ClassFlags - no flags for the Cycle.
  180.     TextArea   - array to strings for options, a NULL must follow the last
  181.                  string.
  182.  
  183.   CLASS_BUTTON:
  184.  
  185.     CPTR CreateButton(struct NewButton *, ULONG);
  186.  
  187.     Create a button, it can be use as a switch with BT_TOGGLE flag.
  188.  
  189.       struct NewButton
  190.       {
  191.         struct NewObject NewObj;
  192.       };
  193.  
  194.     ClassFlags - BT_TOGGLE to create a switch, it can be on or off. With
  195.                  BT_SELECTED the switch will be on.
  196.  
  197.   CLASS_SCROLLER
  198.     
  199.     CPTR CreateScroller(struct NewScroller *, ULONG);
  200.  
  201.     Crée un IObject proportionnel, comme ceux utilisés dans les éditeurs de
  202.     textes pour ce déplacer dans le texte: indique le nombre de lignes
  203.     visible par rapport au nombre totale de ligne et la position dans le
  204.     texte.
  205.  
  206.       struct NewScroller
  207.       {
  208.         struct NewObject NewObj;
  209.         UWORD Pos;
  210.         UWORD CurSize;
  211.         UWORD MaxSize;
  212.       };
  213.  
  214.     ClassFlags - SC_VERTICAL to have a vertical scroller, with SC_NOMOUSE
  215.                  mouse move
  216.     Pos        - Position du knob dans le scroller: de zéro à MaxSize.
  217.     CurSize    - Correspond à la partie visible.
  218.     MaxSize    - Correspond à la partie totale.
  219.  
  220.   CLASS_CHECK:
  221.  
  222.     CPTR CreateCheck(struct NewCheck *, ULONG);
  223.  
  224.     Create an IObject to be marked.
  225.  
  226.       struct NewCheck
  227.       {
  228.         struct NewObject NewObj;
  229.       };
  230.  
  231.     ClassFlags - CK_CHECKED if the IObject is marked.
  232.  
  233.   CLASS_STRING:
  234.  
  235.     CPTR CreateString(struct NewString *, ULONG);
  236.  
  237.     Create an IObject to enter strings.
  238.  
  239.       struct NewString
  240.       {
  241.         struct NewObject NewObj;
  242.         STRPTR Text;
  243.         UWORD  MaxLength;
  244.       };
  245.  
  246.     ClassFlags - STR_SINGLEBORD will use a single border instead of a double
  247.                  border, STR_RIGHT will puts the texte at right, STR_CENTER
  248.                  will center the text.
  249.     Text       - Initial string (may be NULL).
  250.     MaxLength  - Length maximal for the string (must less than 280 charaters
  251.                  by now.)
  252.  
  253.   CLASS_INTEGER:
  254.  
  255.     CPTR CreateInteger(struct NewInteger *, ULONG);
  256.  
  257.     Create an IObject to pick a signed integer, you can specify minimun and
  258.     maximum for the integer with ModifyObject(). (by default LONG_MIN and
  259.     LONG_MAX.)
  260.  
  261.       struct NewInteger
  262.       {
  263.         struct NewObject NewObj;
  264.       };
  265.  
  266.     ClassFlags - see String ClassFlags.
  267.  
  268.   INPUTS
  269.     new - pointer to Newxxxx structure corresponding to IObject classe.
  270.     id  - identification for user.
  271.  
  272.   RESULTS
  273.     object - pointer to IObject or NULL if not enough memory.
  274.  
  275.   BUGS
  276.     none known
  277.  
  278.   SEE ASLO
  279.     FreeObject(), ModifyObject()
  280.  
  281.  
  282. IObject.lib/CreateTextArea                         IObject.lib/CreateTextArea
  283.  
  284.   NAME  CreateTextArea() -- Create a TextArea
  285.  
  286.     textarea = CreateTextArea(newtextarea, rastport);
  287.  
  288.     CPTR CreateTextArea(struct NewTextArea *, struct RastPort *);
  289.  
  290.   DESCRIPTION
  291.     Create a TextArea to display text, the text will scroll when the botton
  292.     of the TextArea is reached. La structure NewTextArea is defined by:
  293.  
  294.       struct NewTextArea
  295.       {
  296.         UWORD  LeftEdge, TopEdge;
  297.         UWORD  Width, Height;
  298.         UWORD  Flags;
  299.         UWORD  ClassFlags;
  300.         STRPTR LabelText;
  301.         struct TextAttr *Font;
  302.         UBYTE  FrontPen, BackPen;
  303.         UBYTE  InterLine;
  304.         UBYTE  WrMask;
  305.       };
  306.  
  307.     LeftEdge, TopEdge - define position of the TextArea in the rastport.
  308.     Width, Height     - define size of the TextArea in the rastport.
  309.     Flags             - LABEL_ABOVE, LABEL_RIGHT, LABEK_LEFT, LABEL_BELOW,
  310.                         LABEL_PEN2 (see CreateObject.)
  311.     ClassFlags        - Flags for the TextArea:  TAF_SMOOTH_SCROLL for smooth
  312.                         scrolling (takes more times), with TAF_CLIP_TEXT text
  313.                         which is larger than the TextArea is displayed on the
  314.                         following line, else the remaining text is not
  315.                         displayed.
  316.     LabelText         - Label of TextArea.
  317.     Font              - Font for the TextArea.
  318.     FrontPen          - Text color in the TextArea.
  319.     BackPen           - Background color in the TextArea.
  320.     InterLine         - Spacing between two lines, 1 is usually enough. (0 is
  321.                         possible).
  322.     WrMask            - Mask for TextArea bitplanes, bits 1 to 8 indicate
  323.                         which bitplanes are used by the TextArea, (a bit set
  324.                         means use the corresponding bitplane. For example for
  325.                         a 3 bitplane depth screen, if you wants to use all the
  326.                         colors put 0x07, if you to use only colors  1 to 4
  327.                         puts 0x03. This field is related to the WrMask field
  328.                         in the RastPort structure. Put -1 if you don't known                        ne vous savez  pas quoi mettre. (Moins il y a de
  329.                         which value to use. (the less bitplanes wil be used
  330.                         the faster will be the displaying, if you put 0,
  331.                         nothing will be displayed.
  332.  
  333.   INPUTS
  334.     newtextarea - pointer to a NewTextArea structure.
  335.     rastport    - pointer to rastport.
  336.  
  337.   RESULT
  338.     textarea - pointer to a TextArea or NULL if no memory.
  339.  
  340.   SEE ALSO
  341.     FreeTextArea(), TAPrint(), TAPrintf(), TAPuts(), graphics/rastport.h
  342.  
  343.  
  344. IObject.lib/DisplayObject                           IObject.lib/DisplayObject
  345.  
  346.   NAME  DisplayObject() -- Display an IObject
  347.  
  348.     DisplayObject(object);
  349.  
  350.     VOID DisplayObject(CPTR);
  351.  
  352.   DESCRIPTION
  353.     Display an IObject in its window, you MUST add the IObject to a window
  354.     with AddObjectToWindow() before using DisplayObject().
  355.  
  356.   INPUTS
  357.     object - pointer to IObject.
  358.  
  359.   RESULT
  360.     none
  361.  
  362.   BUGS
  363.     none known
  364.  
  365.   SEE ALSO
  366.     EraseObject()
  367.  
  368.  
  369. IObject.lib/Draw3DBox                                   IObject.lib/Draw3DBox
  370.  
  371.   NAME  Draw3DBox() -- Draw a 3D border
  372.  
  373.     Draw3DBox(bow, rastport, type);
  374.  
  375.     VOID Draw3DBox(struct Box *, struct RastPort *, ULONG);
  376.  
  377.   DESCRIPTION
  378.     Draw a border defined by box, the border can be single or double.
  379.  
  380.   INPUTS
  381.     box      - pointer to a box.
  382.     rastport - pointer to a rastport.
  383.     type     - type of border: BOX_1IN, BOX_1OUT, BOX_2IN and BOX_2OUT.
  384.  
  385.   RESULT
  386.     none
  387.  
  388.   SEE ALSO
  389.     SetIObjectColors()
  390.  
  391.  
  392. IObject.lib/EraseObject                               IObject.lib/EraseObject
  393.  
  394.   NAME  EraseObject() -- Erase an IObject
  395.  
  396.     EraseObject(object);
  397.  
  398.     VOID EraseObject(CPTR);
  399.  
  400.   DESCRIPTION
  401.     Erase an IObject from its window, the IObject isn't removed from the
  402.     window, it is only erased.
  403.  
  404.   INPUTS
  405.     object - pointer to IObject.
  406.  
  407.   RESULT
  408.     none
  409.  
  410.   BUGS
  411.     none known
  412.  
  413.   SEE ALSO
  414.     DisplayObject()
  415.  
  416.  
  417. IObject.lib/ExitEasyGadget                         IObject.lib/ExitEasyGadget
  418.  
  419.   NAME  ExitEasyGadget() -- Free memory use by IObject.lib
  420.  
  421.     ExitEasyGadget();
  422.  
  423.     VOID ExitEasyGadget();
  424.  
  425.   DESCRIPTION
  426.     Before exiting you MUST call ExitEasyGadget().
  427.  
  428.   INPUTS
  429.     none
  430.  
  431.   RESULT
  432.     none
  433.  
  434.   BUGS
  435.     none known
  436.  
  437.   SEE ALSO
  438.     InitEasyGadget()
  439.  
  440.  
  441. IObject.lib/FindObjectMsg                           IObject.lib/FindObjectMsg
  442.  
  443.   NAME  FindObjectMsg() -- Find the IObject associated to the message
  444.  
  445.     object = FindObjectMsg(message);
  446.  
  447.     CPTR FindObjectMsg(struct IntuiMessage *);
  448.  
  449.   DESCRIPTION
  450.     Look for which IObject the IntuiMessage pertains, result is the pointer
  451.     to an IObject if message pertains to an IObject or else NULL.
  452.  
  453.   INPUTS
  454.     message - pointer to an IntuiMessage structure.
  455.  
  456.   RESULT
  457.     object - pointer to IObject associated to IntuiMessage or NULL.
  458.  
  459.   BUGS
  460.     none known
  461.  
  462.  
  463. IObject.lib/FreeObject                                 IObject.lib/FreeObject
  464.  
  465.   NAME  FreeObject()  -- Free an  IObject
  466.  
  467.     FreeObject(object);
  468.  
  469.     VOID FreeObject(CPTR);
  470.  
  471.   DESCRIPTION
  472.     Free memory used by the IObject, you must remove the IObject from the
  473.     window before free it unless.
  474.  
  475.   INPUTS
  476.     object - pointer to IObject.
  477.  
  478.   RESULT
  479.     none
  480.  
  481.   BUGS
  482.     none known
  483.  
  484.   SEE ALSO
  485.     Createxxx()
  486.  
  487.  
  488. IObject.lib/FreeTextArea                             IObject.lib/FreeTextArea
  489.  
  490.   NAME  FreeTextArea()  -- Free a TextArea
  491.  
  492.     FreeTextArea(textarea);
  493.  
  494.     VOID FreeTextArea(CPTR);
  495.  
  496.   DESCRIPTION
  497.     Frees the TextArea created by CreateTextArea().
  498.  
  499.   INPUTS
  500.     textarea - pointer to TextArea.
  501.  
  502.   RESULT
  503.     none
  504.  
  505.   BUGS
  506.     none known
  507.  
  508.   SEE ALSO
  509.     CreateTextArea()
  510.  
  511.  
  512. IObject.lib/GetHotKey                                    IObject.lib/GetHotKey
  513.  
  514.   NAME  GetHotKey() -- Returns the HotKey of an IObject
  515.  
  516.     car = GetHotKey(object);
  517.  
  518.     UBYTE GetHotKey(CPTR);
  519.  
  520.   DESCRIPTION
  521.     Returns the hot-key use by the IObject, returns 0 if there is no hot-key.
  522.     (If the IObject is ghosted it always returns 0.)
  523.  
  524.   INPUTS
  525.     object - pointer to IObject.
  526.  
  527.   RESULT
  528.     car - the hot-key or 0.
  529.  
  530.   BUGS
  531.     none known
  532.  
  533.  
  534. IObject.lib/GetObjectID                               IObject.lib/GetObjectID
  535.  
  536.   NAME  GetObjectID() -- Returns the ID of the IObject
  537.  
  538.     id = GetObjectID(object);
  539.  
  540.     UWORD GetObjectID(CPTR);
  541.  
  542.   DESCRIPTION
  543.     Returns the ID of IObject given a its creation.
  544.  
  545.   INPUTS
  546.     object - pointer to IObject.
  547.  
  548.   RESULT
  549.     id - le number given to the IObject.
  550.  
  551.   BUGS
  552.     none known
  553.  
  554.  
  555. IObject.lib/InitEasyGadget                         IObject.lib/InitEasyGadget
  556.  
  557.   NAME  InitEasyGadget() -- Initialize IObject.lib
  558.  
  559.     res = InitEasyGadget();
  560.  
  561.     BOOL InitEasyGadget();
  562.  
  563.   DESCRIPTION
  564.     You MUST call this routine before using IObject.lib, returns TRUE if you
  565.     can use the library or FALSE else.
  566.  
  567.   INPUTS
  568.     none
  569.  
  570.   RESULT
  571.     res - returns TRUE if you can use IObject.lib or FALSE else.
  572.  
  573.   BUGS
  574.     none known
  575.  
  576.   SEE ALSO
  577.     ExitEasyGadget()
  578.  
  579.  
  580. IObject.lib/ModifyObject                             IObject.lib/ModifyObject
  581.  
  582.   NAME  ModifyObject() -- Modify an IObject.
  583.  
  584.     ModifyObject(object, arg0, arg1, ...);
  585.  
  586.     VOID ModifyObject(CPTR, ...);
  587.  
  588.   DESCRIPTION
  589.     Modify an IObject, prototype depends of IObject classe.
  590.  
  591.   INPUTS
  592.     object - pointer to IObject.
  593.  
  594.     CLASS_CYCLE
  595.       ModifyObject(object, textarray, number);
  596.       VOID ModifyObject(CPTR, STRPTR *, ULONG);
  597.  
  598.       Changes the string array of the IObject, cycle, and the number of
  599.       selected option.
  600.  
  601.     textarray - the text array you want or NULL if you don't want to change it.
  602.     number    - the selected option in the text array.
  603.  
  604.     CLASS_SCROLLER
  605.       ModifyObject(object, position, visible, max);
  606.       VOID ModifyObject(CPTR, ULONG, ULONG, ULONG);
  607.  
  608.       Changes Knob position, visble size and maximal size.
  609.  
  610.     position - position of the Knob.
  611.     visible  - visible size of the scroller.
  612.     max      - maximal size of the scroller.
  613.  
  614.     CLASS_BUTTON
  615.       ModifyObject(object, select);
  616.       VOID ModifyObject(CPTR, BOOL);
  617.  
  618.       Select or unselect the button (the button must have the flag BT_TOGGLE
  619.       set.)
  620.  
  621.     select - TRUE if you want the button to be selected.
  622.  
  623.     CLASS_INTEGER
  624.       ModifyObject(object, val, min, max);
  625.       VOID ModifyObject(CPTR, LONG, LONG, LONG);
  626.  
  627.       Changes the value of the integer and its minimum and maximum.
  628.  
  629.     val - value of the integer.
  630.     min - minimum size of the integer.
  631.     max - maximal size of the integer.
  632.  
  633.     CLASS_STRING
  634.       ModifyObject(object, text);
  635.       VOID ModifyObject(CPTR, STRPTR);
  636.  
  637.       Changes the IObject text.
  638.  
  639.     text - the new text to be put in the String.
  640.  
  641.     CLASS_CHECK
  642.       ModifyObject(object, select);
  643.       VOID ModifyObject(CPTR, BOOL);
  644.  
  645.       Marks or not the Check.
  646.  
  647.     select - TRUE to mark the CheckBox.
  648.  
  649.   RESULT
  650.     none
  651.  
  652.   BUGS
  653.     none known
  654.  
  655.  
  656. IObject.lib/ObjectValue                                IObject.lib/ObjectValue
  657.  
  658.   NAME  ObjectValue() -- Returns IObject value
  659.  
  660.     val = ObjectValue(object);
  661.  
  662.     CPTR ObjectValue(CPTR);  (the type of val depends of IObject classe)
  663.  
  664.   DESCRIPTION
  665.     Returns IObject value.
  666.  
  667.   INPUTS
  668.     object - pointer to IObject.
  669.  
  670.   RESULT
  671.     CLASS_CYCLE:
  672.       index = ObjectValue(object);
  673.       UWORD ObjectValue(CPTR);
  674.  
  675.       returns the number of selected option.
  676.  
  677.     CLASS_SCROLLER:
  678.       pos = ObjectValue(object);
  679.       UWORD ObjectValue(CPTR);
  680.  
  681.       returns knob position.
  682.  
  683.     CLASS_BUTTON:
  684.       select = ObjectValue(object);
  685.       BOOL ObjectValue(CPTR);
  686.  
  687.       returns TRUE if the button is selected.
  688.  
  689.     CLASS_INTEGER:
  690.       val = ObjectValue(object);
  691.       LONG ObjectValue(CPTR);
  692.  
  693.       Returns the integer.
  694.  
  695.     CLASS_STRING:
  696.       texte = ObjectValue(object);
  697.       STRPTR ObjectValue(CPTR);
  698.  
  699.       Returns pointer to string.
  700.  
  701.     CLASS_CHECK:
  702.       select = ObjectValue(object);
  703.       BOOL ObjectValue(CPTR);
  704.  
  705.       returns TRUE is the IObject is marked.
  706.  
  707.   BUGS
  708.     none known
  709.  
  710.  
  711. IObject.lib/OffObject                                    IObject.lib/OffObject
  712.  
  713.   NAME  OffObject()  -- Ghoste an IObject
  714.  
  715.     OffObject(object);
  716.  
  717.     VOID OffObject(CPTR);
  718.  
  719.   DESCRIPTION
  720.     Ghost the IObject, to unghost the IObject use OnObject().
  721.  
  722.   INPUTS
  723.     object - pointer to IObject.
  724.  
  725.   RESULT
  726.     none
  727.  
  728.   BUGS
  729.     none known
  730.  
  731.   SEE ALSO
  732.     OnObject()
  733.  
  734.  
  735. IObject.lib/OnObject                                     IObject.lib/OnObject
  736.  
  737.   NAME  OnObject() -- UnGhoste an IObject
  738.  
  739.     OnObject(object);
  740.  
  741.     VOID OnObject(CPTR);
  742.  
  743.   DESCRIPTION
  744.     Unghost the IObject.
  745.  
  746.   INPUTS
  747.     object - pointer to IObject.
  748.  
  749.   RESULT
  750.     none
  751.  
  752.   BUGS
  753.     none known
  754.  
  755.   SEE ALSO
  756.     OffObject()
  757.  
  758.  
  759. IObject.lib/RemoveObjectFromWindow         IObject.lib/RemoveObjectFromWindow
  760.  
  761.   NAME  RemoveObjectFromWindow() -- Remove an IObject from its window
  762.  
  763.     RemoveObjectFromWindow(object);
  764.  
  765.     VOID RemoveObjectFromWindow(CPTR);
  766.  
  767.   DESCRIPTION
  768.     Remove an IObject from its window. The IObject isn't erased, to erase it
  769.     use EraseObject() before removing it.
  770.  
  771.   INPUTS
  772.     object - pointer to IObject.
  773.  
  774.   RESULT
  775.     none
  776.  
  777.   BUGS
  778.     none known
  779.  
  780.   SEE ALSO
  781.     AddObjectToWindow(), EraseDisplay()
  782.  
  783.  
  784. IObject.lib/SendMsgToObject                        IObject.lib/SendMsgToObject
  785.  
  786.   NAME  SendMsgToObject() -- Send an IntuiMessage to an IObject
  787.  
  788.     modif = SendMsgToObject(object, message);
  789.  
  790.     BOOL SendMsgToObject(CPTR, struct IntuiMessage *);
  791.  
  792.   DESCRIPTION
  793.     Send an IntuiMessage to an IObject, the IObject come from FindObjectMsg(),
  794.     return TRUE if the IObject was modified by the message. You must use
  795.     ObjectValue() to get the new value.
  796.  
  797.   INPUTS
  798.     object  - pointer to IObject.
  799.     message - pointer to an IntuiMessage structure.
  800.  
  801.   RESULT
  802.     modif - returns TRUE if the IObject was modified or FALSE else.
  803.  
  804.   BUGS
  805.     none known
  806.  
  807.   SEE ALSO
  808.     FindObjectMsg(), ObjectValue()
  809.  
  810.  
  811. IObject.lib/SetTextAreaPen                         IObject.lib/SetTextAreaPen
  812.  
  813.   NAME  SetTextAreaPen() -- Changes colors for the TextArea
  814.  
  815.     SetTextAreaPen(textarea, front, back);
  816.  
  817.     VOID SetTextAreaPen(CPTR, UBYTE, UBYTE);
  818.  
  819.   DESCRIPTION
  820.     Changes pens colors for the TextArea. If you change the back pen you should
  821.     clear the TextArea after.
  822.  
  823.   INPUTS
  824.     textarea - pointer to the TextArea.
  825.     front    - pen color for the text.
  826.     back     - color for the background.
  827.  
  828.   RESULT
  829.     none
  830.  
  831.  
  832. IObject.lib/SetIObjectColors                     IObject.lib/SetIObjectColors
  833.  
  834.   NAME  SetIObjectColors() -- Initialize couleurs for IObject.lib
  835.  
  836.     SetIObjectColors(back, light, dark, pen1, pen2);
  837.  
  838.     VOID SetIObjectColors(UBYTE, UBYTE, UBYTE, UBYTE, UBYTE);
  839.  
  840.   DESCRIPTION
  841.     Initilize colors used by IObject.lib to draw 3D border, to erase IObjects
  842.     and for the labels.
  843.  
  844.   INPUTS
  845.     back  - color use to erase the IObjects.
  846.     light - color for light side of borders.
  847.     dark  - color for dark side of borders.
  848.     pen1  - default color for labels.
  849.     pen2  - color for labels using LABEL_PEN2.
  850.  
  851.   RESULT
  852.     none
  853.  
  854.   BUGS
  855.     none known
  856.  
  857.  
  858. IObject.lib/TAPrint                                       IObject.lib/TAPrint
  859.  
  860.   NAME  TAPrint() -- Write a text in an TextArea
  861.  
  862.     TAPrint(textarea, text);
  863.  
  864.     TAPrint(CPTR, STRPTR);
  865.  
  866.   DESCRIPTION  
  867.     Write text in an TextArea. You can use '\n' in the text.
  868.  
  869.   INPUTS
  870.     textarea - pointer to the TextArea.
  871.     text     - the text to display.
  872.  
  873.   RESULT
  874.     none
  875.  
  876.   BUGS
  877.     TABS doesn't work.
  878.  
  879.   SEE ALSO
  880.     TAPrintf(), TAPuts()
  881.  
  882.  
  883. IObject.lib/TAPrintf
  884.  
  885.   NAME  TAPrintf() -- Display a formated text in an TextArea
  886.  
  887.     TAPrintf(textarea, fmttext, arg1, arg2, ...);
  888.  
  889.     VOID TAPrintf(CPTR, STRPTR, ...);
  890.  
  891.   DESCRIPTION
  892.     Display a text in a TextArea ala printf.
  893.  
  894.   INPUTS
  895.     textarea        - pointer to TextArea.
  896.     fmttext         - text with formating styles.
  897.     arg1, arg2, ... - parameters for the fmttexte.
  898.  
  899.   RESULT
  900.     none
  901.  
  902.   BUGS
  903.     none known
  904.  
  905.   SEE ALSO
  906.     RawDoFmt(), TAPuts(), TAPrint()
  907.  
  908.  
  909. IObject.lib/TAPuts                                         IObject.lib/TAPuts
  910.  
  911.   NAME  TAPuts() -- Display a text in an TextArea, do a carriage return after
  912.  
  913.     TAPuts(textarea, texte);
  914.  
  915.     VOID TAPuts(CPTR,char *);
  916.  
  917.   DESCRIPTION
  918.     The same as TAPrint(), except the carriage return.
  919.  
  920.   INPUTS
  921.     textarea - pointer to textarea.
  922.     texte    - text to display.
  923.  
  924.   RESULT
  925.     none
  926.  
  927.   BUGS
  928.    TABS doesn't work.
  929.  
  930.   SEE ALSO
  931.     TAPrintf(), TAPrint()
  932.