#include <mw/eikscrlb.h>
| class CEikScrollBar : public CEikBorderedControl |
| Public Member Type Definitions | |
|---|---|
| typedef | TEikScrollBarFlags TAknScrollBarFlags |
| Public Attributes | |
|---|---|
| TDblQueLink | iSBLink |
| Protected Attributes | |
|---|---|
| SEikScrollBarButtons | iButtons |
| CEikScrollBarExtensionImpl * | iExtension |
| TOrientation | iOrientation |
| Public Member Enumerations | |
|---|---|
| enum | TEikScrollBarFlags { EEikScrollBarDefaultBehaviour, EEikScrollBarNoNudgeButtons, EEikScrollBarHasPageButtons, EEikScrollBarHasHomeEndButtons, ..., EDisableExpandedTouchArea } |
| enum | TOrientation { EVertical, EHorizontal } |
| enum | TScrollBarExtensionAreaType { ENormalExpandedTouchArea, EScaleExpandedTouchArea, ENoExpandedTouchArea } |
| enum | TScrollBarType { ENormalScrollBar, EArrowHead, EDoubleSpan } |
| Protected Member Enumerations | |
|---|---|
| enum | TPointerDownOn { ENone, EHomeButton, EDecreasePageButton, EDecreaseNudgeButton, ..., EEndButton } |
| enum | TPrivateScrollBarFlags { ENoComponentsToDisplay, EIncreaseButtonsDimmed, EDecreaseButtonsDimmed } |
| enum | TShaftRedrawRequired { ENoRedrawRequired, ERedrawShaft } |
| enum | TWhichButtons { EIncreaseOnly, EDecreaseOnly, EAll } |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C CCoeControl * | ComponentControl(TInt) |
| virtual IMPORT_C TInt | CountComponentControls() |
| void | CreateRequiredComponentsL() |
| void | DestroyButton(CAknScrollButton *&) |
| virtual IMPORT_C void | SetButtonPositionL(CAknScrollButton *) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
The CEikScrollBar class implements a scroll bar. Scroll bars are used when the contents of a view require a greater area than can be physically displayed. Scroll bars allow a user to move different parts of the content into the view and to indicate what proportion of the total contents are visible at any one time.
| CEikScrollBarExtensionImpl * | iExtension | [protected] |
A pointer to CEikScrollBarExtensionImpl class.
Scroll bar initialisation flags. The default is for the scroll bar to have both a shaft and a thumb.
Determines where on a scroll bar a pointer down event occurred.
Flags to determine whether there are visible components and whether to dim the increase, or decrease, buttons.
Type of the scroll bar.
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
Reimplemented from CCoeControl::ComponentControl(TInt)const
From CCoeControl
Gets the specified scrollbar component. Each component control is identified by an index, where the index depends on the order the controls were added: the first is given an index of 0, the next an index of 1.
| Parameter | Description |
|---|---|
| aIndex | The index of the control to get. |
Returns: The component control with an index of aIndex.
| IMPORT_C void | ConstructL | ( | MEikScrollBarObserver * | aScrollBarObserver, |
| const CCoeControl * | aParent, | |||
| TOrientation | aOrientation, | |||
| TInt | aLength, | |||
| TInt | aScrollBarFlags = EEikScrollBarDefaultBehaviour | |||
| ) | [virtual] | |||
Second phase constructor of the scroll bar.
| Parameter | Description |
|---|---|
| aScrollBarObserver | The scroll bar observer which is to be informed of scroll events by this scroll bar. |
| aParent | Parent control for this new scroll bar. |
| aOrientation | Orientation of the new scroll bar. |
| aLength | Not used. |
| aScrollBarFlags | Not used. |
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
Reimplemented from CCoeControl::CountComponentControls()const
From .
Gets the number of controls contained in this scrollbar.
Returns: The number of component controls contained by this scrollbar.
| void | CreateRequiredComponentsL | ( | ) | [protected] |
Allocates and constructs all the required components of the scrollbar.
| CAknScrollButton * | DecreaseNudgeButton | ( | ) | const [inline] |
Gets handle to the controls that draw arrows in the both ends of spanned scrollbar. These arrows are for pen support to enable exact moving of the scrollbar with pen. The arrow is tapped with the pen to move the scrollbar with one step.
Returns: Pointer to the decreace button.
| IMPORT_C TInt | DefaultScrollBarBreadth | ( | ) | [static] |
Gets the default width of the scroll bar.
Returns: Default scroll bar breadth.
| void | DestroyButton | ( | CAknScrollButton *& | aButton | ) | [protected] |
Destroys a button.
| Parameter | Description |
|---|---|
| aButton | A button that will be destroyed. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandlePointerEventL(const TPointerEvent &)
From CCoeControl
Called by the framework to handle pointer events.
| Parameter | Description |
|---|---|
| aPointerEvent | A pointer event. |
| CAknScrollButton * | IncreaseNudgeButton | ( | ) | const [inline] |
Gets handle to the controls that draw arrows in the both ends of spanned scrollbar. These arrows are for pen support to enable exact moving of the scrollbar with pen. The arrow is tapped with the pen to move the scrollbar with one step.
Returns: Pointer to the increace button.
| IMPORT_C void | MakeVisible | ( | TBool | aVisible | ) | [virtual] |
Reimplemented from CCoeControl::MakeVisible(TBool)
From CCoeControl.
Sets this control as visible or invisible.
If MakeVisible() is used to make a component visible, and the control captures the pointer (see CapturesPointer()), MakeVisible() throws away any pending pointer events for that control.
| Parameter | Description |
|---|---|
| aVisible | ETrue to make the control visible, EFalse to make it invisible. |
| const TEikScrollBarModel * | Model | ( | ) | const [inline] |
Gets the scroll bar model used by this scroll bar.
| IMPORT_C TInt | ScrollBarBreadth | ( | ) | const |
Gets the height of a horizontal scrollbar or width of a vertical scrollbar.
Returns: Scroll bar breadth.
| IMPORT_C void | SetAllButtonsDimmed | ( | TBool | aDimmed | ) |
Not implemented.
| Parameter | Description |
|---|---|
| aDimmed | Not used. |
| IMPORT_C void | SetButtonPositionL | ( | CAknScrollButton * | aButton | ) | [protected, virtual] |
Not implemented
| Parameter | Description |
|---|---|
| aButton | Not used. |
| IMPORT_C void | SetContainingCba | ( | CEikCba * | aCba | ) |
Sets command button area. This function should only be used by CEikCba.
| Parameter | Description |
|---|---|
| aCba | Command button area. |
| IMPORT_C void | SetDecreaseButtonsDimmed | ( | TBool | aDimmed | ) |
Not implemented.
| Parameter | Description |
|---|---|
| aDimmed | Not used. |
| IMPORT_C void | SetExtensionAreaType | ( | TScrollBarExtensionAreaType | aType | ) |
Not implemented.
| Parameter | Description |
|---|---|
| aType | The extension area to use. |
| IMPORT_C void | SetFocusPosToThumbPos | ( | TInt | aFocusPosition | ) |
Not implemented.
| Parameter | Description |
|---|---|
| aFocusPosition | Not used. |
| IMPORT_C void | SetIncreaseButtonsDimmed | ( | TBool | aDimmed | ) |
Not implemented.
| Parameter | Description |
|---|---|
| aDimmed | Not used. |
| IMPORT_C void | SetLengthAndModelL | ( | TInt | aLength, |
| const TEikScrollBarModel * | aModel | |||
| ) | ||||
Change the model at once to avoid a double update of the scroll bar.
| Parameter | Description |
|---|---|
| aLength | Not used. |
| aModel | New scroll bar model. |
| IMPORT_C void | SetModel | ( | const TEikScrollBarModel * | aModel | ) |
Change the scrollbar model.
| Parameter | Description |
|---|---|
| aModel | The new model to use. |
| IMPORT_C void | SetModelL | ( | const TEikScrollBarModel * | aModel | ) |
Change the scrollbar model.
| Parameter | Description |
|---|---|
| aModel | The new model to use. |
| IMPORT_C void | SetModelThumbPosition | ( | TInt | aThumbPos | ) |
Not implemented.
| Parameter | Description |
|---|---|
| aThumbPos | Not used. |
| void | SetScrollBarObserver | ( | MEikScrollBarObserver * | aScrollBarObserver | ) |
Allows scroll bar observer to be changed also after the construction. This function is not exported, but the applications can use it via CEikScrollBarFrame::SetScrollBarFrameObserver function.
| Parameter | Description |
|---|---|
| aScrollBarObserver | New observer replacing the previous (if any). |
| IMPORT_C TInt | ThumbPosition | ( | ) | const |
Gets the position within the scroll bar model. This function would normally be called by an MEikScrollBarObserver implementation in response to a scroll bar event.
Returns: Current position within the scroll bar model s range.