Class MCoeCaptionRetrieverForFep

class MCoeCaptionRetrieverForFep;

Description

Retrieves a control's caption for use by a FEP.

An example of a caption is the non-editable text description displayed alongside each item in a dialog.

TCoeInputCapabilities::CaptionRetrieverForFep() returns a pointer to an object of this class. A NULL return value indicates that the interface is not supported by any of the currently focused controls. If not NULL, call MCoeCaptionRetrieverForFep::GetCaptionForFep(TDes &)const, which fills the supplied buffer with the control's caption, truncating it if the supplied buffer is too small for the whole caption.

Members

Defined in MCoeCaptionRetrieverForFep:

• GetCaptionForFep(TDes &)constAn implementation of this function should fill aCaption with the target control'...
• MCoeCaptionRetrieverForFep_Reserved_1()
• MCoeCaptionRetrieverForFep_Reserved_2()

virtual void GetCaptionForFep(TDes &aCaption) const=0;

Description

An implementation of this function should fill aCaption with the target control's caption (or as much of the caption as will fit).

For example, code similar to the following might be used (assuming that your caption is stored internally in iCaption):

    const TInt maximumLength=aCaption.MaxLength();
    if (iCaption.Length()>maximumLength)
        aCaption=iCaption.Left(maximumLength);
    else
        aCaption=iCaption;

Parameters

TDes16 &aCaption On return, this should be set to the caption of the target control.

private: IMPORT_C virtual void MCoeCaptionRetrieverForFep_Reserved_1();

Description

private: IMPORT_C virtual void MCoeCaptionRetrieverForFep_Reserved_2();

Description