CMsgBioControl Class Reference
#include
<app/msgbiocontrol.h>
Link against: MsgEditorUtils.lib
| class CMsgBioControl : public CCoeControl |
| 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::ComponentControl(TInt)const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ConstructFromResourceL(TResourceReader &) |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CountComponentControls()const |
| | 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::OfferKeyEventL(const TKeyEvent &,TEventCode) |
| | 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::SizeChanged() |
| | 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
The base class for Bio controls.
Member Attribute Documentation
iBioControlObserver
Reference to the MMsgBioControlObserver.
iId
Id of the message in the server.
Constructor & Destructor Documentation
CMsgBioControl ( MMsgBioControlObserver &, CMsvSession *, TMsvId, TMsgBioMode, const RFile * )
Constructor. Call this from your Bio Control constructor.
| Parameter | Description | | aObserver | Reference to the Bio control observer. |
| aSession | Message Server session. Ownership not transferred. |
| aId | Id of the message in the server. |
| aEditorOrViewerMode | Sets Bio Control into editor or viewer mode. |
| aFile | Data file handle. Bio controls can also be file based. Not owned. |
~CMsgBioControl ( )
| IMPORT_C | ~CMsgBioControl | ( | ) | |
Member Function Documentation
AddMenuItemL ( CEikMenuPane &, TInt, TInt, TInt )
Adds a menu item to the menu pane which is given as a reference.
| Parameter | Description | | aMenuPane | Reference to the menu pane. |
| aStringRes | The string resource id. |
| aCommandOffset | The offset of the command from the first free command. |
| aPosition | The inserting position. The default is at the top. |
ConfirmationQueryL ( const TDesC & )
| IMPORT_C TBool | ConfirmationQueryL | ( | const TDesC & | aText | ) | [static] |
Pops a confirmation query. The result is given by the return value. The standard resource must have been loaded using LoadStandardBioResourceL().
| Parameter | Description | | aText | The text that is to be used in the query. |
Returns: A user confirmation results in ETrue, and vice versa.
ConfirmationQueryL ( TInt )
| IMPORT_C TBool | ConfirmationQueryL | ( | TInt | aStringResource | ) | [static] |
| Parameter | Description | | aStringResource | The string resource id. |
Returns: A user confirmation results in ETrue, and vice versa.
FileHandle ( )
| IMPORT_C const RFile & | FileHandle | ( | ) | const [protected] |
Deprecated* Handle is valid only at contsruction phase!! To be removed. Returns input file handle.
- Exceptions
| Panics |
if the control is not file based.
|
FileName ( )
| IMPORT_C const TFileName & | FileName | ( | ) | const [protected] |
Deprecated*
Returns name of input file.
- Exceptions
| Panics |
if the control is not file based.
|
IsCursorLocation ( TMsgCursorLocation )
Tells whether the cursor is in the topmost or bottom position. It is used by the scrolling framework.
| Parameter | Description | | aLocation | Specifies either top or bottom. |
Returns: ETrue if the cursor is in the part specified by aLocation.
IsEditor ( )
| IMPORT_C TBool | IsEditor | ( | ) | const [protected] |
Returns true if the control has been launched as editor, and false if it was launched as viewer.
IsFileBased ( )
| IMPORT_C TBool | IsFileBased | ( | ) | const [protected] |
Is the Bio Control file based or not.
Returns: ETrue if is file based.
LoadResourceL ( const TDesC & )
| IMPORT_C void | LoadResourceL | ( | const TDesC & | aFile | ) | [protected] |
Loads a resource file from /system/data/ into eikon env. This function should be used for loading the Bio Control resources. The resources are unloaded in the destructor of this class. The offsets are kept in iResourceOffsets.
| Parameter | Description | | aFile | File name mask, for eg. "vcalbc.r??". |
LoadResourceL ( const TDesC &, const TDesC & )
| IMPORT_C void | LoadResourceL | ( | const TDesC & | aFile, |
| | const TDesC & | aSearchPath |
| | ) | [protected] |
Loads a resource file into eikon env. The resources are unloaded in the destructor of this class. (the offsets are kept in iResourceOffsets).
| Parameter | Description | | aFile | File name mask, for eg. "vcalbc.r??". |
| aSearchPath | Search path, for eg. "\\System\\libs\\". |
LoadStandardBioResourceL ( )
| IMPORT_C void | LoadStandardBioResourceL | ( | ) | [protected] |
This loads the msgeditorutils.rsc resource, which is needed by the dialogs and notes of this class.
MsvSession ( )
Accessor for MsvSession. The session exists only if the Bio Control has been created as message server based.
- Exceptions
| Panics |
if there is no session.
|
NotifyEditorViewL ( TMsgBioControlEventRequest, TInt )
Notify editor view. This is used by the Bio Control for notifying the Editor Base framework of an event, and usually for requesting something to be done.
NotifyViewEvent ( TMsgViewEvent, TInt )
Prepares control for viewing.
- Since
- 3.2
| Parameter | Description | | aEvent | The event type |
| aParam | Event related parameters |
OptionMenuPermissionsL ( )
| IMPORT_C TUint32 | OptionMenuPermissionsL | ( | ) | const |
The application can get the option menu recommendations using this function. The function comes from MMsgBioControl. This is the default implementation which returns the flags EMsgBioCallBack | EMsgBioDelete | EMsgBioMessInfo | EMsgBioMove | EMsgBioCreateCC | EMsgBioSend | EMsgBioAddRecipient | EMsgBioSave | EMsgBioSendingOpt | EMsgBioHelp | EMsgBioExit. Bio Controls should override this if it is not ok.
Returns: The option menu permission flags. If the flag is off it means that the option menu command is not recommended with this Bio Control.
ScrollL ( TInt, TMsgScrollDirection )
Performs the internal scrolling of control if needed. Default implementation does not perform any scrolling and returns that zero pixels were scrolled.
- 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 and view should be moved.
SetExtension ( MMsgBioControlExtension * )
| IMPORT_C void | SetExtension | ( | MMsgBioControlExtension * | aExt | ) | [protected] |
Call from base class if extension interface is supported.
VirtualHeight ( )
| IMPORT_C TInt | VirtualHeight | ( | ) | |
Gives the height of the text in pixels. It is used by the scrolling framework.
Returns: Height of the text in pixels.
VirtualVisibleTop ( )
| IMPORT_C TInt | VirtualVisibleTop | ( | ) | |
Gives the cursor position in pixels. It is used by the scrolling framework.
Returns: Cursor position in pixels.