Figure 1: Class diagram of Plugin BIO Control API
Plugin BIO Control API can be used to write a custom control as a plug-in to the Messaging UI. The control can be created with a handle to a session with the Message Server and the id of a particular BIO message to ensure easy access to the message data. A rich text editor is available to display text.
The most important use cases of the Plugin BIO control are the following:
The main class of Plugin BIO Control API is CMsgBioControl and
all BIO controls should derive from this class.
CMsgBioControl implements the mixin class MMsgBioControl that
declares various UI functions. It also has a reference to the observer class, MMsgBioControlObserver,
and through this is able to determine information about menu commands supported
by the control.
CRichBio is a CCoeControl that is only
intended for use within the BIO control plug-in. It is usual for the BIO control
(CMsgBioControl derived class) to create a CRichBio object
to display the message data. The CRichBio control owns a
rich text editor, which is capable of viewing rich text and also has other
UI functionality.
As the BIO control is a plug-in to the messaging UI, it will be created by the framework when an appropriate BIO message is opened by the user. The control is displayed within the container control of the messaging editor.
The mixin class MMsgBioBodyControl is implemented to ensure
correct scrolling of the scroll.
The class diagram for the Plugin BIO control is shown in Figure 1
Figure 1: Class diagram of Plugin BIO Control API
