home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional Developers Kit 1992 November / Disc01 / Disc01.mdf / cppbeta / ibmcli / iscrlevt.hp_ / ISCRLEVT.HPP
Encoding:
C/C++ Source or Header  |  1992-10-26  |  3.7 KB  |  65 lines
  1. #ifndef _ISCRLEVT_
  2.   #define _ISCRLEVT_
  3. /*******************************************************************************
  4. * FILE NAME: iscrlevt.hpp                                                      *
  5. *                                                                              *
  6. * DESCRIPTION:                                                                 *
  7. *   Declaration of the class(es):                                              *
  8. *     IScrollEvent - Represents a scroll event for an IScrollBar object.       *
  9. *                                                                              *
  10. *                                                                              *
  11. * COPYRIGHT:                                                                   *
  12. *   Licensed Materials - Property of IBM                                       *
  13. *   (C) Copyright IBM Corporation 1992, 1993                                   *
  14. *   All Rights Reserved                                                        *
  15. *   US Government Users Restricted Rights - Use, duplication, or disclosure    *
  16. *   restricted by GSA ADP Schedule Contract with IBM Corp.                     *
  17. *                                                                              *
  18. *$Log:   S:/ibmclass/ibaseapp/vcs/iscrlevt.hpv  $                                                                         *
  19. // 
  20. //    Rev 1.3   26 Oct 1992 00:36:16   tsuji
  21. // Format/document in the style of the standard header file.
  22. *******************************************************************************/
  23. #ifndef _IEVENT_
  24.   #include <ievent.hpp>
  25. #endif
  26.  
  27. // Forward declarations for other classes:
  28. class IScrollEvent;
  29. class IScrollBar;
  30.  
  31. class IScrollEvent : public IEvent {
  32. /*******************************************************************************
  33. * This class represents a scroll event for an IScrollBar object.  This event   *
  34. * update its appearance on the screen.  This event object is created by an     *
  35. * IScrollHandler object and passed to one of its virtual functions for         *
  36. * processing.                                                                  *
  37. *******************************************************************************/
  38. typedef IEvent Inherited;
  39. public:
  40. /*------------------------ CONSTRUCTORS/DESTRUCTORS ----------------------------
  41. | There is 1 way to construct instances of this class:                         |
  42. |   1. construct from an IEvent                                                |
  43. |      This is the constructor used by the IScrollHandler class.               |
  44. ------------------------------------------------------------------------------*/
  45.   IScrollEvent ( IEvent& evt ) : Inherited( evt ) {;}
  46.  
  47. /*--------------------------------- ACCESSORS ----------------------------------
  48. | These functions return information related to the scroll event.              |
  49. |   newSliderPosition - returns the position of the slider (this is only       |
  50. |                       valid for a scroll event passed to the                 |
  51. |                       IScrollHandler::sliderTrack() function)                |
  52. |   sliderMovedBy     - returns the number of units that the scroll has        |
  53. |                       caused the slider to move (a negative value shows a    |
  54. |                       backwards scroll)                                      |
  55. |   scrollBarWindow   - returns a pointer to the IScrollBar object that the    |
  56. |                       scroll event applies to                                |
  57. ------------------------------------------------------------------------------*/
  58. long
  59.   newSliderPosition ( ) const,
  60.   sliderMovedBy     ( ) const;
  61. IScrollBar* const
  62.   scrollBarWindow   ( ) const;
  63. };
  64. #endif /* ISCRLEVT */
  65.