home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / DC-POS24.LZX / pOS / pOS_RKRM.lzx / pOS_RKRM / _Docs / pGadget.doc < prev    next >
Encoding:
Text File  |  1997-03-18  |  12.3 KB  |  536 lines
  1. TABLE OF CONTENTS
  2.  
  3. pGadget.library/pOS_GadgetHandleIEvent
  4. pGadget.library/pOS_CalcGadgetBox
  5. pGadget.library/pOS_CalcGadgetInnerBox
  6. pGadget.library/pOS_DrawGadget
  7. pGadget.library/pOS_NewGObjectA
  8. pGadget.library/pOS_DisposeGObject
  9. pGadget.library/pOS_ObtainGRastPort
  10. pGadget.library/pOS_ReleaseGRastPort
  11. pGadget.library/pOS_GadgetHitTest
  12. pGadget.library/pOS_GadgetHitTestC
  13. pGadget.library/pOS_LinkGadHelpIDs
  14. pGadget.library/pOS_AddLinkGadHelpID
  15. pGadget.library/pOS_AddLinkGadHelpAll
  16. pGadget.library/pOS_CalcRelMousePoint
  17. pGadget.library/pOS_GadgetDeleteDragList
  18. pGadget.library/pOS_GadgetDropTest
  19. pGadget.library/pOS_GadgetDropIEvent
  20. pGadget.library/pOS_DrawDisableRect
  21. pGadget.library/pOS_IsGadgetMember
  22.  
  23. pGadget.library/pOS_GadgetHandleIEvent
  24.  
  25.    NAME
  26.        pOS_GadgetHandleIEvent -- InputEvent auswerten
  27.  
  28.    SYNOPSIS
  29.         BOOL pOS_GadgetHandleIEvent(Unit,InputEvent);
  30.         _R_D0                      _R_A0    _R_A1
  31.  
  32.         BOOL pOS_GadgetHandleIEvent(
  33.                    struct pOS_IntuiUnit*,struct pOS_InputEvent*);
  34.  
  35.    FUNCTION
  36.  
  37.    INPUTS
  38.         Unit       - pIntui-Unit
  39.         InputEvent - Event
  40.  
  41.    RESULT
  42.         TRUE => Event wurde vollständig bearbeitet
  43.  
  44.    SEE ALSO
  45.  
  46.  
  47. pGadget.library/pOS_CalcGadgetBox
  48.  
  49.    NAME
  50.        pOS_CalcGadgetBox -- Gesamte Gadget-Fläche berechnen
  51.  
  52.    SYNOPSIS
  53.         VOID pOS_CalcGadgetBox(window,gadget,rectangle);
  54.                               _R_A0    _R_A1   _R_A2
  55.  
  56.         VOID pOS_CalcGadgetBox(
  57.                    const struct pOS_Window*,const struct pOS_Gadget*,
  58.                    struct pOS_Rectangle*);
  59.  
  60.    FUNCTION
  61.         Berechnung der Gadget-Koordinaten im Window. Wird das Gadget
  62.         relativ zur Window-Größe dargestellt, so berechnet
  63.         pOS_CalcGadgetBox() die jetzige absolute Größe.
  64.  
  65.    INPUTS
  66.         window    - Gadget-Window
  67.         gadget    - zu berechnendes Gadget
  68.         rectangle - Ergebnis
  69.  
  70.    RESULT
  71.  
  72.    SEE ALSO
  73.  
  74.  
  75. pGadget.library/pOS_CalcGadgetInnerBox
  76.  
  77.    NAME
  78.        pOS_CalcGadgetInnerBox -- Zeichenfläche für Gadget berechnen
  79.  
  80.    SYNOPSIS
  81.         VOID pOS_CalcGadgetInnerBox(window,gadget,rectangle);
  82.                                      _R_A0    _R_A1   _R_A2
  83.  
  84.         VOID pOS_CalcGadgetInnerBox(
  85.                    const struct pOS_Window*,const struct pOS_Gadget*,
  86.                    struct pOS_Rectangle*);
  87.  
  88.    FUNCTION
  89.         Siehe pOS_CalcGadgetBox()
  90.         Das Ergebnis dieser Berechnung ist die Fläche, in der sich das
  91.         Gadget zeichnen muß. Der Gadget-Border wird beachtet und aus der
  92.         Gadget-Fläche herausgerechnet.
  93.  
  94.    INPUTS
  95.         window    - Gadget-Window
  96.         gadget    - zu berechnendes Gadget
  97.         rectangle - Ergebnis
  98.  
  99.    RESULT
  100.  
  101.    SEE ALSO
  102.  
  103.  
  104. pGadget.library/pOS_DrawGadget
  105.  
  106.    NAME
  107.        pOS_DrawGadget -- Gadget zeichnen
  108.  
  109.    SYNOPSIS
  110.         VOID pOS_DrawGadget(gadget,method,mode);
  111.                            _R_A0    _R_A1 _R_D0
  112.  
  113.         VOID pOS_DrawGadget(
  114.                    const struct pOS_Gadget*,struct pOS_GadgetMethod*,ULONG);
  115.  
  116.    FUNCTION
  117.         Bevor die Funktion aufgerufen wird, müssen folgende Daten gesetzt
  118.         werden:
  119.           imth_Render.imre_Info
  120.           imth_Render.imre_NewTick
  121.           imth_Render.imre_OldTick
  122.         Das Gadget wird dann mit dem Zeichenmodus 'mode' gezeichnet.
  123.  
  124.    INPUTS
  125.         gadget  - zu zeichnendes Gadget
  126.         methode - gefullte Daten-Struktur
  127.         mode    - (enum pOS_GadgetClassRender)
  128.    RESULT
  129.  
  130.    SEE ALSO
  131.  
  132.  
  133. pGadget.library/pOS_NewGObjectA
  134.  
  135.    NAME
  136.        pOS_NewGObjectA -- neues Objekt erzeugen
  137.  
  138.    SYNOPSIS
  139.         obj = pOS_NewGObjectA(NClass,name, ver,  tagList);
  140.         _R_D0                 _R_A0  _R_A1 _R_D0  _R_A2
  141.  
  142.         __ARID__ APTR pOS_NewGObjectA(
  143.                    struct pOS_NClass*,const CHAR*,ULONG,const pOS_TagItem*);
  144.  
  145.    FUNCTION
  146.  
  147.    INPUTS
  148.         NClass  - Zeiger auf die Klasse
  149.         name    - Name der Klasse
  150.         ver     - Version der Klass
  151.         tagList - Parameter
  152.  
  153.    RESULT
  154.         neues Objekt oder NULL
  155.  
  156.    SEE ALSO
  157.  
  158.  
  159. pGadget.library/pOS_DisposeGObject
  160.  
  161.    NAME
  162.        pOS_DisposeGObject -- Objekt löschen
  163.  
  164.    SYNOPSIS
  165.         VOID pOS_DisposeGObject(object);
  166.                                 _R_A0
  167.  
  168.         VOID pOS_DisposeGObject(__ARID__ APTR);
  169.  
  170.    FUNCTION
  171.         Ein mit pOS_NewGObjectA() erzeugtes Objekt muß mit
  172.         pOS_DisposeGObject() wieder gelöscht werden.
  173.  
  174.    INPUTS
  175.         objekt - zu löschendes Objekt
  176.    RESULT
  177.  
  178.    SEE ALSO
  179.  
  180.  
  181. pGadget.library/pOS_ObtainGRastPort
  182.  
  183.    NAME
  184.        pOS_ObtainGRastPort -- Gadget-RastPort ermitteln
  185.  
  186.    SYNOPSIS
  187.         rp = pOS_ObtainGRastPort(gadget,info);
  188.         _R_D0                    _R_A0   _R_A1
  189.  
  190.         struct pOS_RastPort *pOS_ObtainGRastPort(
  191.                    const struct pOS_Gadget*,const struct pOS_IClassInfo*);
  192.  
  193.    FUNCTION
  194.         Ein Gadget darf sich nur in den RastPort zeichnen, der hiermit
  195.         ermittelt wurde. Der RastPort muß wieder mit pOS_ReleaseGRastPort()
  196.         abgemeldet werden.
  197.  
  198.    INPUTS
  199.         gadget - zu zeichnendes Gadget
  200.         info   - Bezugsdaten
  201.  
  202.    RESULT
  203.         RastPort zum Zeichnen oder NULL
  204.  
  205.    SEE ALSO
  206.  
  207.  
  208. pGadget.library/pOS_ReleaseGRastPort
  209.  
  210.    NAME
  211.         pOS_ReleaseGRastPort -- Gadget-RastPort abgelden
  212.  
  213.    SYNOPSIS
  214.         VOID pOS_ReleaseGRastPort(info,rp);
  215.                                _R_A0   _R_A1
  216.  
  217.         VOID pOS_ReleaseGRastPort(
  218.                    const struct pOS_IClassInfo*,struct pOS_RastPort*);
  219.  
  220.    FUNCTION
  221.         Freigeben eines mit pOS_ObtainGRastPort() ermittelten
  222.         RastPorts.
  223.  
  224.    INPUTS
  225.         info - Bezugsdaten
  226.         rp   - RastPort von pOS_ObtainGRastPort()
  227.  
  228.    RESULT
  229.  
  230.    SEE ALSO
  231.  
  232.  
  233. pGadget.library/pOS_GadgetHitTest
  234.  
  235.    NAME
  236.        pOS_GadgetHitTest -- Ermittelt Position innerhalb Gadget
  237.  
  238.    SYNOPSIS
  239.         gad = pOS_GadgetHitTest(method,gadget);
  240.         _R_D0                   _R_A0   _R_A1
  241.  
  242.        struct pOS_Gadget* pOS_GadgetHitTest(
  243.                 struct pOS_GadgetMethod*,const struct pOS_Gadget*);
  244.  
  245.    FUNCTION
  246.         Vor dem Funktionsaufruf muß
  247.            imth_HitTest.imht_AMouse und
  248.            imth_HitTest.imht_RMouse
  249.         gestzt werden. Es wird imth_Method mit GCLMTH_HitTest
  250.         überschrieben. Liegt die Position 'imht_AMouse' im Gadget,
  251.         wird das betreffende Gadget zurückgegeben. Es ist nicht
  252.         sichergestellt, daß das 'gadget' ebenfalls als Ergebnis dient.
  253.  
  254.    INPUTS
  255.         method - gefüllte Struktur
  256.         gadget - zu prüfendes Gadget
  257.  
  258.    RESULT
  259.         Gadget, das an der Position liegt.
  260.  
  261.    SEE ALSO
  262.  
  263.  
  264. pGadget.library/pOS_GadgetHitTestC
  265.  
  266.    NAME
  267.        pOS_GadgetHitTestC --
  268.  
  269.    SYNOPSIS
  270.         gad = pOS_GadgetHitTestC(method,gadget,mode);
  271.         _R_D0                   _R_A0   _R_A1  _R_D0
  272.  
  273.        struct pOS_Gadget* pOS_GadgetHitTestC(
  274.                    const struct pOS_GadgetMethod*,const struct pOS_Gadget*,
  275.                    ULONG mode);
  276.  
  277.    FUNCTION
  278.         Im Gegensatz zu pOS_GadgetHitTest() wird 'method' nicht verändert.
  279.  
  280.  
  281.    INPUTS
  282.         method - gefüllt Struktur
  283.         gadget - zu prüfendes Gadget
  284.         mode   - 0
  285.  
  286.    RESULT
  287.         Gadget, das an der Position liegt.
  288.  
  289.    SEE ALSO
  290.  
  291.  
  292. pGadget.library/pOS_LinkGadHelpIDs
  293.  
  294.    NAME
  295.        pOS_LinkGadHelpIDs -- Erstellt einen gesamten Help-Path
  296.  
  297.    SYNOPSIS
  298.         str = pOS_LinkGadHelpIDs(screen, point, buffer, bufSize, level);
  299.         _R_D0                   _R_A0   _R_A1  _R_A2    _R_D0    _R_D1
  300.  
  301.        const CHAR* pOS_LinkGadHelpIDs(
  302.                    struct pOS_Screen*,const struct pOS_Point*,
  303.                    CHAR*,size_t,ULONG level);
  304.  
  305.    FUNCTION
  306.         Vollständiger Help-Path an einer Pixelposition erstellen.
  307.  
  308.  
  309.    INPUTS
  310.         screen  - Screen auf welchen die HelpID berechnet werden soll.
  311.         point   - Pixelposition relativ zum Screen
  312.         buffer  - Arbeitspuffer für den Help-Path
  313.         bufSize - Byte-Länge von 'buffer'
  314.         level   - Arbeits-Level (0,1,2...)
  315.  
  316.    RESULT
  317.         buffer, NULL => kein Help verfügbar
  318.  
  319.    SEE ALSO
  320.  
  321.  
  322. pGadget.library/pOS_AddLinkGadHelpID
  323.  
  324.    NAME
  325.        pOS_AddLinkGadHelpID -- Help-String anhängen
  326.  
  327.    SYNOPSIS
  328.         VOID pOS_AddLinkGadHelpID(method,name);
  329.                                  _R_A0   _R_A1
  330.  
  331.        VOID pOS_AddLinkGadHelpID(struct pOS_GadgetMethod*,const CHAR*);
  332.  
  333.    FUNCTION
  334.  
  335.    INPUTS
  336.         method - initialisierte 'imth_Help' Daten
  337.         name   - zu addierender Help-Part
  338.  
  339.    RESULT
  340.  
  341.    SEE ALSO
  342.  
  343.  
  344. pGadget.library/pOS_AddLinkGadHelpAll
  345.  
  346.    NAME
  347.        pOS_AddLinkGadHelpAll -- Gadget-Tree durchlaufen und Help-Path bilden
  348.  
  349.    SYNOPSIS
  350.         ULONG pOS_AddLinkGadHelpAll(gadget,method);
  351.          _R_D0                      _R_A0   _R_A1
  352.  
  353.        ULONG pOS_AddLinkGadHelpAll(
  354.                    const struct pOS_Gadget*,struct pOS_GadgetMethod*);
  355.  
  356.    FUNCTION
  357.  
  358.    INPUTS
  359.         gadget - Gadget, das ein Help erhalten soll
  360.         method - initialisierte 'imth_Help' Daten
  361.  
  362.    RESULT
  363.         aktueller Level
  364.  
  365.    SEE ALSO
  366.  
  367.  
  368. pGadget.library/pOS_CalcRelMousePoint
  369.  
  370.    NAME
  371.        pOS_CalcRelMousePoint -- Relative Gadget-Koors berechnen
  372.  
  373.    SYNOPSIS
  374.         pOS_CalcRelMousePoint(gadget, window,abs,  rel);
  375.                               _R_A0  _R_A1  _R_A2  _R_A3
  376.  
  377.        VOID pOS_CalcRelMousePoint(
  378.                    const struct pOS_Gadget*,const struct pOS_Window*,
  379.                    const struct pOS_Point*,struct pOS_Point*);
  380.  
  381.    FUNCTION
  382.  
  383.    INPUTS
  384.         gadget - Gadget
  385.         window - Window, in dem 'gadget' dargestellt wird
  386.         abs    - absolute Koordinaten im Window
  387.         rel    - Ergebnis: relative Koordinaten im Gadget
  388.  
  389.    RESULT
  390.  
  391.    SEE ALSO
  392.  
  393.  
  394. pGadget.library/pOS_GadgetDeleteDragList
  395.  
  396.    NAME
  397.        pOS_GadgetDeleteDragList -- Drag-Objekt freigeben
  398.  
  399.    SYNOPSIS
  400.         pOS_GadgetDeleteDragList(DragList);
  401.                                  _R_A0
  402.  
  403.         VOID pOS_GadgetDeleteDragList(struct pOS_DragList*);
  404.  
  405.    FUNCTION
  406.         Alle Drag-Objekte werden zum Sende-Gadget geschickt und
  407.         freigegeben.
  408.  
  409.    INPUTS
  410.         DragList - Liste der Drag-Objekte
  411.  
  412.    RESULT
  413.  
  414.    SEE ALSO
  415.  
  416.  
  417. pGadget.library/pOS_GadgetDropTest
  418.  
  419.    NAME
  420.        pOS_GadgetDropTest -- Ermittelt Drop-Position innerhalb Gadget
  421.  
  422.    SYNOPSIS
  423.         gad = pOS_GadgetDropTest(method,gadget);
  424.         _R_D0                    _R_A0   _R_A1
  425.  
  426.         struct pOS_Gadget* pOS_GadgetDropTest(
  427.                    struct pOS_GadgetMethod*,const struct pOS_Gadget*);
  428.  
  429.    FUNCTION
  430.         Vor dem Funktionsaufruf muß
  431.            imth_DropTest.imdt_AMouse und
  432.            imth_DropTest.imdt_RMouse
  433.         gestzt werden. Es wird imth_Method mit GCLMTH_DropTest
  434.         überschrieben. Liegt die Position 'imdt_AMouse' im Gadget, wird
  435.         das betreffende Gadget zurückgegeben. Es ist nicht sichergestellt,
  436.         daß das 'gadget' ebenfalls als Ergebnis dient.
  437.  
  438.    INPUTS
  439.         method - gefüllte Struktur
  440.         gadget - zu prüfendes Gadget
  441.  
  442.    RESULT
  443.         Gadget, das an der Position liegt.
  444.  
  445.    SEE ALSO
  446.  
  447.  
  448. pGadget.library/pOS_GadgetDropIEvent
  449.  
  450.    NAME
  451.        pOS_GadgetDropIEvent -- InputEvent während dem Drag&Drop auswerten
  452.  
  453.    SYNOPSIS
  454.         BOOL pOS_GadgetDropIEvent(Unit,  ie,  DragList);
  455.         _R_D0                   _R_A0   _R_A1  _R_A2
  456.  
  457.         BOOL pOS_GadgetDropIEvent(
  458.                    struct pOS_IntuiUnit*,struct pOS_InputEvent*,
  459.                    struct pOS_DragList*);
  460.  
  461.    FUNCTION
  462.  
  463.    INPUTS
  464.         Unit     - pIntui-Unit
  465.         ie       - Event
  466.         DragList - Liste der Drag-Objekte
  467.  
  468.    RESULT
  469.  
  470.    SEE ALSO
  471.  
  472.  
  473. pGadget.library/pOS_DrawDisableRect
  474.  
  475.    NAME
  476.        pOS_DrawDisableRect -- Gitter zeichnen
  477.  
  478.    SYNOPSIS
  479.         pOS_DrawDisableRect(rp,x1,y1,x2,y2);
  480.                        _R_A0   _R_D0 - _R_D3
  481.  
  482.         VOID pOS_DrawDisableRect(
  483.                    struct pOS_RastPort*,SLONG,SLONG,SLONG,SLONG);
  484.  
  485.    FUNCTION
  486.  
  487.    INPUTS
  488.         rp          - RastPort
  489.         x1,y1,x2,y2 - Rectange-Koordinaten
  490.  
  491.    RESULT
  492.  
  493.    SEE ALSO
  494.  
  495.  
  496. pGadget.library/pOS_IsGadgetMember
  497.  
  498.    NAME
  499.        pOS_IsGadgetMember -- Prüft, ob Gadget Member ist
  500.  
  501.    SYNOPSIS
  502.         BOOL pOS_IsGadgetMember(grpGad,membGad);
  503.         _R_D0                   _R_A0   _R_A1
  504.  
  505.         BOOL pOS_IsGadgetMember(
  506.                    const struct pOS_Gadget*,const struct pOS_Gadget*);
  507.  
  508.    FUNCTION
  509.         Es wird ermittelt, ob 'membGad' innerhalb (direkt oder indirekt)
  510.         in der Gruppe 'grpGad' steht.
  511.  
  512.         Grp1
  513.         {
  514.           Grp2
  515.           {
  516.             Gad21
  517.             Gad22
  518.           }
  519.           Gad11
  520.           Gad12
  521.         }
  522.  
  523.         Gad11 und Gad12 sind Member von Grp1.
  524.         Gad21 und Gad22 sind Member von Grp2 und Grp1.
  525.  
  526.    INPUTS
  527.         grpGad  - Gruppe
  528.         membGad - zu prüfendes Gadget
  529.  
  530.    RESULT
  531.         TRUE => Gadget ist Member von 'grpGad' (direkt oder indirekt)
  532.  
  533.    SEE ALSO
  534.  
  535.  
  536.