rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvStSubscription Class Reference

Message class. More...

#include <ivstudio/message.h>

Inherited by IlvStMessageCallback, and IlvStModeChangedSubscription.

List of all members.

Public Member Functions

 IlvStSubscription (IlAny receiver)
 Initializes an instance of IlvStSubscription.
virtual void doIt (IlvStudio *editor, const IlvStMessage *msg, IlAny arg)=0
 Called when the subscribed message is sent.
IlAny getReceiver () const
 Returns the receiver.

Detailed Description

Message class.

Library: ivstudio

An Rogue Wave Views Studio message contains information that describes an event that took place. A message collects subscriptions. A subscription is an action that is performed whenever a message is sent. Message are never created by the user, but are accessed through the editor using their names.
A subscription is a subclass of the IlvStSubscription class.
For example, when a panel wants to react to the ObjectSelected message that is generated each time the object selection changes in the current buffer, its subscribes to this message using a subscription instance. This can be done in the panel constructor by calling the member function subscribe on the message instance. The message instance is given by the editor through its name. Then, whenever the message ObjectSelected is sent, the doIt member function of this subscription is invoked.

See also:
IlvStudio,IlvStCommand.

Constructor & Destructor Documentation

IlvStSubscription::IlvStSubscription ( IlAny  receiver  ) 

Initializes an instance of IlvStSubscription.

Parameters:
receiver The receiver of messages.

Member Function Documentation

virtual void IlvStSubscription::doIt ( IlvStudio editor,
const IlvStMessage msg,
IlAny  arg 
) [pure virtual]

Called when the subscribed message is sent.

Parameters:
editor The Rogue Wave Views Studio editor.
msg The message.
arg Internal use.
IlAny IlvStSubscription::getReceiver (  )  const

Returns the receiver.

Returns:
The receiver.

© Copyright 2012, 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.