home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / Classes / Doguet / ScreenModeClass10 / Doc / ScreenModeClass.doc < prev   
Encoding:
Text File  |  1995-08-04  |  5.3 KB  |  256 lines
  1.  
  2.                File: ScreenModeClass.Doc
  3.         Description: ScreenModeClass documentation.
  4.           Copyright: (C) Copyright 1995 Doguet Emmanuel.
  5.                      All Rights Reserved.
  6.  
  7. ------------------------------------------------------------------------------
  8.  
  9. TABLE OF CONTENTS
  10.  
  11. ScreenModeClass/--background--
  12. ScreenModeClass/Methods
  13. ScreenModeClass/Attributes
  14.  
  15. ScreenModeClass/--background--                              ScreenModeClass/--background--
  16.  
  17.     NAME
  18.         Class:          ScreenModeClass
  19.         Superclass:
  20.         Include File    "ScreenModeClass.h"
  21.  
  22.     FUNCTION
  23.  
  24.         To provide you with a very easy  way  to  implement  some  ScreenMode
  25.         requester  in  your programs.
  26.         The advantage of this  class  it  that  the  objects  remember  their
  27.         complete setting as long as the object remains valid.
  28.  
  29.         This class provide too, some new feature to the screenmode requester like:
  30.  
  31.             - Can layout position of the info-window.
  32.               For have it over the screen mode requester :-(.
  33.  
  34.             - Repair asl-bug (ASLSM_MinWidth & ASLSM_MinHeight) with the new-tag
  35.               SMC_ControlMinSize.
  36.  
  37.             - New tag SMC_GUI_MODES who display screenmode who support GUI (no LORES..).
  38.  
  39.             - Easy installation ( great when we believe how work asl-screenmode requester);
  40.  
  41.  
  42.         Also you program must open the following libraries:
  43.  
  44.         asl.library         - V37 or better.
  45.         intuition.library   - V37 or better.
  46.         utility.library     - V37 or better.
  47.  
  48.         The source of this class is based on some  sources  of  Jan  Van  Den
  49.         Baard, the creator of the famous library: the bgui.library !!!!!
  50.  
  51.  
  52. ScreenModeClass/Methods                                     ScreenModeClass/Methods
  53.  
  54.     NEW_METHODS
  55.         OM_NEW
  56.  
  57.         OM_DISPOSE
  58.  
  59.         OM_GET
  60.  
  61.     CHANGED METHODS
  62.         None.
  63.  
  64.  
  65.  
  66.  
  67. ScreenModeClass/Attributes                                  ScreenModeClass/Attributes
  68.  
  69.     NAME
  70.         SMC_InitialInfoPos -- (ULONG)
  71.  
  72.     FUNCTION
  73.         Open the info window on the left or on the right of the  screen  mode
  74.         requester. ( SMC_INFOPOS_TopLeft, SMC_INFOPOS_TopRight ).
  75.  
  76.     Default is NULL -   Applicability is (S)
  77.  
  78.  
  79.  
  80.     NAME
  81.         SMC_InfoPosArround -- (BOOL)
  82.  
  83.     FUNCTION
  84.  
  85.         Allow  to  open  the  info  window  always  around  the  screen  mode
  86.         requester. If there were no place on it's left, it go to its right...
  87.  
  88.         ( Only for  the  first  request  or  after  each  request,  save  the
  89.         screen-mode-requester  positition,  dispose  and  redo  a  newobject.
  90.         Because I use ASL-TAG who work only at initialisation ).
  91.  
  92.  
  93.     Default is NULL -   Applicability is (S)
  94.  
  95.  
  96.  
  97.     NAME
  98.         SMC_DisplayID       --  (ULONG)
  99.  
  100.     FUNCTION
  101.         Set the activate-default Mode ID.
  102.  
  103.     Default is NULL -   Applicability is (S)
  104.  
  105.  
  106.  
  107.     NAME
  108.         SMC_DisplayWidth    --  (ULONG)
  109.  
  110.     FUNCTION
  111.         Set the default width.
  112.  
  113.  
  114.     Default is NULL -   Applicability is (S)
  115.  
  116.  
  117.  
  118.     NAME
  119.         SMC_DisplayHeight   --  (ULONG)
  120.  
  121.     FUNCTION
  122.         Set the default height.
  123.  
  124.     Default is NULL -   Applicability is (S)
  125.  
  126.  
  127.  
  128.     NAME
  129.         SMC_OverscanType    --  (ULONG)
  130.  
  131.     FUNCTION
  132.         Set the default overscan type.
  133.  
  134.     Default is NULL -   Applicability is (S)
  135.  
  136.  
  137.  
  138.     NAME
  139.         SMC_AutoScroll      --  (BOOL)
  140.  
  141.     FUNCTION
  142.         Set or not the autoscroll mode.
  143.  
  144.     Default is NULL -   Applicability is (S)
  145.  
  146.  
  147.  
  148.     NAME
  149.         SMC_ReqLeftEdge     --  (ULONG)
  150.  
  151.     FUNCTION
  152.         For get the left edge position of the requester.
  153.  
  154.     Default is NULL -   Applicability is (G)
  155.  
  156.  
  157.  
  158.     NAME
  159.         SMC_ReqTopEdge      --  (ULONG)
  160.  
  161.     FUNCTION
  162.         For get the top edge position of the requester.
  163.  
  164.     Default is NULL -   Applicability is (G)
  165.  
  166.  
  167.  
  168.     NAME
  169.         SMC_ReqWidth        --  (ULONG)
  170.  
  171.     FUNCTION
  172.         For get the width of the requester.
  173.  
  174.     Default is NULL -   Applicability is (G)
  175.  
  176.  
  177.  
  178.     NAME
  179.         SMC_ReqHeight       --  (ULONG)
  180.  
  181.     FUNCTION
  182.         For get the height of the requester.
  183.  
  184.     Default is NULL -   Applicability is (G)
  185.  
  186.  
  187.  
  188.     NAME
  189.         SMC_InfoLeftEdge    --  (ULONG)
  190.  
  191.     FUNCTION
  192.         For get the left edge position of the information window.
  193.  
  194.     Default is NULL -   Applicability is (G)
  195.  
  196.  
  197.  
  198.     NAME
  199.         SMC_InfoTopEdge     --  (ULONG)
  200.  
  201.     FUNCTION
  202.         For get the top edge position of the information window.
  203.  
  204.     Default is NULL -   Applicability is (G)
  205.  
  206.  
  207.  
  208.     NAME
  209.         SMC_InfoWidth       --  (ULONG)
  210.  
  211.     FUNCTION
  212.         For get the width of the information window.
  213.  
  214.  
  215.     Default is NULL -   Applicability is (G)
  216.  
  217.  
  218.  
  219.     NAME
  220.         SMC_InfoHeight      --  (ULONG)
  221.  
  222.     FUNCTION
  223.         For get the height of the information window.
  224.  
  225.     Default is NULL -   Applicability is (S)
  226.  
  227.  
  228.  
  229.     NAME
  230.         SMC_GUI_MODES       --  (ULONG)
  231.  
  232.     FUNCTION
  233.         Allow to not display lores resolution.
  234.  
  235.     Default is NULL -   Applicability is (IS)
  236.  
  237.  
  238.  
  239.     NAME
  240.         SMC_ControlMinSize      --  (ULONG)
  241.  
  242.     FUNCTION
  243.         Control and correct the min size (width & height) set by the user.
  244.  
  245.         Because when you set  MinWidth  =  640,  it  you  enter  300  without
  246.         validate  by  a  return  and  then  you click on 'OK' => The ASL will
  247.         return you 300 !!!!
  248.  
  249.         This TAG prevent this bug!
  250.  
  251.  
  252.     Default is NULL -   Applicability is (IS)
  253.  
  254.  
  255.  
  256.