home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / pageclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  2.6 KB  |  84 lines
  1.  
  2.                File: pageclass.doc
  3.         Description: Pageclass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. pageclass/--background--
  13. pageclass/Methods
  14. pageclass/Attributes
  15.  
  16. pageclass/--background--                              pageclass/--background--
  17.  
  18.     NAME
  19.         Class:          pageclass
  20.         Superclass:     baseclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide   a gadget which can keep track of "pages" of gadgets from
  25.         which one is displayed at the time. The pages can contain a groupclass
  26.         object which has a set of members or it can contain a single gadget.
  27.  
  28.         Object  from  this  class  sends  out the following attribute pairs in
  29.         their notification events:
  30.  
  31.         PAGE_Active     - Currently active page number.
  32.  
  33. pageclass/Methods                                            pageclass/Methods
  34.  
  35.     NEW METHODS
  36.         None.
  37.  
  38.     CHANGED METHODS
  39.         OM_DISPOSE -- When this method is called it will also  dispose  of all
  40.                 pages of objects attached to this object.
  41.  
  42. pageclass/Attributes                                      pageclass/Attributes
  43.  
  44.     NAME
  45.         PAGE_Member -- ( Object * )
  46.  
  47.     FUNCTION
  48.         To add a page of gadgets. The object may be a groupclass object having
  49.         any number of members or it may be a single gadget object.
  50.  
  51.         Default is NULL. Applicability is (I).
  52.  
  53.     NAME
  54.         PAGE_Active -- ( ULONG )
  55.  
  56.     FUNCTION
  57.         Set the page number  currently  active (I.E. displayed on the window).
  58.         The active page is the only page that can receive input.
  59.  
  60.         Default 0. Applicability is (ISGNU).
  61.  
  62.     NAME
  63.         PAGE_NoBufferRP -- ( BOOL )
  64.  
  65.     FUNCTION
  66.         When this  attribute is  set  to  TRUE the  pageclass  will  tell  the
  67.         layout engine not to  setup a  buffer  RastPort  which  means that all
  68.         rendering occures  on-screen.   This may be handy when you use objects
  69.         which  take  some  time  to  render  like the colorwheel.gadget on 256
  70.         colour screens.
  71.  
  72.         Default is FALSE. Applicability is (I).
  73.  
  74.     NAME
  75.         PAGE_Inverted -- ( BOOL )
  76.  
  77.     FUNCTION
  78.         To force the members added at create time  to be  AddHead()'ed  to the
  79.         member  list  instead  of  AddTail()'ed.   This  is  necessary for the
  80.         assembly macros of the BGUI package.
  81.  
  82.         Default is FALSE. Applicability is (I).
  83.  
  84.