TEikScrollBarFrameLayout Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None


#include <eiksbfrm.h>

Detailed Description

Enables setting of the frame layout for a scroll bar.

Public Types

enum   TTilingMode { EClientRectConstant, EInclusiveRectConstant }
  Determines whether the client rectangle or the inclusive rectangle remains constant. More...

Public Member Functions

IMPORT_C  TEikScrollBarFrameLayout ()
  C++ default constructor.
IMPORT_C void  SetInclusiveMargin (TInt aMargin)
  Sets all inclusive margins.
IMPORT_C void  SetClientMargin (TInt aMargin)
  Sets all client margins.

Data Fields

TMargins  iInclusiveMargin
  The inclusive margin (in twips or pixels).
TMargins  iClientMargin
  The amount of screen movement performed when the nudge button is pressed.
TSize  iClientAreaGranularity
  The amount of screen movement performed when the nudge button is pressed.
TTilingMode  iTilingMode
  Determines whether the client rectangle, or the inclusive rectangle, remains constant.

Member Enumeration Documentation

enum TEikScrollBarFrameLayout::TTilingMode
 

Determines whether the client rectangle or the inclusive rectangle remains constant.

Enumerator:
EClientRectConstant  The client rectangle remains constant.
EInclusiveRectConstant  The inclusive rectangle remains constant.

Constructor & Destructor Documentation

IMPORT_C TEikScrollBarFrameLayout::TEikScrollBarFrameLayout  ) 
 

C++ default constructor.


Member Function Documentation

IMPORT_C void TEikScrollBarFrameLayout::SetClientMargin TInt  aMargin  ) 
 

Sets all client margins.

These surround the client rectangle which is the client area viewport onto the larger canvas to be scrolled.

Parameters:
aMargin  The value to use for all client margins.
IMPORT_C void TEikScrollBarFrameLayout::SetInclusiveMargin TInt  aMargin  ) 
 

Sets all inclusive margins.

Parameters:
aMargin  The value to use for all inclusive margins.

Field Documentation

TSize TEikScrollBarFrameLayout::iClientAreaGranularity
 

The amount of screen movement performed when the nudge button is pressed.

TMargins TEikScrollBarFrameLayout::iClientMargin
 

The amount of screen movement performed when the nudge button is pressed.

TMargins TEikScrollBarFrameLayout::iInclusiveMargin
 

The inclusive margin (in twips or pixels).

TTilingMode TEikScrollBarFrameLayout::iTilingMode
 

Determines whether the client rectangle, or the inclusive rectangle, remains constant.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top