Symbian^3 Application Developer Library >

CFsAlfScrollbarLayout Class Reference

class CFsAlfScrollbarLayout : public CAlfLayout

Scrollbar layout. This class creates a layout visual with scrollbars in it. Both horizontal and vertical scrollbars are supported. Scrollbars have three modes: show, hide and auto. When set to show the scrollbar is always visible. Hide setting keeps the scrollbar always hidden. Auto setting determines if the scrollbar is needed or not. Each scrollbar can have different visibility setting. 

        ?good_class_usage_example(s)
?library
Since
S60 ?S60_version *** for example, S60 v3.0

Inherits from

Public Member Functions
~CFsAlfScrollbarLayout ()
IMPORT_C CFsAlfScrollbarLayout * AddNewL ( CAlfControl &, CAlfLayout *)
IMPORT_C TBool IsScrollbarVisible ( TFsScrollbar )
IMPORT_C TAlfRealPoint LayoutSize ()
IMPORT_C TInt RangeEnd ( TFsScrollbar )
IMPORT_C TInt RangeStart ( TFsScrollbar )
IMPORT_C TInt ScrollbarPos ( TFsScrollbar )
IMPORT_C void SetHorizontalScrollbarHeight ( TInt , TInt )
IMPORT_C void SetRange ( TInt , TInt , TFsScrollbar )
IMPORT_C void SetScrollbarImagesL (CAlfImageBrush *, CAlfImageBrush *, TFsScrollbar )
IMPORT_C void SetScrollbarPos (const TInt , TFsScrollbar )
IMPORT_C void SetThumbSpan ( TInt , TFsScrollbar )
IMPORT_C void SetVerticalScrollbarWidth ( TInt , TInt )
IMPORT_C void SetVisibilityMode ( TFsScrollbarVisibility , TFsScrollbar )
IMPORT_C TInt ThumbSpan ( TFsScrollbar )
IMPORT_C void Update ( TInt )
IMPORT_C TFsScrollbarVisibility VisibilityMode ( TFsScrollbar )
Private Member Functions
CFsAlfScrollbarLayout ()
void ConstructL ( CAlfControl &)
void ReleaseCustomImage ( TFsScrollbar )
void SendCommand ( TFsScrollbarCommand , TFsScrollbarSet &)
void SendCommand ( TFsScrollbarCommand , TFsScrollbarSet &, TFsScrollbarSet &)
Inherited Functions
CAlfLayout::Append(CAlfVisual *,TBool,TInt)
CAlfLayout::BaseUnit()const
CAlfLayout::CAlfLayout()
CAlfLayout::ChildOrdinal(TInt)
CAlfLayout::ChildPos(TInt,TPoint &)
CAlfLayout::ChildSize(TInt,TSize &)
CAlfLayout::Count()const
CAlfLayout::DoRemoveAndDestroyAllD()
CAlfLayout::EffectiveLayoutOrdinal(const CAlfVisual &)const
CAlfLayout::EnableScrollingL(TBool)
CAlfLayout::FindTag(const TDesC8 &)
CAlfLayout::FindVisual(CAlfVisual *)const
CAlfLayout::HorizontalInnerPadding()const
CAlfLayout::InnerPadding()const
CAlfLayout::InnerPaddingAsMetric()const
CAlfLayout::InnerPaddingInBaseUnits()const
CAlfLayout::Insert(CAlfVisual *,TInt)
CAlfLayout::MoveVisualToBack(CAlfVisual &,TInt)
CAlfLayout::MoveVisualToFront(CAlfVisual &,TInt)
CAlfLayout::PropertyOwnerExtension(const TUid &,TAny **)
CAlfLayout::Remove(CAlfVisual *,TInt)
CAlfLayout::RemoveAndDestroyAllD()
CAlfLayout::Reorder(CAlfVisual &,TInt,TInt)
CAlfLayout::ScrollOffset()const
CAlfLayout::Scrolling()const
CAlfLayout::SetBaseUnit(const TAlfMetric &)
CAlfLayout::SetBaseUnit(const TAlfXYMetric &)
CAlfLayout::SetInnerPadding(const TAlfXYMetric &)
CAlfLayout::SetInnerPadding(const TPoint &)
CAlfLayout::SetScrollOffset(const TAlfTimedPoint &)
CAlfLayout::SetTransitionTime(TInt)
CAlfLayout::TransitionTime()const
CAlfLayout::UpdateChildrenLayout(TInt)
CAlfLayout::VerticalInnerPadding()const
CAlfLayout::VirtualSize()const
CAlfLayout::Visual(TInt)const
CAlfLayout::~CAlfLayout()
CAlfPropertyOwner::CAlfPropertyOwner()
CAlfPropertyOwner::CopyProperty(const CAlfPropertyOwner &,const TDesC8 &)
CAlfPropertyOwner::PropertyClear()
CAlfPropertyOwner::PropertyFindInteger(const TDesC8 &,TInt *)const
CAlfPropertyOwner::PropertyFindString(const TDesC8 &,TDesC **)const
CAlfPropertyOwner::PropertyRemove(const TDesC8 &)
CAlfPropertyOwner::PropertySetIntegerL(const TDesC8 &,TInt,TInt,TInt)
CAlfPropertyOwner::PropertySetStringL(const TDesC8 &,const TDesC &)
CAlfPropertyOwner::~CAlfPropertyOwner()
CAlfVisual::AlignByOrigin(TAlfRealRect &)const
CAlfVisual::Brushes()
CAlfVisual::CAlfVisual()
CAlfVisual::ClearFlag(TAlfVisualFlags)
CAlfVisual::ClearFlags(TUint)
CAlfVisual::Clipping()const
CAlfVisual::Comms()const
CAlfVisual::ConstructL(CAlfControl &,TInt,TInt,const TDesC8 &)
CAlfVisual::CopyValues(const CAlfVisual &,TInt,TInt)
CAlfVisual::DepthOffset()const
CAlfVisual::Display()const
CAlfVisual::DisplayRect()const
CAlfVisual::DisplayRectTarget()const
CAlfVisual::DisplayToLocal(const TAlfRealPoint &)const
CAlfVisual::DisplayToLocal(const TPoint &)const
CAlfVisual::DropShadowHandler()const
CAlfVisual::EffectiveOpacity()const
CAlfVisual::EnableBrushesL(TBool)
CAlfVisual::EnableDropShadowL(TBool)
CAlfVisual::EnableTransformationL(TBool)
CAlfVisual::Env()const
CAlfVisual::Flags()const
CAlfVisual::HasTactileFeedback(TInt)const
CAlfVisual::HorizontalOrigin()const
CAlfVisual::HorizontalPadding()const
CAlfVisual::Identifier()const
CAlfVisual::IsTagged()const
CAlfVisual::Layout()const
CAlfVisual::LocalToDisplay(const TAlfRealPoint &)const
CAlfVisual::LocalToDisplay(const TPoint &)const
CAlfVisual::MaxSize()const
CAlfVisual::MaxSizeInBaseUnits()const
CAlfVisual::Mimic(CAlfVisual &,TInt)
CAlfVisual::MinSize()const
CAlfVisual::MinSizeInBaseUnits()const
CAlfVisual::Move(const TAlfRealPoint &,TInt)
CAlfVisual::Move(const TPoint &,TInt)
CAlfVisual::MoveToFront(TInt)
CAlfVisual::Opacity()const
CAlfVisual::Owner()const
CAlfVisual::Padding()const
CAlfVisual::PaddingAsMetric()const
CAlfVisual::PaddingInPixels()const
CAlfVisual::Pause(TInt)
CAlfVisual::Pos()const
CAlfVisual::RemoveTactileFeedback(TInt)
CAlfVisual::Resume(TInt)
CAlfVisual::SetCenteredPosAndSize(const TAlfRealPoint &,const TAlfRealSize &,TInt)
CAlfVisual::SetCenteredPosAndSize(const TPoint &,const TSize &,TInt)
CAlfVisual::SetClipping(TBool)
CAlfVisual::SetDepthOffset(const TAlfTimedValue &)
CAlfVisual::SetDisplay(CAlfDisplay *)
CAlfVisual::SetEffectL(const TDesC &)
CAlfVisual::SetFlag(TAlfVisualFlags)
CAlfVisual::SetFlags(TUint)
CAlfVisual::SetGroupEffectL(const TDesC &,TInt)
CAlfVisual::SetLayout(CAlfLayout *)
CAlfVisual::SetMaxSize(const TAlfRealSize &)
CAlfVisual::SetMaxSize(const TSize &)
CAlfVisual::SetMinSize(const TAlfRealSize &)
CAlfVisual::SetMinSize(const TSize &)
CAlfVisual::SetOpacity(const TAlfTimedValue &)
CAlfVisual::SetOrigin(TAlfVisualHOrigin,TAlfVisualVOrigin)
CAlfVisual::SetOwner(CAlfControl &)
CAlfVisual::SetPadding(TInt)
CAlfVisual::SetPadding(const TAlfBoxMetric &)
CAlfVisual::SetPadding(const TPoint &)
CAlfVisual::SetPos(const TAlfRealPoint &,TInt)
CAlfVisual::SetPos(const TAlfTimedPoint &)
CAlfVisual::SetRect(const TAlfRealRect &,TInt)
CAlfVisual::SetSize(const TAlfRealSize &,TInt)
CAlfVisual::SetSize(const TAlfTimedPoint &)
CAlfVisual::SetTactileFeedbackL(TInt,TInt)
CAlfVisual::SetTagL(const TDesC8 &)
CAlfVisual::Size()const
CAlfVisual::Tag()const
CAlfVisual::TagMatches(const TDesC8 &)const
CAlfVisual::Transformation()
CAlfVisual::VerticalOrigin()const
CAlfVisual::VerticalPadding()const
CAlfVisual::~CAlfVisual()
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()
Inherited Enumerations
CAlfLayout:TExpansionFlags
Private Attributes
CAlfImageBrush * iHBarBrush
CAlfVisual * iHScrollbar
CAlfDeckLayout * iHScrollbarLayout
CAlfDeckLayout * iHThumb
CAlfImageBrush * iHThumbBrush
CAlfControl * iOwnerControl
CAlfImageBrush * iVBarBrush
CAlfVisual * iVScrollbar
CAlfDeckLayout * iVScrollbarLayout
CAlfDeckLayout * iVThumb
CAlfImageBrush * iVThumbBrush

