The IPageHelpEvent class represents a notification
that help has been requested for a notebook page.
A notebook page handler creates and uses an object of this class.
Note:
The AIX release of the Open Class Library does not support this class. You can set up help for individual notebook pages by setting up the help table and IHelpWindow object for each page in exactly the same way as for any other window object.
Constructors & DestructorAlthough you can construct objects of this class, typically IPageHandler::dispatchHandlerEvent constructs objects of this class from an object of the class IEvent, IControlEvent, or IPageEvent. You can also destruct objects of this class.
![]() |
public:
virtual ~IPageHelpEvent()
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
![]() |
public:
IPageHelpEvent(const IControlEvent& controlEvent)
Use this version of the constructor to create a page help event object from a control event object.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
public:
IPageHelpEvent(const IPageEvent& pageEvent)
Use this version of the constructor to create a page help event object from a page event object.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
public:
IPageHelpEvent(const IEvent& event)
Use this version of the constructor to create a page help event object from an event object.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
Help InformationUse these members to obtain help information.
![]() |
public:
IHelpWindow* helpWindow() const
Returns the help window you can use to display help for the notebook page.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
Page InformationUse these members to obtain information about the page that is the target of the help request and the notebook.
![]() |
public:
virtual INotebook* notebook() const
Returns a pointer to the notebook object that the page belongs to.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
![]() |
public:
virtual IPageHandle pageHandle() const
Returns the handle of the notebook page for which help has been requested.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
virtual ~IControlEvent()
virtual unsigned long controlId() const
IControlEvent(const IEvent& event)
IControlEvent(const IControlEvent& event)
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent(const IEvent& event)
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(bool eventResult)
IEvent& setResult(const IEventResult& eventResult)
virtual IWindow* window() const
virtual ~IPageEvent()
IPageEvent(const IControlEvent& controlEvent)
IPageEvent(const IPageEvent& pageEvent)
IPageEvent(const IEvent& event)