home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / zeryxvs.zip / VSZXPBAR.HLP (.txt) < prev    next >
OS/2 Help File  |  2000-05-26  |  6KB  |  162 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Overview of Progress bar ΓòÉΓòÉΓòÉ
  3.  
  4. This object was developped with help from Ulrich M╨ñller the creator of XFolder 
  5. and XWorkPlace. 
  6.  
  7. The need for a decent progress bar API under OS2 as been unanswered for too 
  8. long, following Ulrich call to do what IBM and others did not do, i created 
  9. this object for Vipro Rexx and C. Now i am using for my software, and i am 
  10. giving this to all who want to improve OS2 by programming for it. 
  11.  
  12. This program is under GPL and no garanties are given use at your risk. for 
  13. information email to: elavoie@zeryx.com or go to http://www.zeryx.com. 
  14.  
  15.  
  16. ΓòÉΓòÉΓòÉ 2. Style page for the Progress bar ΓòÉΓòÉΓòÉ
  17.  
  18. There are several styles available for the Progress bar object. You can set the 
  19. styles using the style page or by using the methods associated with each style. 
  20.  
  21. Basic 
  22.  
  23.  tabStop - Tab stop 
  24.     Allows the user to tab to the Progress bar.  It is a good idea to provide a 
  25.     tab stop for the first Progress bar in a group. 
  26.  
  27.  group - Group 
  28.     Allows the user to move within a group of objects using the arrow keys. 
  29.     Select Group if this Progress bar is the only object in a group or if it is 
  30.     the first object in a group. 
  31.  
  32.  disabled - Disabled 
  33.     The Progress bar is present, but the user cannot select it. 
  34.  
  35.  visible - Visible 
  36.     The user can see the Progress bar. 
  37.  
  38.  Display as percent 
  39.  
  40.  Other Styles 
  41.  
  42.  ZxPercent - PERCENT 
  43.     Set progress bar as a percent display 
  44.  
  45.  ZxNumeric - NUMERIC 
  46.     Set progress bar as a numeric display 
  47.  
  48.  ZxButtonStyle - BUTTONSTYLE 
  49.     Give the progress bar a Button relief style 
  50.  
  51.     ZX_SUNKEN - SUNKEN 
  52.     Give the progress bar a Sunken Button relief style 
  53.  
  54.  
  55. ΓòÉΓòÉΓòÉ 3. Methods for Progress bar ΓòÉΓòÉΓòÉ
  56.  
  57. The Progress bar supports the following methods: 
  58.  
  59.  UPDPROGRESS - Update percent bar 
  60.     Updates the progress with a min and max value 
  61.  
  62.  Enable PERCENT style 
  63.     Turn on the PERCENT style option. 
  64.  
  65.  Is PERCENT style enabled 
  66.     Query if the short style is on. 
  67.  
  68.  Enable NUMERIC style 
  69.     Turn on the NUMERIC style option. 
  70.  
  71.  Is NUMERIC style enabled 
  72.     Query if the short style is on. 
  73.  
  74.  
  75. ΓòÉΓòÉΓòÉ 3.1. Update percent bar ΓòÉΓòÉΓòÉ
  76.  
  77.  Method:          UPDPROGRESS 
  78.  
  79.  Description      Updates the progress with a min and max value 
  80.  
  81.  Syntax:          IZxPBar  UPDPROGRESS() 
  82.  
  83.  Parameters: 
  84.  This function is used to update the progress in the status bar. 
  85.  
  86.  You have to give the current value of the progress and the maximum of the 
  87.  scale (max). If a percent display is selected the value current_pos is divided 
  88.  by the value max and multiplied by 100. If the display is set at numeric then 
  89.  the current_pos value will be displayed, the max value will determine the 
  90.  scale of the progress bar. 
  91.  
  92.  Some validation are made to avoid errors, if max is at 0 then min is set to 0 
  93.  and max to 1. 
  94.  
  95.  Returns: 
  96.  
  97.  IZxPBar          0 Success no other code possible. 
  98.  
  99.  
  100. ΓòÉΓòÉΓòÉ 3.2. Is PERCENT style enabled ΓòÉΓòÉΓòÉ
  101.  
  102.  Method:          isZxPercent 
  103.  
  104.  Description      Query the status of the PERCENT style option. The PERCENT 
  105.                   style Set progress bar as a percent display 
  106.  
  107.  Syntax:          Boolean objectname->IsZxPercent(); 
  108.  
  109.  Parameters:      None 
  110.  
  111.  objectname       The name of the C++ form object. 
  112.  
  113.  Returns: 
  114.  
  115.  Boolean          true if style is set, else false. 
  116.  
  117.  
  118. ΓòÉΓòÉΓòÉ 3.3. Enable PERCENT style ΓòÉΓòÉΓòÉ
  119.  
  120.  Method:          enableZxPercent 
  121.  
  122.  Description      Turn on the PERCENT style option. The PERCENT style Set 
  123.                   progress bar as a percent display 
  124.  
  125.  Syntax:          objectname->enableZxPercent(); 
  126.  
  127.  Parameters:      None 
  128.  
  129.  objectname       The name of the C++ form object. 
  130.  
  131.  
  132. ΓòÉΓòÉΓòÉ 3.4. Is NUMERIC style enabled ΓòÉΓòÉΓòÉ
  133.  
  134.  Method:          isZxNumeric 
  135.  
  136.  Description      Query the status of the NUMERIC style option. The NUMERIC 
  137.                   style Set progress bar as a numeric display 
  138.  
  139.  Syntax:          Boolean objectname->IsZxNumeric(); 
  140.  
  141.  Parameters:      None 
  142.  
  143.  objectname       The name of the C++ form object. 
  144.  
  145.  Returns: 
  146.  
  147.  Boolean          true if style is set, else false. 
  148.  
  149.  
  150. ΓòÉΓòÉΓòÉ 3.5. Enable NUMERIC style ΓòÉΓòÉΓòÉ
  151.  
  152.  Method:          enableZxNumeric 
  153.  
  154.  Description      Turn on the NUMERIC style option. The NUMERIC style Set 
  155.                   progress bar as a numeric display 
  156.  
  157.  Syntax:          objectname->enableZxNumeric(); 
  158.  
  159.  Parameters:      None 
  160.  
  161.  objectname       The name of the C++ form object. 
  162.