Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Types | Public Member Functions
IlvViewHandler Class Reference

Class used to handle events that occurs on an IlvView. More...

#include <ilviews/base/view.h>

Inheritance diagram for IlvViewHandler:
IlvAttachmentsHandler IlvToolTipHandler IlvGraphicHolderToolTipHandler

Public Types

enum  EventType {
  NoEvent, InputEvent, ExposeEvent, ResizeEvent,
  DestroyEvent
}
 This enumeration defines the possible values for the event mask of an IlvViewHandler object. More...
 

Public Member Functions

IlUInt getMask () const
 Returns the event mask of the view handler. More...
 
IlvViewgetView () const
 Returns the view object observed by the view handler. More...
 
virtual void handleDestroy ()
 Is called when the view observed by the view handler is being destroyed. More...
 
virtual void handleExpose (IlvEvent &event)
 Is called when the view observed by the view handler receives an expose event. More...
 
virtual void handleInput (IlvEvent &event)
 Is called when the view observed by the view handler receives an input event. More...
 
virtual void handleResize (const IlvRect &rect)
 Is called when the view observed by the view handler is resized. More...
 
void setMask (IlUInt mask)
 Sets the event mask of the view handler. More...
 
virtual void setView (IlvView *view)
 Sets the view object observed by the view handler. More...
 
virtual void viewDeleted ()
 Is called when the view observed by the view handler is deleted. More...
 

Detailed Description

Class used to handle events that occurs on an IlvView.

Library: views
IlvViewHandler is a class that handles event that occurs in an IlvView object. It defines several notification member function that are called when specific events occurs in the view, provided that the view handler event mask has been set correctly. The view handler event mask specifies what kind of event the view handler will track.

See also
IlvView.

Member Enumeration Documentation

§ EventType

This enumeration defines the possible values for the event mask of an IlvViewHandler object.

See also
IlvViewHandler::setMask().
Enumerator
NoEvent 

No events are sent to the view handler.

InputEvent 

Input events are sent to the view handler

ExposeEvent 

Expose events are sent to the view handler

ResizeEvent 

Resize events are sent to the view handler.

DestroyEvent 

Destroy events are sent to the view handler.

Member Function Documentation

§ getMask()

IlUInt IlvViewHandler::getMask ( ) const

Returns the event mask of the view handler.

The event mask can be a combination of the symbols of the enumeration EventType.

Returns
The event mask of the view handler.
See also
setMask().

§ getView()

IlvView* IlvViewHandler::getView ( ) const

Returns the view object observed by the view handler.

Returns
The view object observed by the view handler.
See also
setView()

§ handleDestroy()

virtual void IlvViewHandler::handleDestroy ( )
virtual

Is called when the view observed by the view handler is being destroyed.

The default implementation does nothing.

§ handleExpose()

virtual void IlvViewHandler::handleExpose ( IlvEvent event)
virtual

Is called when the view observed by the view handler receives an expose event.

The default implementation does nothing.

Parameters
eventThe event containing the expose information.
See also
IlvEvent.

§ handleInput()

virtual void IlvViewHandler::handleInput ( IlvEvent event)
virtual

Is called when the view observed by the view handler receives an input event.

The default implementation does nothing.

Parameters
eventThe input event.
See also
IlvEvent.

Reimplemented in IlvToolTipHandler.

§ handleResize()

virtual void IlvViewHandler::handleResize ( const IlvRect rect)
virtual

Is called when the view observed by the view handler is resized.

The default implementation does nothing.

Parameters
rectThe new size of the view.

Reimplemented in IlvAttachmentsHandler.

§ setMask()

void IlvViewHandler::setMask ( IlUInt  mask)

Sets the event mask of the view handler.

The event mask can be a combination of the symbols of the enumeration EventType.

Parameters
maskThe new event mask of the view handler.
See also
getMask(), handleResize(), handleInput(), handleDestroy(), handleExpose().

§ setView()

virtual void IlvViewHandler::setView ( IlvView view)
virtual

Sets the view object observed by the view handler.

Parameters
viewThe new view object observed by the view handler.
See also
setView()

Reimplemented in IlvToolTipHandler, and IlvAttachmentsHandler.

§ viewDeleted()

virtual void IlvViewHandler::viewDeleted ( )
virtual

Is called when the view observed by the view handler is deleted.

The default implementation does nothing.

Reimplemented in IlvToolTipHandler.


© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.