home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tolkit45.zip / os2tk45 / samples / mm / capsamp / capsamp.ipf < prev    next >
Text File  |  1999-05-11  |  5KB  |  127 lines
  1. :userdoc.
  2. .***********************************************************************
  3. .*General help for the Caption Sample Application Program
  4. .***********************************************************************
  5. :h1 res=001.Help for Caption Sample Application
  6. :i1 id=CAPSAMP.Help for Caption Sample Application
  7. .*
  8. :p.
  9. Welcome to MMPM/2's sample captioning system.  We call it our sample
  10. captioning system because we've provided it, source code and all, as an
  11. example of one way to implement captioning with MMPM/2.  The system can be
  12. used as it's provided, or it can be modified to suit your specific needs.
  13. :p.
  14. This sample captioning system is made up of three parts.  The first part of
  15. the system is the Caption Creation Utility.  This allows you to synchronize
  16. an audio file with a text file.  The second part of the system is the Caption
  17. DLL.  This DLL provides three api's that allow an application to display,
  18. manage, and hide a caption window.  The third part of the system is this
  19. application, the Caption Sample Application.  It shows programmers how to
  20. use the three api's provided by the Caption DLL in order to display a caption
  21. window in an application.
  22. .*
  23. :p.
  24. Select the :hp2.Play:ehp2. push button to start playing the audio file.
  25. If MMPM/2's caption flag is selected (in the Setup applet) then a caption
  26. window will be displayed
  27. in the application's window as the audio file plays.
  28. While the audio file plays,
  29. the text in the caption window will scroll in syncronization
  30. with the audio file.
  31. :p.
  32. Select the :hp2.Stop:ehp2. push button to stop playing an audio file.
  33. If the caption window was displayed while the audio file was playing, then
  34. it will be hidden when the audio file stops.
  35. .*
  36. :p.
  37. Select the :hp2.Pause:ehp2. push button to pause the playing of an audio file.
  38. To resume playing the audio file,
  39. select the :hp2.Pause:ehp2. or :hp2.Play:ehp2. push button.
  40. .*
  41. :p.
  42. Select the :hp2.Rewind:ehp2. push button to stop the audio file and
  43. seek to it's beginning.
  44. .*
  45. :p.
  46. The :hp2.Audio position:ehp2. control provides a graphic display of the
  47. current position of the audio file.  To change position in the audio file,
  48. drag the
  49. slider bar or select the buttons at the left end of the slider.
  50. .*
  51. :p.Adjust the audio volume of the currently loaded audio file by using
  52. the :hp2.Volume:ehp2. control.
  53. .*
  54. :p.
  55. The caption window may be dragged around the application's window.
  56. To accomplish this,
  57. click button one while the mouse is over the caption window, drag the window to
  58. the desired location and release the mouse button.
  59. .*
  60. :p.
  61. Select the :hp2.Options:ehp2. menu to configure the captioning system.
  62. .*
  63. :p.
  64. Select the :hp2.Help:ehp2. menu to access various help functions.
  65. .*
  66. .*************************************************************************
  67. .* Help for the Settings dialog box
  68. .*************************************************************************
  69. :h1 res=002.Help for Settings Dialog Box
  70. :i1 id=DIALOG.Help for Setting Dialog Box
  71. .*
  72. :p.
  73. Select the :hp2.Text columns:ehp2. spin button to change the number of
  74. characters in each line of text in the caption window (ie. the horizontal size
  75. of the caption window).
  76. .*
  77. :p.
  78. Select the :hp2.Text rows:ehp2. spin button to change the number of text rows
  79. displayed in the caption window (ie. the height of the caption window).
  80. .*
  81. :p.
  82. Select the :hp2.Background color:ehp2. spin button to change the
  83. background color of the caption window.
  84. .*
  85. :p.
  86. Select the :hp2.Text color:ehp2. spin button to change the text color in the
  87. caption window.
  88. .*
  89. :p.
  90. Select the :hp2.Window position:ehp2. spin button to change the caption's
  91. window position inside of the application.
  92. .*
  93. :p.
  94. Select the :hp2.OK:ehp2. pushbutton to save the current state of the spin buttons
  95. and to remove this pop-up window.
  96. .*
  97. :p.
  98. Select the :hp2.Cancel:ehp2. pushbutton to to remove this pop-up window without
  99. saving the changes made to the spin buttons.
  100. .*
  101. :p.
  102. Select :hp2.Help:ehp2. pushbutton to display this help panel.
  103. .*
  104. .***********************************************************************
  105. .*Keys help for the Caption Sample Application Program
  106. .***********************************************************************
  107. :h1 res=003.Help for Caption Sample Application Keys
  108. :i1 id=KEYS.Help for Caption Sample Application Keys
  109. .*:i1.keys help
  110. :p.The following keys can be used to control the Caption Sample Application
  111. program&colon.
  112. :dl tsize=5 break=all.
  113. :dt.:hp2.Tab:ehp2.
  114. :dd.Move among choices.
  115. :dt.:hp2.Alt:ehp2.
  116. :dd.Switch to or from the menu of an application window.
  117. :dt.:hp2.Up:ehp2. and :hp2.Down:ehp2. arrow keys
  118. :dd.Move among the push buttons, when focus is on the push button.
  119. :dt.:hp2.Left:ehp2. and :hp2.Right:ehp2. arrow keys
  120. :dd.Move among the push buttons, when focus is on the push button.
  121. When focus is on the volume control use left arrow key to decrease,
  122. right arrow key to increase the volume level.
  123. :dt.:hp2.F1:ehp2.
  124. :dd.Obtain help for the Caption Sample Application program.
  125. :edl.
  126. :euserdoc.
  127.