Constructor & Destructor Documentation

CFsAlfScrollbarLayout()

CFsAlfScrollbarLayout ( ) [private]

~CFsAlfScrollbarLayout()

~CFsAlfScrollbarLayout ( ) [virtual]

Destructor.

Member Functions Documentation

AddNewL(CAlfControl &, CAlfLayout *)

IMPORT_C CFsAlfScrollbarLayout * AddNewL ( CAlfControl & aOwnerControl,
CAlfLayout * aParentLayout = NULL
) [static]

Construct a new scrollbar layout and give its ownership to a control.

Parameters

CAlfControl & aOwnerControl Owner control.
CAlfLayout * aParentLayout = NULL Parent layout for the new layout.

ConstructL(CAlfControl &)

void ConstructL ( CAlfControl & aOwner ) [private, virtual]

From CAlfVisual . Second-phase constructor.

Parameters

CAlfControl & aOwner

IsScrollbarVisible(TFsScrollbar)

IMPORT_C TBool IsScrollbarVisible ( TFsScrollbar aScrollbar = EFsScrollbarVertical )

Resolve if the specified scrollbar is visible.

Parameters

TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

LayoutSize()

IMPORT_C TAlfRealPoint LayoutSize ( )

Get the target size of the scrolbar layout without the scrollbars.

