Class MAgnModelStateCallBack

MAgnModelStateCallBack

Support

Supported from 5.0

Description

Agenda model state callback.

An object of this class may be specified when the agenda model is constructed. The model's state can be one of ENoFile, EOk or EBlocked (as enumerated in CAgnEntryModel::TState). The state of the model can be found by calling its State() method, however, if a state callback was specified, the model informs the user when it is about to change state via the state callback.

When the user calls a model function whose execution could take some time they recieve a callback via the MAgnModelStateCallBack::StateCallBack() method with aState set to EBlocked. An exception to this is when an empty file is opened (i.e. which contains no entries). In this case, the OpenL() function returns synchronously.

While the model is carrying out the operation, it notifies the user of its progress with a progress callback (see the MAgnProgressCallBack class) and when finished, notifies the user via StateCallBack() with aState set to EOk to indicate it has left the blocked state.

Defined in MAgnModelStateCallBack:
StateCallBack()

virtual void StateCallBack(CAgnEntryModel::TState aState) = 0;

Description

Called with a value of EBlocked when the model is about to enter a blocked state. This is caused by starting a prolonged activity, e.g. opening, merging or tidying, and with EOk when it is about to leave the blocked state.

Parameters

CAgnEntryModel::TState aState The current state of the model.