Symbian^3 Application Developer Library >

Alf::IAlfScrollBarDefaultBaseElement Class Reference

class Alf::IAlfScrollBarDefaultBaseElement : public Alf::IAlfInterfaceBase

An interface for the default base element of the scrollbar.

The default base element is an interface that contains the basic layouting and scrolling logic of the scrollbar widget. The base element provides a simple scrollbar visualization. It allows the user to: 1. Specify the TotalLength ViewLength and ThumbWidth 2. Specify the opacity of thumb with respect to widget opacity

The default base element of the scrollbar uses Anchor Layout

The default base element also acts as an eventhandler and currently listens to following events: 1. EEventModelChanged, EEventScrollBarClicked

default base element handles EEventScrollBarClicked event(Custom Event) which are convetred to higher level events like EEventScrollUp ,EEventScrollDown,EEventScrollLeft,EEventScrollRight , On receiving these events, the default base element accordingly changes the position of the thumb

alfscrollbarwidget.lib

Since
S60 ?S60_version

Inherits from

Public Member Functions
~IAlfScrollBarDefaultBaseElement ()
float getOpacity ()
int getThumbAnimationTime ()
float getThumbOpacity ()
void setOpacity (float)
void setThumbAnimationTime (int)
void setThumbOpacity (float)
const IfId & type ()
Inherited Functions
Alf::IAlfInterfaceBase::makeInterface(IAlfInterfaceBase *)
Alf::IAlfInterfaceBase::makeInterface(const IfId &)
Alf::IAlfInterfaceBase::~IAlfInterfaceBase()

Constructor & Destructor Documentation

~IAlfScrollBarDefaultBaseElement()

~IAlfScrollBarDefaultBaseElement ( ) [inline, virtual]

Destructor.

Member Functions Documentation

getOpacity()

float getOpacity ( ) const [pure virtual]

This function is deprecated. Use attribute APIs to set or get opacity. Gets the Opacity of widget.

getThumbAnimationTime()

int getThumbAnimationTime ( ) const [pure virtual]

Gets the Thumb animation time.

getThumbOpacity()

float getThumbOpacity ( ) const [pure virtual]

Gets the Opacity of thumb.

setOpacity(float)

void setOpacity ( float aOpacity ) [pure virtual]

This function is deprecated. Use attribute APIs to set or get opacity. Sets the Opacity of widget. Default value of scrollbar opacity is 1.0.

Exceptions
AlfException

Parameters

float aOpacity Opacity of the scrollbar. The value should be between 0.0 to 1.0.

setThumbAnimationTime(int)

void setThumbAnimationTime ( int aTime ) [pure virtual]

Sets the animation time for the thumb movement Controls the movement of the thumb in the context of scroll

Parameters

int aTime

setThumbOpacity(float)

void setThumbOpacity ( float aOpacity ) [pure virtual]

Sets the Opacity of thumb. This is relative to widget opacity.Default value is 1.0. The value of aOpacity should be between 0.0 to 1.0

Parameters

float aOpacity Opacity of the thumb

type()

const IfId & type ( ) [static, inline]
Getter for the type identifier of this interface. Usage: 
         IAlfElement* element;
 IAlfBaseElement* baseElement = 
 static_cast<IAlfScrollBarBaseElement*> ( 
 element->makeInterface (IAlfScrollBarBaseElement::type() ) );
IAlfInterfaceBase for IAlfInterfaceBase::makeInterface The above code provides all the interfaces of ScrollBar base element.
Since
S60 ?S60_version

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.