RangeEnd(TFsScrollbar)

IMPORT_C TInt RangeEnd ( TFsScrollbar aScrollbar = EFsScrollbarVertical )

Get scrollbar's maximum range value.

Parameters

TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

RangeStart(TFsScrollbar)

IMPORT_C TInt RangeStart ( TFsScrollbar aScrollbar = EFsScrollbarVertical )

Get scrollbar's minimum range value.

Parameters

TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

ReleaseCustomImage(TFsScrollbar)

void ReleaseCustomImage ( TFsScrollbar aScrollbar ) [private]

Release custom image reserved memory.

Parameters

TFsScrollbar aScrollbar The scrollbar at issue.

ScrollbarPos(TFsScrollbar)

IMPORT_C TInt ScrollbarPos ( TFsScrollbar aScrollbar = EFsScrollbarVertical )

Resolve the current scrollbar position.

Parameters

TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

SendCommand(TFsScrollbarCommand, TFsScrollbarSet &)

void SendCommand ( TFsScrollbarCommand aCommandId,
TFsScrollbarSet & aInScrollbarSet
) [private]

Send a command to server.

Parameters

TFsScrollbarCommand aCommandId Id of the command to be sent.
TFsScrollbarSet & aInScrollbarSet Data for the used command.

SendCommand(TFsScrollbarCommand, TFsScrollbarSet &, TFsScrollbarSet &)

void SendCommand ( TFsScrollbarCommand aCommandId,
TFsScrollbarSet & aInScrollbarSet,
TFsScrollbarSet & aOutScrollbarSet
) [private]

Send a command to server.

Parameters

TFsScrollbarCommand aCommandId Id of the command to be sent.
TFsScrollbarSet & aInScrollbarSet Placeholder for received data.
TFsScrollbarSet & aOutScrollbarSet

SetHorizontalScrollbarHeight(TInt, TInt)

IMPORT_C void SetHorizontalScrollbarHeight ( TInt aHeight,
TInt aTransitionTime = 0
)

Adjust the horizontal scrollbar's height.

Parameters

TInt aHeight New height.
TInt aTransitionTime = 0 How long the transition should take visually, in milliseconds.

SetRange(TInt, TInt, TFsScrollbar)

