Class CEikScrollButton

CEikScrollButton

Support

Supported from 6.0

Description

Scroll button.

Derivation

CBase Base class for all classes to be instantiated on the heap CCoeControl Control base class from which all other controls are derived CEikBorderedControl A control which is drawn surrounded by a rectangular border CEikButtonBase This is the base class from which concrete button controls (command buttons, option buttons and checkboxes) are derived CEikScrollButton Scroll button

Defined in CEikScrollButton:
CEikScrollButton(), EBottom, EEnd, EHome, ENudgeDown, ENudgeLeft, ENudgeRight, ENudgeUp, EPageDown, EPageLeft, EPageRight, EPageUp, ETop, GetColorUseListL(), HandleResourceChange(), SetDimmed(), TType, Type(), ~CEikScrollButton()

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), ActivateL(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentControl(), ConstructFromResourceL(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CountComponentControls(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawDeferred(), DrawNow(), DrawableWindow(), EnableDragEvents(), FocusChanged(), GetColor(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandlePointerBufferReadyL(), HandleRedrawEvent(), IgnoreEventsUntilNextPointerUp(), Index(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), MakeVisible(), MinimumSize(), Observer(), OverrideColorL(), OwnsWindow(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), ResetGc(), SetAllowStrayPointers(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindow(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetCornerAndSizeL(), SetExtent(), SetExtentL(), SetExtentToWholeScreen(), SetExtentToWholeScreenL(), SetFocus(), SetFocusing(), SetGloballyCapturing(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetRectL(), SetSize(), SetSizeL(), SetSizeWithoutNotification(), SetSizeWithoutNotificationL(), Size(), SizeChanged(), SizeChangedL(), SystemGc(), Window()

Inherited from CEikBorderedControl:
Border(), Draw(), HasBorder(), SetAdjacent(), SetBorder(), iBorder

Inherited from CEikButtonBase:
Animate(), CopyDrawStateTo(), DrawState(), EClear, EDrawClear, EDrawClearPressed, EDrawIndeterminate, EDrawIndeterminatePressed, EDrawSet, EDrawSetPressed, EEikButtonLatches, EEikButtonReportsOnPointerDown, EEikButtonStaysClear, EEikButtonStaysSet, EIndeterminate, ESet, HandlePointerEventL(), InputCapabilities(), IsPressed(), OfferKeyEventL(), SetAllowTristate(), SetBehavior(), SetBubbleHelpTextL(), SetCoordinator(), SetIgnoreNextPointerUp(), SetReportOnPointerDown(), SetState(), State(), TButtonBehavior, TDrawState, TState, iButFlags

CEikScrollButton(TType aType);

Description

Constructs a scroll button of the specified type. Sets the newly constructed scroll button to stay clear, be non focusing and to report on a pointer down event.

Parameters

TType aType The type of scroll button to create. Available scroll button types are described by the CEikScrollButton::TType enum.

See also:

• CEikScrollButton::TType

~CEikScrollButton();

Description

Destructor.

virtual void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;

Description

Gets the list of logical colours used to draw the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Parameters

CArrayFix<TCoeColorUse>& aColorUseList List of logical colours paired with an explanation of how they are used.

virtual void HandleResourceChange(TInt aType);

Description

Handles a change to the control's resources which are shared across the environment. Colours or fonts for example.

Parameters

TInt aType The type of resource that has changed.

virtual void SetDimmed(TBool aDimmed);

Description

Sets the scroll button's dim state. Dimming usually indicates user input is not accepted.

Parameters

TBool aDimmed ETrue to set the scroll button dimmed. EFalse to set the scroll button as not dimmed.

TType Type() const;

Description

Gets the scroll button's type.

Return value

TType The scroll button's type.

TType

Description

Determines a scroll button's type.

ENudgeLeft Scroll button to move the display to the left. ENudgeUp Scroll button to move the display up. ENudgeRight Scroll button to move the display to the right. ENudgeDown Scroll button to move the display down. EPageLeft Scroll button to move the display one page to the left. EPageUp Scroll button to move the display one page up. EPageRight Scroll button to move the display one page to the right. EPageDown Scroll button to move the display one page down. EHome Scroll button to move the display to the home position. ETop Scroll button to move the display to the top. EEnd Scroll button to move the display to the end position. EBottom Scroll button to move the display to the bottom.