CSVGTCustControl Class Reference
| class CSVGTCustControl : public CCoeControl |
CSVGTCustControl is a CCoeControl used to display SVGT content. It can be used independently or through dialog provided by CSVGTUIDialog.
SVGTUIControl.lib
- Since
- 3.0
| Public Member Functions |
|---|
| ~CSVGTCustControl() |
| IMPORT_C void | AddListener(MSvgCustControlListener *, TCustControlListener) |
| void | AssignImageData(const TDesC &, HBufC8 *) |
| void | ChangeMSKLabelFlag(TInt) |
| void | DoExitFromDialogL() |
|
TInt
| DoHandleLoadingThreadError() |
| void | DoPostLoadFuncL() |
|
TBool
| DocumentEnd() |
|
TBool
| DocumentStart() |
|
TBool
| ElementEnd(const TDesC &) |
|
TBool
| ElementStart(const TDesC &, MSvgAttributeList &) |
|
TBool
| ExternalDataReceived(const TDesC &) |
|
TBool
| ExternalDataRequestFailed(const TDesC &) |
|
TBool
| ExternalDataRequested(const TDesC &) |
|
TInt
| FetchFont(const TDesC &, RFs &, RFile &) |
|
TInt
| FetchImage(const TDesC &, RFs &, RFile &) |
| void | GetCurrentAnimState(TSvgtViewerAnimStatus &) |
| void | GetCurrentFullScreenStatus(TBool &) |
| void | GetCurrentLoopStatus(TBool &) |
| void | GetCurrentZoomLevel(TInt &) |
|
TBool
| GetMSKLabelFlag(TInt) |
| void | GetNormalScreenLayoutRect(TRect &) |
| void | GetSmilFitValue(TDes &) |
| void | GetViewPort(TInt, TInt, TBool, TBool, TInt &, TInt &) |
| void | HandleApplicationForegroundEvent(TBool) |
| void | HandleResourceChange(TInt) |
| void | ImageDataReference(const TDesC &) |
|
TFileType
| ImageFileType(const TDesC &) |
| void | ImagesLoaded(TInt) |
|
TBool
| IsAnimationPresent() |
|
TBool
| IsContentFinite() |
|
TBool
| IsLoopAllowed() |
|
TBool
| IsProcessDone() |
|
TBool
| IsTextContentChanged() |
|
TBool
| IsTextEditOn() |
|
TBool
| IsTextSelectOn() |
|
TBool
| IsThreadRunning() |
|
TBool
| LinkActivated(const TDesC &) |
|
TBool
| LinkActivatedWithShow(const TDesC &, const TDesC &) |
|
TBool
| LinkEntered(const TDesC &) |
|
TBool
| LinkExited(const TDesC &) |
| IMPORT_C CSVGTCustControl * | NewL(RFile &, MSvgtAppObserver *, MSVGTProgressBarDrawImpl *, MSVGTMSKImpl *, MSvgtApplicationExitObserver *, TBool, const CCoeControl *, TInt) |
|
CSVGTCustControl * | NewLC(RFile &, MSvgtAppObserver *, MSVGTProgressBarDrawImpl *, MSVGTMSKImpl *, MSvgtApplicationExitObserver *, TBool, const CCoeControl *, TInt) |
|
TKeyResponse
| OfferKeyEventL(const TKeyEvent &, TEventCode) |
| void | PerformEngineRedraw() |
| void | ProcessViewerCommandL(TInt) |
|
TBool
| ReportAllElements() |
| void | ResetBacklightTime() |
| void | SaveComplete(const TInt) |
|
TInt
| SaveSvgDom(const TDesC &) |
|
TBool
| ScriptCall(const TDesC &, CSvgElementImpl *) |
| void | SetCurrentFullScreenStatus(TBool) |
| void | SetMSKLabelL() |
| void | SetPointerObserver(MCustControlPointerEventHandler *) |
| void | SetThreadRunning(TBool) |
| void | StopEventHandler() |
|
TBool
| UnsupportedElement(const TDesC &, MSvgAttributeList &) |
| void | UpdatePresentation(const TInt32 &) |
| void | UpdateScreen() |
|
TBool
| WillAssignImageData() |
| Private Member Functions |
|---|
| CSVGTCustControl(RFile &, TBool, TInt) |
| void | ConstructL(MSvgtAppObserver *, MSVGTProgressBarDrawImpl *, MSVGTMSKImpl *, MSvgtApplicationExitObserver *, const CCoeControl *) |
| void | DoRotation(const TInt) |
| void | DoTextEditingL(TBool, TInt, TDes &) |
| void | DoTextSelectionL(TDes &) |
| void | FPR2PointArrayL(const MRect *, CArrayFix< TPoint > *&) |
|
TPoint
| FPRCenter(const MRect *) |
|
TBool
| FPRIntersects(const MRect *, const TRect &) |
|
TBool
| IsVoiceCallActive() |
|
TInt
| RemoveInfoNote(TAny *) |
| 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::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::ComponentControl(TInt)const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | 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::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() |
Constructor & Destructor Documentation
CSVGTCustControl(RFile &, TBool, TInt)
| CSVGTCustControl | ( | RFile & | aFileHandle, |
| | TBool | aProgressiveRendering, |
| | TInt | aDisplayFlag = ESvgDisplayWaitNote|ESvgDisplayErrorNotes|ESvgDisplayIcons|ESvgDrawPanIndicator|ESvgDrawPointer|ESvgDrawPauseIndicator|ESvgDrawProgressBar|ESvgUseBackLight |
| | ) | [private] |
Parameters
| RFile & aFileHandle | |
| TBool aProgressiveRendering | |
| TInt aDisplayFlag = ESvgDisplayWaitNote|ESvgDisplayErrorNotes|ESvgDisplayIcons|ESvgDrawPanIndicator|ESvgDrawPointer|ESvgDrawPauseIndicator|ESvgDrawProgressBar|ESvgUseBackLight | |
~CSVGTCustControl()
| ~CSVGTCustControl | ( | ) | [virtual] |
Member Functions Documentation
AddListener(MSvgCustControlListener *, TCustControlListener)
This function is called to add a observer that will want a callback from custcontrol
- Since
- 5.0
AnimationEnded()
|
TBool
| AnimationEnded | ( | ) | [protected] |
AnimationPaused()
|
TBool
| AnimationPaused | ( | ) | [protected] |
AnimationStarted(TBool)
|
TBool
| AnimationStarted | ( | TBool | aIsAnimationIndefinite | ) | [protected] |
Parameters
| TBool aIsAnimationIndefinite | |
AssignImageData(const TDesC &, HBufC8 *)
BlinkPauseIcon(TAny *)
|
TInt
| BlinkPauseIcon | ( | TAny * | aPtr | ) | [protected, static] |
Callback Function for periodic timer for blinking the pause indicator
TCallBack - Since
- 3.0
CalcFindTextBBox()
|
TBool
| CalcFindTextBBox | ( | ) | [protected] |
This function is called to calculate the find text bounding boxes.
- Since
- 3.0
ChangeMSKLabelFlag(TInt)
| void | ChangeMSKLabelFlag | ( | TInt | aButtonId | ) | |
Sets either the iPlayMSKLabel and iContextMenuActivated flag.
- Since
- 3.2
ConstructFromResourceL(TResourceReader &)
From
CCoeControl Constructs the control from resource.
- Since
- 3.0
Parameters
| TResourceReader & aReader | Resource Reader with which to access the control's resource. |
ConstructL(MSvgtAppObserver *, MSVGTProgressBarDrawImpl *, MSVGTMSKImpl *, MSvgtApplicationExitObserver *, const CCoeControl *)
Second Phase constructor.
CountAnimPaused()
| void | CountAnimPaused | ( | ) | [protected] |
Counts the number of animations paused in the SVGT content.
- Since
- 3.0
CountAnimStarted()
| void | CountAnimStarted | ( | ) | [protected] |
Counts the number of animations started in the SVGT content.
- Since
- 3.0
CountAnimStopped()
| void | CountAnimStopped | ( | ) | [protected] |
Counts the number of animations stopped in the SVGT content.
- Since
- 3.0
CreateBitmapsL(const TSize &)
| void | CreateBitmapsL | ( | const TSize & | aBitmapSize | ) | [protected] |
This function is called to create the bitmaps used by the SVG engine for rendering.
- Since
- 3.0
Parameters
| const TSize & aBitmapSize | Size of Bitmap used for Framebuffer |
CreateIconsL()
| void | CreateIconsL | ( | ) | [protected] |
This function is called to create the icons used by the control for panning/pointer display etc.
- Since
- 3.0
DismissWaitNote()
| void | DismissWaitNote | ( | ) | [protected] |
Dismiss wait dialog.
- Since
- 3.0
DisplayInfoNoteL(TInt, TBool)
| void | DisplayInfoNoteL | ( | TInt | aResourceId, |
| | TBool | aIsWaitingDialog |
| | ) | [protected] |
This is a utility function is used for displaying the information notes
- Since
- 3.1
DoBlinkPauseIcon()
| void | DoBlinkPauseIcon | ( | ) | [protected] |
Function which does the actual work of toggling pause indicator
- Since
- 3.0
DoHandleLoadingThreadError()
|
TInt
| DoHandleLoadingThreadError | ( | ) | |
DoPostLoadFuncL()
This is a utility function is used for performing functionality once the engine load is complete
- Since
- 3.1
DoRotation(const TInt)
| void | DoRotation | ( | const TInt | aAngle | ) | [private] |
This function rotates the presentation with given angle about bitmap center.
Parameters
| const TInt aAngle | in Degrees |
DoTextEditingL(TBool, TInt, TDes &)
| void | DoTextEditingL | ( | TBool | aIsTextElement, |
| | TInt | aElemHandle, |
| | TDes & | aText |
| | ) | [private] |
This function displays the existing text in the text/textArea element which is editable and returns the modified text in the same descriptor.
Parameters
| TBool aIsTextElement | Bool indicating whether elem is text/textArea |
| TInt aElemHandle | TInt Handle for the elem from engine |
| TDes & aText | Text content Descriptor modified on return |
DoTextSelectionL(TDes &)
| void | DoTextSelectionL | ( | TDes & | aText | ) | const [private] |
This function displays the existing text in the text/textArea in a read-only dialog so that the user can copy text from it to the system clipboard.
Parameters
| TDes & aText | Text content Descriptor |
DocumentEnd()
|
TBool
| DocumentEnd | ( | ) | [virtual] |
DocumentStart()
|
TBool
| DocumentStart | ( | ) | [virtual] |
Draw(const TRect &)
| void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
From
CCoeControl Draws the SVGT frame on the screen.
- Since
- 3.0
Parameters
| const TRect & aRect | Rectangle which needs to be redrawn. |
DrawFindTextBBox(const TRect &)
| void | DrawFindTextBBox | ( | const TRect & | aRect | ) | const [protected] |
Draws the Bounding box for the current match on the screen.
- Since
- 3.0
DrawPanInd()
| void | DrawPanInd | ( | ) | const [protected] |
Draws the Pan Indicators on the screen.
- Since
- 3.0
DrawPointer()
| void | DrawPointer | ( | ) | const [protected] |
Draws the Pointer on the screen.
- Since
- 3.0
ElementEnd(const TDesC &)
ElementStart(const TDesC &, MSvgAttributeList &)
ExternalDataReceived(const TDesC &)
|
TBool
| ExternalDataReceived | ( | const TDesC & | aUri | ) | [virtual] |
ExternalDataRequestFailed(const TDesC &)
|
TBool
| ExternalDataRequestFailed | ( | const TDesC & | aUri | ) | [virtual] |
ExternalDataRequested(const TDesC &)
|
TBool
| ExternalDataRequested | ( | const TDesC & | aUri | ) | [virtual] |
FPR2PointArrayL(const MRect *, CArrayFix< TPoint > *&)
This function converts a four point rectangle to an array of points
FPRCenter(const MRect *)
|
TPoint
| FPRCenter | ( | const MRect * | aBBoxRect | ) | const [private] |
This function calculates the center of the 4-point rect
Parameters
| const MRect * aBBoxRect | the Four point Rect whose center is to be found |
FPRIntersects(const MRect *, const TRect &)
|
TBool
| FPRIntersects | ( | const MRect * | aBBoxRect, |
| | const TRect & | aRect |
| | ) | const [private] |
This function checks whether the FPR intersects with the rectangle
Parameters
| const MRect * aBBoxRect | the Four point Rect |
| const TRect & aRect | Rectangle with which intersection is to be found |
FetchFont(const TDesC &, RFs &, RFile &)
FetchImage(const TDesC &, RFs &, RFile &)
From
MSvgRequestObserver This method is called by the SVG engine to retrieve the absolute path of the image file.
- Since
- 3.0
Parameters
| const TDesC & aUri | Descriptor containing the relative path of the image. |
| RFs & aSession | |
| RFile & aFileHandle | |
FreeIcons()
| void | FreeIcons | ( | ) | [protected] |
GetCurrentAnimState(TSvgtViewerAnimStatus &)
Get function for current play status.
- Since
- 3.0
GetCurrentFullScreenStatus(TBool &)
| void | GetCurrentFullScreenStatus | ( | TBool & | aIsFullScreenOn | ) | const |
Indicates whether the Control in Full Screen Mode.
- Since
- 3.0
Parameters
| TBool & aIsFullScreenOn | Boolean indicating whether Content is in Full Screen Mode. |
GetCurrentLoopStatus(TBool &)
| void | GetCurrentLoopStatus | ( | TBool & | aIsLoopOn | ) | const |
Indicates whether the Loop feature is enabled for the Control
- Since
- 3.0
Parameters
| TBool & aIsLoopOn | Boolean indicating whether Content is in Loop Mode. |
GetCurrentZoomLevel(TInt &)
| void | GetCurrentZoomLevel | ( | TInt & | aZoomLevel | ) | const |
Get function for current zoom level.
- Since
- 3.0
Parameters
| TInt & aZoomLevel | Integer indicating the number of times the user has zoomed in(Zero indicates original view or no Zoom) |
GetMSKLabelFlag(TInt)
Indicates whether the context menu is opened or not
- Since
- 3.2
GetNormalScreenLayoutRect(TRect &)
| void | GetNormalScreenLayoutRect | ( | TRect & | aRect | ) | const |
Gets the normal screen layout rectangle for control from LAF
- Since
- 3.0
Parameters
| TRect & aRect | TRect indicating the rectangle extent of the control |
GetSmilFitValue(TDes &)
| void | GetSmilFitValue | ( | TDes & | aSmilValue | ) | |
From
MSvgRequestObserver This method is called by the SVG engine to get the SMIL Fit attribute value.
- Since
- 3.0
Parameters
| TDes & aSmilValue | Descriptor containing the SMIL Fit attribute. |
GetViewPort(TInt, TInt, TBool, TBool, TInt &, TInt &)
| void | GetViewPort | ( | TInt | getWidth, |
| | TInt | getHeight, |
| | TBool | isWidthInPercentage, |
| | TBool | isHeightInPercentage, |
| | TInt & | setWidth, |
| | TInt & | setHeight |
| | ) | |
HandleApplicationForegroundEvent(TBool)
| void | HandleApplicationForegroundEvent | ( | TBool | aForeground | ) | |
Function used by the application to handle background/foreground events. When the application goes to background the presentation needs to be paused. When application comes back to foreground, the user would need to start the paused presentation.
- Since
- 3.0
HandleResourceChange(TInt)
| void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
ImageDataReference(const TDesC &)
| void | ImageDataReference | ( | const TDesC & | aUri | ) | [virtual] |
ImageFileType(const TDesC &)
ImagesLoaded(TInt)
| void | ImagesLoaded | ( | TInt | aError | ) | [virtual] |
InitSvgContentL()
| void | InitSvgContentL | ( | ) | [protected] |
This function is used for initialising the SVG engine in case of progressive rendering
- Since
- 3.1
InitializeEngineL()
| void | InitializeEngineL | ( | ) | [protected] |
This function is called to initialize the SVGT-Engine interface.
- Since
- 3.0
InteractiveElementEntered(TPtrC, TUint16)
|
TBool
| InteractiveElementEntered | ( | TPtrC | aElementIdPtr, |
| | TUint16 | aInteractonTypeList |
| | ) | [protected, virtual] |
InteractiveElementExited(TPtrC)
|
TBool
| InteractiveElementExited | ( | TPtrC | aElementIdPtr | ) | [protected, virtual] |
IsAnimFirst()
|
TBool
| IsAnimFirst | ( | ) | const [protected] |
Function indicates whether the animation currently in progress is first one.
- Since
- 3.0
IsAnimLast()
|
TBool
| IsAnimLast | ( | ) | const [protected] |
Function indicates whether the animation currently in progress is first one.
- Since
- 3.0
IsAnimationPresent()
|
TBool
| IsAnimationPresent | ( | ) | const |
Finds whether the content contains animations
- Since
- 3.0
IsContentFinite()
|
TBool
| IsContentFinite | ( | ) | const |
Finds whether the content contains any infinite duration animation
- Since
- 3.0
IsLoopAllowed()
|
TBool
| IsLoopAllowed | ( | ) | const |
Indicates whether the Loop feature is allowed for the Control Note: Loop Feature is allowed only for Non-Interactive content which has finite duration animations.
- Since
- 3.0
IsProcessDone()
|
TBool
| IsProcessDone | ( | ) | const |
Indicates whether the SVG content is loaded
- Since
- 3.0
IsTextContentChanged()
|
TBool
| IsTextContentChanged | ( | ) | const |
Indicates whether the text content has changed since last Save.
- Since
- 3.1
IsTextEditOn()
|
TBool
| IsTextEditOn | ( | ) | const |
Indicates whether the "Edit Text" menu item be displayed
- Since
- 3.1
IsTextSelectOn()
|
TBool
| IsTextSelectOn | ( | ) | const |
Indicates whether the "Select Text" menu item be displayed
- Since
- 3.1
IsThreadRunning()
|
TBool
| IsThreadRunning | ( | ) | const |
IsVoiceCallActive()
|
TBool
| IsVoiceCallActive | ( | ) | [private] |
This function checks whether a voice call is in progress and in connected state.
- Since
- 3.0
LaunchWaitNoteL(TInt)
| void | LaunchWaitNoteL | ( | TInt | aResourceId | ) | [protected] |
Launch wait note.
- Since
- 3.0
Parameters
| TInt aResourceId | Resource id for note text. |
LinkActivated(const TDesC &)
LinkActivatedWithShow(const TDesC &, const TDesC &)
|
TBool
| LinkActivatedWithShow | ( | const TDesC & | aUri, |
| | const TDesC & | aShow |
| | ) | [virtual] |
LinkEntered(const TDesC &)
LinkExited(const TDesC &)
LoadContentL(RFile &)
| void | LoadContentL | ( | RFile & | aFileHandle | ) | [protected] |
This function uses the SVG Engine to load the SVGT content.
- Since
- 3.0
Parameters
| RFile & aFileHandle | file handle to the SVGT content SVGT content. |
LoadSvgContent(TAny *)
|
TInt
| LoadSvgContent | ( | TAny * | aAny | ) | [protected, static] |
This function is used for the loading of SVG content in case of progressive rendering
- Since
- 3.1
NewL(RFile &, MSvgtAppObserver *, MSVGTProgressBarDrawImpl *, MSVGTMSKImpl *, MSvgtApplicationExitObserver *, TBool, const CCoeControl *, TInt)
Two-phased constructor.
- Since
- 3.0
Parameters
| RFile & aFileHandle | RFile that indicates the SVGT content filehandle |
| MSvgtAppObserver * aAppObs | Implementation Class provided by application that uses this control |
| MSVGTProgressBarDrawImpl * aPBDrawImpl | Implementation for rendering progress Indicator |
| MSVGTMSKImpl * aMSKImpl | Implementation for drawing MSK label Note: The ownership of the file handle is not transferred. It is the responsibility of the caller to close this file after deleting this control. |
| MSvgtApplicationExitObserver * aExitObserver = NULL | |
| TBool aProgressiveRendering = EFalse | |
| const CCoeControl * aParent = NULL | |
| TInt aDisplayFlag = ESvgDisplayWaitNote|ESvgDisplayErrorNotes|ESvgDisplayIcons|ESvgDrawPanIndicator|ESvgDrawPointer|ESvgDrawPauseIndicator|ESvgDrawProgressBar|ESvgUseBackLight | |
NewLC(RFile &, MSvgtAppObserver *, MSVGTProgressBarDrawImpl *, MSVGTMSKImpl *, MSvgtApplicationExitObserver *, TBool, const CCoeControl *, TInt)
Two-phased constructor which pushes created object onto Cleanup Stack.
- Since
- 3.0
Parameters
| RFile & aFileHandle | RFile that indicates the SVGT content filehandle |
| MSvgtAppObserver * aAppObs | Implementation Class provided by application that uses this control |
| MSVGTProgressBarDrawImpl * aPBDrawImpl | Implementation for rendering progress Indicator |
| MSVGTMSKImpl * aMSKImpl | Implementation for drawing MSK label Note: The ownership of the file handle is not transferred. It is the responsibility of the caller to close this file after deleting this control. |
| MSvgtApplicationExitObserver * aExitObserver = NULL | |
| TBool aProgressiveRendering = EFalse | |
| const CCoeControl * aParent = NULL | |
| TInt aDisplayFlag = ESvgDisplayWaitNote|ESvgDisplayErrorNotes|ESvgDisplayIcons|ESvgDrawPanIndicator|ESvgDrawPointer|ESvgDrawPauseIndicator|ESvgDrawProgressBar|ESvgUseBackLight | |
OfferKeyEventL(const TKeyEvent &, TEventCode)
From
CCoeControl Key Handling Method for control.
- Since
- 3.0
PanToCurBBox()
| void | PanToCurBBox | ( | ) | [protected] |
This function is called to pan the content in order that the current bounding box is visible. The reference point is taken as the center of the screen.
- Since
- 3.0
PerformEngineRedraw()
| void | PerformEngineRedraw | ( | ) | |
PointerInactivityTimeout()
| void | PointerInactivityTimeout | ( | ) | [protected] |
From
MSVGTPointerInactivityListener. This function updates the display status for the pointer. It is called back by the Pointer Hide Timer after a period of inactivity.
- Since
- 3.0
ProcessFindTextCmdL()
| void | ProcessFindTextCmdL | ( | ) | [protected] |
This function is called to perform the necessary procesing for Find Text.
- Since
- 3.0
ProcessNoTextFoundL()
| void | ProcessNoTextFoundL | ( | ) | [protected] |
This function is called to perform the necessary procesing when text being searched using Find Text command is not found.
- Since
- 3.0
ProcessPauseCmd()
| void | ProcessPauseCmd | ( | ) | [protected] |
This function is called to perform the necessary procesing for the Pause Command.
- Since
- 3.0
ProcessPlayCmd()
| void | ProcessPlayCmd | ( | ) | [protected] |
This function is called to perform the necessary procesing for the Play Command.
- Since
- 3.0
ProcessStopCmd()
| void | ProcessStopCmd | ( | ) | [protected] |
This function is called to perform the necessary procesing for the Stop Command.
- Since
- 3.0
ProcessViewerCommandL(TInt)
| void | ProcessViewerCommandL | ( | TInt | aCommandId | ) | [virtual] |
Process commands for handling SVGT content.
- Since
- 3.0
Parameters
| TInt aCommandId | Integer indicating command that was activated. |
RemoveInfoNote(TAny *)
|
TInt
| RemoveInfoNote | ( | TAny * | aPtr | ) | [private, static] |
Callback Function for timer for removing the note that is not removed in the UI.
TCallBack - Since
- 3.0
ReportAllElements()
|
TBool
| ReportAllElements | ( | ) | [virtual] |
ResetBacklightTime()
Used to reset the backlight time for finite content any cleanup operation can be performed.
- Since
- 3.1
CSVGTCustControl::ResetBacklightTime Resets the backlight time for finite content
SaveComplete(const TInt)
| void | SaveComplete | ( | const TInt | aError | ) | |
Used to notify custom control that save is complete and any cleanup operation can be performed.
- Since
- 3.1
SaveSvgDom(const TDesC &)
This is a utility function for saving the SVG content to a file
- Since
- 3.1
ScriptCall(const TDesC &, CSvgElementImpl *)
|
TBool
| ScriptCall | ( | const TDesC & | aScript, |
| | CSvgElementImpl * | aCallerElement |
| | ) | |
From
MSvgRequestObserver This method is for future extension, in which an external script engine could be used to evaluate a script description.
- Since
- 3.0
Parameters
| const TDesC & aScript | Descriptor containing script |
| CSvgElementImpl * aCallerElement | SVG Element that calls the script by a an event of the "on" attribute. |
SetCurrentFullScreenStatus(TBool)
| void | SetCurrentFullScreenStatus | ( | TBool | aIsFullScreenOn | ) | [virtual] |
Sets the screen mode of the Control State Variable. Note: This does not change the size of the framebuffer - This is done in the
SizeChanged().
- Since
- 3.0
Parameters
| TBool aIsFullScreenOn | Boolean indicating whether Content is in Full Screen Mode. |
SetMSKLabelL()
Sets the MSK Labels under various circumstances.
- Since
- 3.2
SetPointerDisplayStatusAndRedraw(TBool)
| void | SetPointerDisplayStatusAndRedraw | ( | TBool | aIsPointerDisplayed | ) | [protected] |
Function sets the Pointer display status and redraws the whole control inorder to update display status
- Since
- 3.0
Parameters
| TBool aIsPointerDisplayed | |
SetPointerObserver(MCustControlPointerEventHandler *)
SetThreadRunning(TBool)
| void | SetThreadRunning | ( | TBool | aState | ) | |
ShowPauseIcon(TBool)
| void | ShowPauseIcon | ( | TBool | aPauseIconVisible | ) | [protected] |
Function sets the Pause display status and starts the periodic timer to draw the Pause Indicator
- Since
- 3.0
SizeChanged()
| void | SizeChanged | ( | ) | [protected, virtual] |
StartProgIndTimer(TInt)
| void | StartProgIndTimer | ( | TInt | aAfter | ) | [protected] |
Start progress indicator timer.
- Since
- 3.0
Parameters
| TInt aAfter | Time period in microseconds after which the timer ticks. |
StopProgIndTimer()
| void | StopProgIndTimer | ( | ) | [protected] |
Stop the progress indicator timer.
- Since
- 3.0
SwitchScreenModeL()
| void | SwitchScreenModeL | ( | ) | [protected] |
This function is called to change the framebuffer to new size in the SizeChanged function
- Since
- 3.0
TextActivated(TInt)
|
TBool
| TextActivated | ( | TInt | aTextHandle | ) | [protected, virtual] |
TextAreaActivated(TInt)
|
TBool
| TextAreaActivated | ( | TInt | aTextAreaHandle | ) | [protected, virtual] |
From MSvgTextAreaListener. This callback is called to notify the client that a link has been activated.
TextAreaEntered(TInt)
|
TBool
| TextAreaEntered | ( | TInt | aTextAreaHandle | ) | [protected, virtual] |
TextAreaExited(TInt)
|
TBool
| TextAreaExited | ( | TInt | aTextAreaHandle | ) | [protected, virtual] |
From MSvgTextAreaListener. This callback is called to notify when a pointer exits a textbox element.
TextEntered(TInt)
|
TBool
| TextEntered | ( | TInt | aTextHandle | ) | [protected, virtual] |
TextExited(TInt)
|
TBool
| TextExited | ( | TInt | aTextHandle | ) | [protected, virtual] |
UnsupportedElement(const TDesC &, MSvgAttributeList &)
UpdatePointer()
| void | UpdatePointer | ( | ) | [protected] |
This function is called when pointer needs to be redrawn.
- Since
- 3.0
UpdatePresentation(const TInt32 &)
| void | UpdatePresentation | ( | const TInt32 & | aNoOfAnimation | ) | |
From
MSvgRequestObserver This method is called by the SVG engine to update the presentation status.
- Since
- 3.0
Parameters
| const TInt32 & aNoOfAnimation | Integer. When called for the first time it indicates total number of animations. Subsequently it contains number of animations that were completed. |
UpdateProgressBar()
| void | UpdateProgressBar | ( | ) | [protected] |
From
MSVGTProgressBarListener. This function updates the progress bar in the navi pane. It is called back by the progress bar timer.
- Since
- 3.0
WillAssignImageData()
|
TBool
| WillAssignImageData | ( | ) | [virtual] |
Member Enumerations Documentation
Enum TFileType
Enumerators
| ELocalImageFile | |
| ERemoteImageFile | |
| ENotAnImageFile | |
| EInvalidFilePath | |
Member Data Documentation
TSvgtViewerAnimStatus
iAnimState
TSvgtAnimStatus
iAnimationStatus
MSvgtAppObserver * iAppObserver
MSvgAudioMuteListener * iAudioMuteListener
| MSvgAudioMuteListener * | iAudioMuteListener | [private] |
RPointerArray< MRect > iBoundBoxArray
RFile & iContentFileHandle
|
RFile & | iContentFileHandle | [private] |
TBool
iContextMenuActivated
|
TBool
| iContextMenuActivated | [private] |
TInt
iCurSearchMatchId
|
TInt
| iCurSearchMatchId | [private] |
TRect
iCurrentLayout
|
TRect
| iCurrentLayout | [private] |
TInt
iCurrentTextElementId
|
TInt
| iCurrentTextElementId | [private] |
TInt
iDisplayFlags
|
TInt
| iDisplayFlags | [private] |
TBool
iDownKeyOccurred
|
TBool
| iDownKeyOccurred | [private] |
TBool
iEnableTextOps
|
TBool
| iEnableTextOps | [private] |
TBool
iEngineInitialized
|
TBool
| iEngineInitialized | [private] |
CSvgtEventHandlerAO * iEventHandlerAO
MSvgtApplicationExitObserver * iExitObserver
TInt
iFetchImageError
|
TInt
| iFetchImageError | [private] |
TRgb
iFindTextHiColor
|
TRgb
| iFindTextHiColor | [private] |
RArray< TPtrC > iFoundTextArray
TAknLayoutRect
iHandAidRect
TBool
iIgnorePointerKeyEvent
|
TBool
| iIgnorePointerKeyEvent | [private] |
CSVGTPointerHideTimer * iInactivityTimer
CAknInformationNote * iInfoNote
TInt
iInteractiveElementEnteredCnt
|
TInt
| iInteractiveElementEnteredCnt | [private] |
TBool
iIsCurrentTextElement
|
TBool
| iIsCurrentTextElement | [private] |
TBool
iIsForeground
|
TBool
| iIsForeground | [private] |
TBool
iIsFullScreenOn
|
TBool
| iIsFullScreenOn | [private] |
TBool
iIsLoadingDone
|
TBool
| iIsLoadingDone | [private] |
TBool
iIsPointerDisplayed
|
TBool
| iIsPointerDisplayed | [private] |
TBool
iIsSearchStrValid
|
TBool
| iIsSearchStrValid | [private] |
TBool
iIsTextChanged
|
TBool
| iIsTextChanged | [private] |
TBool
iIsTextEditOn
|
TBool
| iIsTextEditOn | [private] |
TBool
iIsTextSelectOn
|
TBool
| iIsTextSelectOn | [private] |
TBool
iIsThreadRunning
|
TBool
| iIsThreadRunning | [private] |
TBool
iIsVolumeMuted
|
TBool
| iIsVolumeMuted | [private] |
TBool
iIsWaitNoteDisplayed
|
TBool
| iIsWaitNoteDisplayed | [private] |
TInt
iKeyRepeatCount
|
TInt
| iKeyRepeatCount | [private] |
TBuf< KFindTextQueryMaxLen > iLastSearchText
MSvgError * iLoadingThreadError
CPeriodic * iNoteRemoverTimer
TInt
iNumAnimInProgress
|
TInt
| iNumAnimInProgress | [private] |
TAknLayoutRect
iPanIndDownAidRect
CGulIcon * iPanIndDownIcon
TAknLayoutRect
iPanIndDownRect
TAknLayoutRect
iPanIndLeftAidRect
CGulIcon * iPanIndLeftIcon
TAknLayoutRect
iPanIndLeftRect
TAknLayoutRect
iPanIndRightAidRect
CGulIcon * iPanIndRightIcon
TAknLayoutRect
iPanIndRightRect
TAknLayoutRect
iPanIndUpAidRect
TAknLayoutRect
iPanIndUpRect
TBool
iPauseIconVisible
|
TBool
| iPauseIconVisible | [private] |
TAknLayoutRect
iPauseRect
TBool
iPlayMSKLabel
|
TBool
| iPlayMSKLabel | [private] |
MCustControlPointerEventHandler * iPntrObserver
TAknLayoutRect
iPointerAidRect
TBool
iPointerDownAnimation
|
TBool
| iPointerDownAnimation | [private] |
TAknLayoutRect
iPointerRect
TSvgtViewerPointerTypes
iPointerType
TBool
iPreviewMode
|
TBool
| iPreviewMode | [private] |
TTime
iPreviousBackLightTimeStamp
|
TTime
| iPreviousBackLightTimeStamp | [private] |
TUint
iProgIndLastTickTime
|
TUint
| iProgIndLastTickTime | [private] |
TUint
iProgIndResidueTime
|
TUint
| iProgIndResidueTime | [private] |
TUint
iProgIndTimeElap
|
TUint
| iProgIndTimeElap | [private] |
MSVGTProgressBarDrawImpl * iProgressBarDrawImpl
CSVGTProgressBarTimer * iProgressBarTimer
TBool
iProgressiveRendering
|
TBool
| iProgressiveRendering | [private] |
CFbsBitmap * iSVGTBitMapMask
CFbsBitmap * iSVGTFrameBufBitMap
CFbsBitGc * iSVGTFrameBufContext
CFbsBitmapDevice * iSVGTFrameBufDevice
TBool
iScrollKey
|
TBool
| iScrollKey | [private] |
TSvgCustomControlSelectCause
iSelectCause
CSVGTDrmHelper * iSvgDrmHelper
CSvgEngineInterfaceImpl * iSvgModule
TAknLayoutRect
iTextAidRect
TBool
iTextAreaEntered
|
TBool
| iTextAreaEntered | [private] |
RArray< TInt > iTextElemIdArray
CSvgtThreadController * iThreadController
TInt32
iTotalNumerOfAnimation
|
TInt32
| iTotalNumerOfAnimation | [private] |
TBool
iViewerCommand
|
TBool
| iViewerCommand | [private] |
TAknLayoutRect
iViewerPaneRect
CAknWaitDialog * iWaitDialog
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.