PBDoc Example using Code Review Template Review Sheet v1.0
Object: uo_cb Size: 2481
Comment: An exmaple of a custom command button v3.0.0 Last Modified: 02/14/2006 21:37
Location: d:\PB\PBDoc\prod\example\pbdoc_example_ansi.pbl<uo_cb.sru>
Author: Review Date: 25/03/2006 14:32:38
Reviewer:   Signed:  
Instance Vars: Included Shared Vars: None External: None
Functions: 2 Controls: 1 Events: 2
Instance Variable Definition Comments 
protected:
Integer      ii_SoundLen
 
Local Function Definition
public integer GetSoundLength () Comments 
/********************************************************************
   GetSoundLength

   <DESC>   Return the current setting of the sound length property.</DESC>

   <RETURN> Current sound length setting</RETURN>

   <ACCESS> Public

   <USAGE>   li_Len = cb_1.GetSoundLength()</USAGE>

********************************************************************/

RETURN ii_SoundLen
 
public SetSoundLength ( integer ai_SoundLen value ) Comments 
/********************************************************************
   SetSoundLength

   <DESC>   Sets the current Sound Length.</DESC>

   <ACCESS> Public

   <ARGS>   ai_SoundLen: Length of the Sound.</ARGS>

   <USAGE>   cb_1.SetSoundLength( 5 )</USAGE>

********************************************************************/

ii_SoundLen = ai_SoundLen
 
Control/Event Definition
uo_cb::Clicked () Comments 
/********************************************************************
   Clicked

   <DESC>   Provides audiable feedback for the user when the button
            is clicked.</DESC>

   <RETURN> If the button was clicked something is returned</RETURN>

   <ACCESS> public

********************************************************************/

Beep( ii_SoundLen )
 
uo_cb::constructor () Comments 
/********************************************************************
   uo_cb: Custom Command Button

   <OBJECT>   This is a custom command button object which inherits
            from the built in PowerBuilder command button. It
            provides audial feedback to the user by making a sound
            whenever the user clicks the button.</OBJECT>

   <DESC>   Set the default length of the sound.</DESC>

   Date      Ref   Author      Comments
   13/02/2006         Ken Howe      First Version
********************************************************************/

ii_SoundLen = 10
 
End of Review Document