CRichBio Class Reference
#include
<app/CRichBio.h>
Link against: richBio.lib
| class CRichBio : public CCoeControl |
Nested Classes and Structures
| Inherited Functions |
|---|
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeControl::AccumulatedZoom()const |
| | CCoeControl::ActivateGc()const |
| | CCoeControl::ActivateL() |
| | CCoeControl::BackedUpWindow()const |
| | CCoeControl::Background()const |
| | CCoeControl::CCoeControl() |
| | CCoeControl::CCoeControl(CCoeEnv *) |
| | CCoeControl::CCoeControl(const CCoeControl &) |
| | CCoeControl::CCoeControlArray |
| | CCoeControl::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ConstructFromResourceL(TResourceReader &) |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode) |
| | CCoeControl::CreateWindowL() |
| | CCoeControl::CreateWindowL(RWindowGroup *) |
| | CCoeControl::CreateWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateWindowL(const CCoeControl *) |
| | CCoeControl::CustomGc()const |
| | CCoeControl::DeactivateGc()const |
| | CCoeControl::DrawBackground(const TRect &)const |
| | CCoeControl::DrawDeferred()const |
| | CCoeControl::DrawForeground(const TRect &)const |
| | CCoeControl::DrawNow()const |
| | CCoeControl::DrawNow(const TRect &)const |
| | CCoeControl::DrawableWindow()const |
| | CCoeControl::EnableDragEvents() |
| | CCoeControl::EnableReportControlStateChange(TBool) |
| | CCoeControl::EnableWindowTransparency() |
| | CCoeControl::FindBackground()const |
| | CCoeControl::FindFontProvider()const |
| | CCoeControl::FocusChanged(TDrawNow) |
| | CCoeControl::GetColor(TInt,TRgb &)const |
| | CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const |
| | CCoeControl::GetGc()const |
| | CCoeControl::GetHelpContext(TCoeHelpContext &)const |
| | CCoeControl::GrabbingComponent()const |
| | CCoeControl::GrabbingComponent(TInt)const |
| | CCoeControl::HandleComponentControlsResourceChange(TInt) |
| | CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt) |
| | CCoeControl::HandlePointerBufferReadyL() |
| | CCoeControl::HandlePointerEventL(const TPointerEvent &) |
| | CCoeControl::HandleRedrawEvent(const TRect &)const |
| | CCoeControl::HandleResourceChange(TInt) |
| | CCoeControl::HasBorder()const |
| | CCoeControl::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | CCoeControl::InputCapabilities()const |
| | CCoeControl::IsActivated()const |
| | CCoeControl::IsBackedUp()const |
| | CCoeControl::IsBeingDestroyed()const |
| | CCoeControl::IsBlank()const |
| | CCoeControl::IsDimmed()const |
| | CCoeControl::IsFocused()const |
| | CCoeControl::IsNonFocusing()const |
| | CCoeControl::IsReadyToDraw()const |
| | CCoeControl::IsVisible()const |
| | CCoeControl::LayoutManager()const |
| | CCoeControl::MakeVisible(TBool) |
| | CCoeControl::MaximumWidth()const |
| | CCoeControl::MinimumSize() |
| | CCoeControl::MopSupplyObject(TTypeUid) |
| | CCoeControl::NotifyFontChange(const CCoeFontProvider *) |
| | CCoeControl::Observer()const |
| | CCoeControl::OverrideColorL(TInt,TRgb) |
| | CCoeControl::OwnsWindow()const |
| | CCoeControl::Parent() |
| | CCoeControl::Parent()const |
| | CCoeControl::Position()const |
| | CCoeControl::PositionChanged() |
| | CCoeControl::PositionRelativeToScreen()const |
| | CCoeControl::PrepareForFocusGainL() |
| | CCoeControl::PrepareForFocusLossL() |
| | CCoeControl::ProcessPointerBufferReadyL() |
| | CCoeControl::ProcessPointerEventL(const TPointerEvent &) |
| | CCoeControl::Rect()const |
| | CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const |
| | CCoeControl::RecursivelyMergedInputCapabilities()const |
| | CCoeControl::RefetchPixelMappingL() |
| | CCoeControl::RemoveFromParent() |
| | CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent) |
| | CCoeControl::RequestRelayout(const CCoeControl *) |
| | CCoeControl::ResetGc()const |
| | CCoeControl::ScreenFont(const TCoeFont &)const |
| | CCoeControl::SetAdjacent(TInt) |
| | CCoeControl::SetAllowStrayPointers() |
| | CCoeControl::SetBackground(const MCoeControlBackground *) |
| | CCoeControl::SetBlank() |
| | CCoeControl::SetCanDrawOutsideRect() |
| | CCoeControl::SetComponentsToInheritVisibility(TBool) |
| | CCoeControl::SetContainerWindowL(RBackedUpWindow &) |
| | CCoeControl::SetContainerWindowL(RWindow &) |
| | CCoeControl::SetContainerWindowL(const CCoeControl &) |
| | CCoeControl::SetControlContext(MCoeControlContext *) |
| | CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &) |
| | CCoeControl::SetCustomGc(CWindowGc *) |
| | CCoeControl::SetDimmed(TBool) |
| | CCoeControl::SetExtent(const TPoint &,const TSize &) |
| | CCoeControl::SetExtentToWholeScreen() |
| | CCoeControl::SetFocus(TBool,TDrawNow) |
| | CCoeControl::SetFocusing(TBool) |
| | CCoeControl::SetFontProviderL(const CCoeFontProvider &) |
| | CCoeControl::SetGc(CWindowGc *)const |
| | CCoeControl::SetGloballyCapturing(TBool) |
| | CCoeControl::SetHitTest(const MCoeControlHitTest *) |
| | CCoeControl::SetLayoutManagerL(MCoeLayoutManager *) |
| | CCoeControl::SetMaximumWidth(TInt) |
| | CCoeControl::SetMopParent(MObjectProvider *) |
| | CCoeControl::SetNeighbor(CCoeControl *) |
| | CCoeControl::SetNonFocusing() |
| | CCoeControl::SetObserver(MCoeControlObserver *) |
| | CCoeControl::SetParent(CCoeControl *) |
| | CCoeControl::SetPointerCapture(TBool) |
| | CCoeControl::SetPosition(const TPoint &) |
| | CCoeControl::SetRect(const TRect &) |
| | CCoeControl::SetSize(const TSize &) |
| | CCoeControl::SetSizeWithoutNotification(const TSize &) |
| | CCoeControl::SetTextBaselineSpacing(TInt) |
| | CCoeControl::SetUniqueHandle(TInt) |
| | CCoeControl::SetZoomFactorL(TInt,TZoomType) |
| | CCoeControl::Size()const |
| | CCoeControl::SystemGc()const |
| | CCoeControl::TextBaselineOffset(const TSize &)const |
| | CCoeControl::TextDrawer(TInt)const |
| | CCoeControl::UniqueHandle()const |
| | CCoeControl::Window()const |
| | CCoeControl::WriteInternalStateL(RWriteStream &)const |
| | CCoeControl::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
Detailed Description
A UI control used by Smart Messaging Viewers. This control owns an editor, which is capable of viewing rich text content. NOTE! This is only intended for use with the Smart Message Viewers.
Constructor & Destructor Documentation
CRichBio ( TRichBioMode )
Constructor. ConstructL must be called after the container window is get. The type (TRichBioMode) is legacy code and has no effect on the construction or use of the object. Either ERichBioModeEditorBase or ERichBioModeStandard can be used with the same effect
| Parameter | Description | | aMode | Either ERichBioModeEditorBase or ERichBioModeStandard |
Member Function Documentation
AddItemL ( const TDesC &, const TDesC & )
| IMPORT_C void | AddItemL | ( | const TDesC & | aLabel, |
| | const TDesC & | aValue |
| | ) | |
Adds a label and value pair. The client does not need to check the length of the strings. This function will wrap strings that are too long.
| Parameter | Description | | aLabel | text to displayed in label text format. |
| aValue | text to displayed in text format. |
ConstructL ( const CCoeControl * )
Second phase constructor. The parent control has to have a container window at this stage.
| Parameter | Description | | aParent | The parent control, which has container window. |
CurrentLineRect ( )
| IMPORT_C TRect | CurrentLineRect | ( | ) | |
This is needed for scrolling with Editor Base.
Returns: TRect Returns the rectangle of the "current" line.
Editor ( )
| IMPORT_C CEikRichTextEditor & | Editor | ( | ) | |
For accessing the richtext editor. Must not be called before ConstructL has been called.
- Exceptions
| Panics |
if the iEditor is NULL.
|
Returns: Reference to the CEikRichTextEditor
IsCursorLocation ( TMsgCursorLocation )
| IMPORT_C TBool | IsCursorLocation | ( | TMsgCursorLocation | aLocation | ) | const |
Find out if the cursor is at a certain position.
| Parameter | Description | | aLocation | indicates either that the cursor is at the topmost position of the control or at the bottom most position. |
Returns: ETrue if the cursor is at the specified position, EFalse otherwise.
IsEditorBaseMode ( )
| IMPORT_C TBool | IsEditorBaseMode | ( | ) | const |
Is the editor base mode on.
Returns: ETrue if it is in Editor Base mode.
NewL ( const CCoeControl *, TRichBioMode )
Two-phased constructor. Constructs the complete object. The parent control has to have a container window at this stage. The type (TRichBioMode) is legacy code and has no effect on the construction or use of the object. Either ERichBioModeEditorBase or ERichBioModeStandard can be used with the same effect
| Parameter | Description | | aParent | The parent control. |
| aMode | Either ERichBioModeEditorBase or ERichBioModeStandard |
Returns: a pointer to the created object.
NotifyViewEvent ( TMsgViewEvent, TInt )
| IMPORT_C void | NotifyViewEvent | ( | TMsgViewEvent | aEvent, |
| | TInt | aParam |
| | ) | |
Prepares control for viewing.
- Since
- 3.2
| Parameter | Description | | aEvent | The event type |
| aParam | Event related parameters |
OfferKeyEventL ( const TKeyEvent &, TEventCode )
Reset ( )
Empties the data contents.
ScrollL ( TInt, TMsgScrollDirection )
| IMPORT_C TInt | ScrollL | ( | TInt | aPixelsToScroll, |
| | TMsgScrollDirection | aDirection |
| | ) | |
Performs the internal scrolling of control if needed.
- Since
- 3.2
| Parameter | Description | | aPixelsToScroll | Amount of pixels to scroll. |
| aDirection | Scrolling direction. |
Returns: Amount of pixels the where scrolled. Zero value means the component cannot be scrolled to that direction anymore
SetAndGetSizeL ( TSize & )
| IMPORT_C void | SetAndGetSizeL | ( | TSize & | aSize | ) | |
Returns the preferred size of the control.
| Parameter | Description | | aSize | Control may set its preferred size |
VirtualHeight ( )
| IMPORT_C TInt | VirtualHeight | ( | ) | |
Returns the rich text virtual length.
Returns: text length in rich text.
VirtualVisibleTop ( )
| IMPORT_C TInt | VirtualVisibleTop | ( | ) | |
Returns the current cursor position. Even in the viewer mode control contains a hidden cursor. This method return its position.
Returns: a position of the hidden cursor relative to the virtual length.