home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / libraries / bgui10.lha / docs / bgui.doc < prev    next >
Encoding:
Text File  |  1994-07-16  |  10.0 KB  |  291 lines
  1.  
  2.            $RCSfile: bgui.doc,v $
  3.         Description: bgui.library documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.2 $
  10.               $Date: 1994/07/16 18:18:43 $
  11. -------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. bgui.library/BGUI_GetClassPtr
  16. bgui.library/BGUI_NewObjectA
  17. bgui.library/BGUI_RequestA
  18. bgui.library/BGUI_Help
  19. bgui.library/BGUI_LockWindow
  20. bgui.library/BGUI_UnlockWindow
  21. bgui.library/BGUI_DoGadgetMethodA
  22.  
  23. bgui.library/BGUI_GetClassPtr                      bgui.library/BGUI_GetClassPtr
  24.  
  25.     NAME
  26.         BGUI_GetClassPtr -- Obtain a pointer to a BGUI class.
  27.  
  28.     SYNOPSIS
  29.         class = BGUI_GetClassPtr( classID )
  30.         D0                        D0
  31.  
  32.         Class *BGUI_GetClassPtr( ULONG );
  33.  
  34.     FUNCTION
  35.         This function is ment to provide class writers an  easy way  to obtain a
  36.         pointer to one of the bgui.library classes. The pointer returned by this
  37.         routine may _only_ be used to subclass or to obtain objects from. Either
  38.         reading from or writing to the class structure is not allowed.
  39.  
  40.     INPUTS
  41.         classID         - The numeric ID of the class you need.
  42.  
  43.     RESULT
  44.         A pointer to the requested class or NULL if the call was  unsuccessfull.
  45.  
  46.     BUGS
  47.         None known.
  48.  
  49.     SEE ALSO
  50.         libraries/bgui.h
  51.  
  52. bgui.library/BGUI_NewObjectA                        bgui.library/BGUI_NewObjectA
  53.  
  54.     NAME
  55.         BGUI_NewObjectA -- Get an object from a class.
  56.         BGUI_NewObject -- Varargs version.
  57.  
  58.     SYNOPSIS
  59.         object = BGUI_NewObjectA( classID, tags )
  60.         D0                        D0       A0
  61.  
  62.         Object *BGUI_NewObjectA( ULONG, struct TagItem * )
  63.  
  64.         object = BGUI_NewObject( classID, tag1, ... )
  65.  
  66.         Object *BGUI_NewObject( ULONG, Tag, ... )
  67.  
  68.     FUNCTION
  69.         This routine is a replacement routine for intuition's NewObjectA() call.
  70.         It is an easy way to obtain an object from any of the  BGUI classes. You
  71.         pass it a classID and some create time attributes  and the  routine will
  72.         return you a pointer to the created object.
  73.  
  74.     INPUTS
  75.         classID - The numeric ID of the class.
  76.  
  77.         tags    - A set of create-time attributes  which will be passed onto the
  78.                   class of which the object is created.
  79.  
  80.     RESULT
  81.         A pointer to the created object or NULL if an error occured.
  82.  
  83.     BUGS
  84.         None known.
  85.  
  86.     SEE ALSO
  87.         intuition.library/NewObjectA(), libraries/bgui.h
  88.  
  89. bgui.library/BGUI_RequestA                            bgui.library/BGUI_RequestA
  90.  
  91.     NAME
  92.         BGUI_RequestA -- Put up a requester.
  93.         BGUI_Request -- Varargs version.
  94.  
  95.     SYNOPSIS
  96.         gadid = BGUI_RequestA( win, req, args )
  97.         D0                     A0   A1   A2
  98.  
  99.         ULONG BGUI_RequestA( struct Window *, struct bguiRequest *, ULONG * )
  100.  
  101.         gadid = BGUI_Request( win, req, arg1, ... )
  102.  
  103.         ULONG BGUI_Request( struct Window *, struct bguiRequest *, ULONG, ... )
  104.  
  105.     FUNCTION
  106.         To  put  up  a  requester.   It  is typically the  same  as  intuition's
  107.         EasyRequestArgs() only this routine allows you to put in InfoClass style
  108.         command sequences in the body text.
  109.  
  110.     INPUTS
  111.         win     - A pointer to the window on which the requester will open. This
  112.                   may be NULL.
  113.  
  114.         req     - A pointer to  an  initialized  bguiRequest  structure.    This
  115.                   structure is  simular  to  intuition's  EasyStruct  structure.
  116.                   It is used to control the  general  look of the requester. The
  117.                   structure is  initialized  with the following data:
  118.  
  119.                   br_Flags        - This  field can contain any of the following
  120.                                     flags:
  121.  
  122.                                     BREQF_CENTERWINDOW
  123.                                         This  will center the requester over the
  124.                                         window 'win' if a  valid  pointer  to  a
  125.                                         window is passed.
  126.  
  127.                                     BREQF_LOCKWINDOW
  128.                                         This will  disable  the window  on which
  129.                                         the requester appears from receiving any
  130.                                         IDCMP messages.   Also a busy pointer is
  131.                                         set on that window.   NOTE: ' win'  must
  132.                                         point to a window for this to work.
  133.  
  134.                                     BREQF_NO_PATTERN
  135.                                         This will suppress the backfill pattern.
  136.  
  137.                                     BREQF_XEN_BUTTONS
  138.                                         When set this flag will make the buttons
  139.                                         framing appear as XEN style framing.
  140.  
  141.                   br_Title        - A pointer to the title of the requester.  If
  142.                                     this is NULL the title of the window is used
  143.                                     if one is present.  In the  last  case "BGUI
  144.                                     Request"  or  it's  localized  equivalent is
  145.                                     used.
  146.  
  147.  
  148.                   br_GadgetFormat - A  pointer to the gadget label string.   The
  149.                                     gadget  labels   are   truncated  by  a  '|'
  150.                                     character. I.E "OK|Cancel" will give  you  a
  151.                                     "OK" and a "Cancel" gadget.
  152.  
  153.                   br_TextFormat   - A printf-style formatting  string which  may
  154.                                     also   contain   InfoClass   style   command
  155.                                     sequences.
  156.  
  157.                   br_ReqPos       - The  position  at which   the requester will
  158.                                     be opened.   There are three possibilities:
  159.  
  160.                                     POS_CENTERSCREEN
  161.                                     POS_CENTERMOUSE
  162.                                     POS_TOPLEFT
  163.  
  164.                                     It should be obvious what  they mean.  NOTE:
  165.                                     The  BREQF_CENTERWINDOW  flag  will override
  166.                                     this setting.
  167.  
  168.                   br_Reserved     - These fields  are  for  future expansion and
  169.                                     _must_ be zero'd.
  170.  
  171.         args    - A pointer to an array of arguments for the  C-style formatting
  172.                   codes.
  173.  
  174.     RESULT
  175.         1, 2, 3, 4 ....., 0 You will be returned a value ranging  from  0 to the
  176.         amount of gadgets minus one.     NOTE: The right most gadget will always
  177.         return 0.
  178.  
  179.     BUGS
  180.         This routine  really  should support underscored characters and keyboard
  181.         short cuts.
  182.  
  183.     SEE ALSO
  184.         intuition.library/EasyRequestArgs(), intuition/intuition.h,
  185.         libraries/bgui.h, infoclass.doc
  186.  
  187. bgui.library/BGUI_Help                                    bgui.library/BGUI_Help
  188.  
  189.     NAME
  190.         BGUI_Help -- Put up a simple synchronus amigaguide help file.
  191.  
  192.     SYNOPSIS
  193.         success = BGUI_Help( win, file, node, line )
  194.         D0                   A0   A1    A2    D0
  195.  
  196.         BOOL BGUI_Help( struct Window *, UBYTE *, UBYTE *, ULONG )
  197.  
  198.     FUNCTION
  199.         To show additional online-help using the amigaguide system.
  200.  
  201.     INPUTS
  202.         win     - A pointer to the window which shows the help.
  203.  
  204.         name    - A pointer to the full path name of the amigaguide file.
  205.  
  206.         node    - A pointer to the node name to display.
  207.  
  208.         line    - The line number to display.
  209.  
  210.     RESULT
  211.         TRUE uppon success and FALSE if something went wrong.
  212.  
  213.     BUGS
  214.         None known.
  215.  
  216.     SEE ALSO
  217.         amigaguide.library/OpenAmigaGuideA()
  218.  
  219. bgui.library/BGUI_LockWindow                        bgui.library/BGUI_LockWindow
  220.  
  221.     NAME
  222.         BGUI_LockWindow -- Disable a window from receiving IDCMP.
  223.  
  224.     SYNOPSIS
  225.         lock = BGUI_LockWindow( win )
  226.         D0                      A0
  227.  
  228.         APTR BGUI_LockWindow( struct Window * )
  229.  
  230.     FUNCTION
  231.         To disable a window from receiving IDCMP messages on  it's message port.
  232.         This is done by putting  up an  invisible  requester and a  busy pointer
  233.         same as the workbench uses. The only thing possible with  locked windows
  234.         is moving it with the dragbar and depth gadget.
  235.  
  236.     INPUTS
  237.         win     - A pointer to the window to lock.
  238.  
  239.     RESULT
  240.         lock will point to some private data if successfull or NULL if not.
  241.  
  242.     BUGS
  243.         None know.
  244.  
  245.     SEE ALSO
  246.         bgui.library/BGUI_UnlockWindow()
  247.  
  248. bgui.library/BGUI_UnlockWindow                    bgui.library/BGUI_UnlockWindow
  249.  
  250.     NAME
  251.         BGUI_UnlockWindow -- Enable a window from receiving IDCMP.
  252.  
  253.     SYNOPSIS
  254.         BGUI_UnlockWindow( lock )
  255.                            A0
  256.  
  257.         VOID BGUI_UnlockWindow( APTR )
  258.  
  259.     FUNCTION
  260.         To enable a window to receive IDCMP messages on  it's message port. This
  261.         routine must be used to 'unlock' windows locked with BGUI_LockWindow().
  262.  
  263.     INPUTS
  264.         lock    - A pointer to the data returned by BGUI_LockWindow().  This may
  265.                   be NULL.
  266.  
  267.     RESULT
  268.         The window will be unlocked.
  269.  
  270.     BUGS
  271.         None know.
  272.  
  273.     SEE ALSO
  274.         bgui.library/BGUI_LockWindow()
  275.  
  276. bgui.library/BGUI_DoGadgetMethodA            bgui.library/BGUI_DoGadgetMethodA
  277.  
  278.     **************************************************************************
  279.     This routine is the same as intuition's DoGadgetMethod() routine  with the
  280.     exception  that  this call is _simulated_ on systems running lower than OS
  281.     3.0.   I  have  not  yet  experienced problems with this routine  on these
  282.     systems but please keep in mind that it is basically a hack under 2.04.
  283.     **************************************************************************
  284.  
  285.     BUGS
  286.         This call is simulated on systems running lower than OS 3.0.  There is
  287.         no way to avoid this...
  288.  
  289.     SEE ALSO
  290.         intuition.library/DoGadgetMethod()
  291.