GLOW API version 1.0 reference

Back to Table of contents

typedef GlowWidgetKeyboardFilter

General information

type: abstract
inherits: TReceiver<GlowWidgetKeyboardData&>
module: glowWidget

GlowWidgetKeyboardFilter is the base class of keyboard event filters for the widget system. Subclasses should override the OnFilter() method to filter events.

GLOW programs that need to filter keyboard events should subclass GlowWidgetKeyboardFilter.

Types

Inherited types
These types are inherited from TReceiver<GlowWidgetKeyboardData&>.

typedef GlowWidgetKeyboardData& MessageType

A synonym for the type of message.

Methods

Inherited methods
These methods are inherited from TReceiver<GlowWidgetKeyboardData&>.

unsigned int NumSenders(void)

unsigned int NumTrackers(void)

Overrideable methods

Receiving messages

virtual bool OnFilter(GlowWidgetKeyboardData& message) = 0

This is a pure virtual method that must be overridden by a subclass. It is called whenever a keyboard event needs to be filtered. You may handle the event in any way, and may also modify the event by modifying the parameters in the passed data structure. Return true if the event needs to continue to be handled normally; otherwise, return false to consume the event.

Inherited methods
These methods are inherited from TReceiver<GlowWidgetKeyboardData&>.

virtual void OnMessage(GlowWidgetKeyboardData& message)

This method is overridden by GlowWidgetKeyboardFilter and should not be overridden again.

Back to Table of contents