IMPORT_C void SetRange ( TInt aStart,
TInt aEnd,
TFsScrollbar aScrollbar = EFsScrollbarVertical
)

Set the range of the scrollbar. Will not actually move the scrollbar until Update() is called.

Parameters

TInt aStart Smallest value the scrollbar position can be set to.
TInt aEnd Largest value the scrollbar position can be set to.
TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

SetScrollbarImagesL(CAlfImageBrush *, CAlfImageBrush *, TFsScrollbar)

IMPORT_C void SetScrollbarImagesL ( CAlfImageBrush * aBarBrush,
CAlfImageBrush * aThumbBrush,
TFsScrollbar aScrollbar
)

Change the bar image to custom image. Ownership of the brushes are changed.

Parameters

CAlfImageBrush * aBarBrush Brush with the new bar image.
CAlfImageBrush * aThumbBrush Brush with the new thumb image.
TFsScrollbar aScrollbar The scrollbar at issue.

SetScrollbarPos(const TInt, TFsScrollbar)

IMPORT_C void SetScrollbarPos ( const TInt aPos,
TFsScrollbar aScrollbar = EFsScrollbarVertical
)

Set the position of the scrollbar. Will not actually move the scrollbar until Update() is called.

Parameters

const TInt aPos Index of the first item visible, i.e. the index of the topmost item in a list box.
TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

SetThumbSpan(TInt, TFsScrollbar)

IMPORT_C void SetThumbSpan ( TInt aThumbSpan,
TFsScrollbar aScrollbar = EFsScrollbarVertical
)

Set the count of the visible unit.

Parameters

TInt aThumbSpan Count of the units that is visible at a time.
TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

SetVerticalScrollbarWidth(TInt, TInt)

IMPORT_C void SetVerticalScrollbarWidth ( TInt aWidth,
TInt aTransitionTime = 0
)

Adjust the vertical scrollbar's width.

Parameters

TInt aWidth New width.
TInt aTransitionTime = 0 How long the transition should take visually, in milliseconds.

SetVisibilityMode(TFsScrollbarVisibility, TFsScrollbar)

IMPORT_C void SetVisibilityMode ( TFsScrollbarVisibility aVisibility,
TFsScrollbar aScrollbar = EFsScrollbarVertical
)

Set the scrollbar visibility.

Parameters

TFsScrollbarVisibility aVisibility New visibility mode for the scrollbar.
TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

ThumbSpan(TFsScrollbar)

IMPORT_C TInt ThumbSpan ( TFsScrollbar aScrollbar = EFsScrollbarVertical )

Resolve the count of the units that is visible at a time.

Parameters

TFsScrollbar aScrollbar = EFsScrollbarVertical The scrollbar at issue.

Update(TInt)

IMPORT_C void Update ( TInt aLayoutTransitionTime = 0 )

Update the visibility of scrollbars.

Parameters

TInt aLayoutTransitionTime = 0 How long the transition should take visually, in milliseconds.

VisibilityMode(TFsScrollbar)

IMPORT_C TFsScrollbarVisibility VisibilityMode ( TFsScrollbar aScrollbar = EFsScrollbarVertical )

Resolve the scrollbar visibility.

Parameters

TFsScrollbar aScrollbar = EFsScrollbarVertical

Member Data Documentation

CAlfImageBrush * iHBarBrush

CAlfImageBrush * iHBarBrush [private]

CAlfVisual * iHScrollbar

CAlfVisual * iHScrollbar [private]

Background image for the horizontal scrollbar. Not own.

CAlfDeckLayout * iHScrollbarLayout

CAlfDeckLayout * iHScrollbarLayout [private]

The layout that contains the entire horizontal scrollbar. Not own.

CAlfDeckLayout * iHThumb

CAlfDeckLayout * iHThumb [private]

Visual for the horizontal scrollbar thumb (part that scrolls around). Not own.

CAlfImageBrush * iHThumbBrush

CAlfImageBrush * iHThumbBrush [private]

CAlfControl * iOwnerControl

CAlfControl * iOwnerControl [private]

?description_of_pointer_member Not own.

CAlfImageBrush * iVBarBrush

CAlfImageBrush * iVBarBrush [private]

CAlfVisual * iVScrollbar

CAlfVisual * iVScrollbar [private]

Background image for the vertical scrollbar. Not own.

CAlfDeckLayout * iVScrollbarLayout

CAlfDeckLayout * iVScrollbarLayout [private]

The layout that contains the entire vertical scrollbar. Not own.

CAlfDeckLayout * iVThumb

CAlfDeckLayout * iVThumb [private]

Visual for the vertical scrollbar thumb (part that scrolls around). Not own.

CAlfImageBrush * iVThumbBrush

CAlfImageBrush * iVThumbBrush [private]

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.