OS/2 Professional Developers Kit 1992 November/Disc01/Disc01.mdf/cppbeta/ibmcli/icnrbevt.hp_/ICNRBEVT.HPP

C/C++ Source or Header | 1992-10-26 | 9.5 KB | 199 lines

#ifndef _ICNRBEVT_
   #define _ICNRBEVT_
/*******************************************************************************
* FILE NAME: icnrbevt.hpp                                                      *
*                                                                              *
* DESCRIPTION:                                                                 *
*   Declaration of the class(es):                                              *
*     ICnrEvent                                                                *
*     ICnrEnterEvent                                                           *
*     ICnrHelpEvent                                                            *
*     ICnrQueryDeltaEvent                                                      *
*     ICnrPaintBackground                                                      *
*                                                                              *
* COPYRIGHT:                                                                   *
*   (C) Copyright IBM Corporation 1992                                         *
*   All Rights Reserved                                                        *
*   Licensed Materials * Property of IBM                                       *
*                                                                              *
* HISTORY:                                                                     *
* $Log:   R:/ibmclass/icnr/vcs/icnrbevt.hpv  $
//
//   Rev 1.5   25 Oct 1992 21:58:20   BOBLOVE
//Updated Documentation
//
//   Rev 1.3   25 Oct 1992 11:16:14   BOBLOVE
//External Beta Release
*                                                                              *
*******************************************************************************/



#ifndef  _IEVENT_
   #include <ievent.hpp>
#endif

#ifndef _ICNROBJ_
   #include <icnrobj.hpp>
#endif

//    Forward Declarations
class ICnrEnterEvent;
class ICnrEvent;
class ICnrHelpEvent;
class ICnrQueryDeltaEvent;
class IContainerObject;
class IContainerControl;
class IContainerColumn;



class ICnrEvent : public IEvent
{
/*******************************************************************************
* This class forms the base of the container event classes.                    *
*******************************************************************************/
public:
/*------------------------ CONSTRUCTORS/DESTRUCTORS ----------------------------
| There is only one way to construct instances of this class:                  |
|   1. From the base IEvent class.                                             |
------------------------------------------------------------------------------*/
  ICnrEvent( IEvent& evt);

   protected:
/*----------------------------- IMPLEMENTATION ---------------------------------
| These functions are used to implement the class:                             |
| containerId   - Returns the control identifier for the container.            |
------------------------------------------------------------------------------*/
unsigned long
  containerId() const;

};


class ICnrEnterEvent : public ICnrEvent
{
/*******************************************************************************
*                                                                              *
* This class is dispatched when an "enter" occurs in the container. This       *
* can be as the result of the enter key or a double click of the select key.   *
*                                                                             *
*******************************************************************************/
public:
  ICnrEnterEvent( IEvent& evt);

/*-------------------------------- ACCESSORS -----------------------------------
| These functions provide means of getting and setting the accessible          |
| attributes of instances of this class:                                       |
|                                                                              |
| object         - Returns the object over which the enter occurred or         |
|                  0 if on the container white space.                          |
| enterPressed   - Returns true if the event was the result of the keyboard    |
|                  "Enter" key otherwise it occurred because the select button |
|                  was double clicked.                                         |
| validObject    - Returns true if the event occurs over an object.            |
------------------------------------------------------------------------------*/
IContainerObject
 *object();
Boolean
  enterPressed() const,
  validObject() const;
};

class ICnrEmphasisEvent : public ICnrEvent
{
/*******************************************************************************
* This class is dispatched when emphasis changes in the container on an object *
* in the container.                                                            *
*******************************************************************************/
public:
/*------------------------ CONSTRUCTORS/DESTRUCTORS ----------------------------
| There is only one way to construct instances of this class:                  |
|   1. From the base IEvent class.                                             |
------------------------------------------------------------------------------*/
  ICnrEmphasisEvent( IEvent& evt);

/*-------------------------------- ACCESSORS -----------------------------------
| These functions provide means of getting and setting the accessible          |
| attributes of instances of this class:                                       |
|                                                                              |
| object         - Returns the object that has changed it's emphasis.          |
| changed        - Returns true if the passed emphasis value had changed.      |
------------------------------------------------------------------------------*/
Boolean
  changed( IContainerObject::emphasis) const;
IContainerObject
 *object();
};

class ICnrQueryDeltaEvent : public ICnrEvent
{
/*******************************************************************************
* This class is dispatched when the delta vaule is reached in the container.   *
*******************************************************************************/
public:
/*------------------------ CONSTRUCTORS/DESTRUCTORS ----------------------------
| There is only one way to construct instances of this class:                  |
|   1. From the base IEvent class.                                             |
------------------------------------------------------------------------------*/
  ICnrQueryDeltaEvent(IEvent& evt);

/*-------------------------------- ACCESSORS -----------------------------------
| These functions provide means of getting and setting the accessible          |
| attributes of instances of this class:                                       |
|                                                                              |
| atTopDelta     - Returns true if the object that represents the delta        |
|                  value scrolls into view at the top of the client area.      |
| atBottomDelta  - Returns true if the object that represents the delta        |
|                  value scrolls into view at the bottom of the client area.   |
| atFirstObject  - Returns true if the container has scrolled to the first     |
|                  object in the container.                                    |
| atLastObject   - Returns true if the container has scrolled to the last      |
|                  object in the container.                                    |
------------------------------------------------------------------------------*/
Boolean
  atTopDelta() const,
  atBottomDelta() const,
  atFirstObject() const,
  atLastObject() const;
};

class ICnrHelpEvent : public ICnrEvent
{
/*******************************************************************************
* This class is dispatched when help is requested in the container.            *
*******************************************************************************/
public:

/*------------------------ CONSTRUCTORS/DESTRUCTORS ----------------------------
| There is only one way to construct instances of this class:                  |
|   1. From the base IEvent class.                                             |
------------------------------------------------------------------------------*/
  ICnrHelpEvent(IEvent& chpevt);

/*-------------------------------- ACCESSORS -----------------------------------
| These functions provide means of getting and setting the accessible          |
| attributes of instances of this class:                                       |
|                                                                              |
| object         - Returns the object that has changed it's emphasis.          |
------------------------------------------------------------------------------*/
IContainerObject
 *object() ;
};


/* INLINES */
inline ICnrEvent :: ICnrEvent( IEvent& evt)
               : IEvent(evt) {}
inline ICnrEnterEvent ::  ICnrEnterEvent( IEvent& evt)
               : ICnrEvent(evt)  {}
inline ICnrEmphasisEvent :: ICnrEmphasisEvent( IEvent& evt)
               : ICnrEvent(evt)  {}
inline ICnrQueryDeltaEvent :: ICnrQueryDeltaEvent(IEvent& evt)
               : ICnrEvent(evt) {}
inline ICnrHelpEvent :: ICnrHelpEvent(IEvent& chpevt)
               : ICnrEvent(chpevt) {}


#endif