UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]

Location: QikUiConfigDataTypes.h
Link against: quiconfigclient.lib

Class TQikUiConfig

class TQikUiConfig;

Description

This class encapsulates a UI configuration. A UI configuration consists of a screen mode, an orientation, a UI style and a touch screen.

Members

Defined in TQikUiConfig:
Create(), ExternalizeL(), InteractionStyle(), InternalizeL(), Match(), Orientation(), ScreenMode(), SetInteractionStyle(), SetOrientation(), SetScreenMode(), SetTouchScreen(), SetUiConfigMode(), TQikUiConfig(), TQikUiConfig(), TQikUiConfig(), TouchScreen(), UiConfigMode(), operator!=(), operator==()

See also:

Construction and destruction

TQikUiConfig()

IMPORT_C TQikUiConfig();

Description

Default constructor.

TQikUiConfig()

IMPORT_C TQikUiConfig(TInt aConfigMode);

Description

Parameters

TInt aConfigMode

TQikUiConfig()

IMPORT_C TQikUiConfig(TQikScreenMode aScreenMode, TQikOrientation aOrientation, TQikInteractionStyle aUiStyle, TQikTouchScreen aTouchScreen);

Description

Constructor.

Parameters

TQikScreenMode aScreenMode

Screen mode.

TQikOrientation aOrientation

Orientation.

TQikInteractionStyle aUiStyle

UI style.

TQikTouchScreen aTouchScreen

Touch screen.

[Top]

Member functions

Create()

IMPORT_C void Create(TQikScreenMode aScreenMode, TQikOrientation aOrientation, TQikInteractionStyle aUiStyle, TQikTouchScreen aTouchScreen);

Description

Sets all parameters for an existing configuration.

Parameters

TQikScreenMode aScreenMode

Screen mode.

TQikOrientation aOrientation

Orientation.

TQikInteractionStyle aUiStyle

UI style.

TQikTouchScreen aTouchScreen

Touch screen.

InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a TQikUiConfig object from a read stream.

Parameters

RReadStream &aStream

The stream from which the object should be internalised.

ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream);

Description

Externalises a TQikUiConfig object to a write stream.

Parameters

RWriteStream &aStream

The stream to which the object should be externalised.

operator==()

IMPORT_C TBool operator==(const TQikUiConfig &aUiConfig) const;

Description

Compares this instance with another TQikUiConfig object.

Parameters

const TQikUiConfig &aUiConfig

The object to compare to.

Return value

TBool

ETrue if objects are identical, EFalse otherwise.

operator!=()

IMPORT_C TBool operator!=(const TQikUiConfig &aUiConfig) const;

Description

Compares this instance with another TQikUiConfig object.

Parameters

const TQikUiConfig &aUiConfig

The object to compare to.

Return value

TBool

ETrue if objects are not identical, EFalse otherwise.

Match()

static IMPORT_C TBool Match(const TQikUiConfig &aFirst, const TQikUiConfig &aSecond);

Description

Compares two TQikUiConfig objects.

Parameters

const TQikUiConfig &aFirst

First object to compare.

const TQikUiConfig &aSecond

Second object to compare.

Return value

TBool

ETrue if objects identical, EFalse otherwise.

UiConfigMode()

IMPORT_C TInt UiConfigMode() const;

Description

Returns the identifier.

Return value

TInt

The identifier.

See also:

SetUiConfigMode()

IMPORT_C void SetUiConfigMode(TInt aUiConfigMode);

Description

Sets the identifier.

A UI configuration is encoded into a unique identifier the following way:

76543210 76543210 76543210 76543210
                             xxxxxx - Screen Mode 6 bits
                           xx  - Touch Screen 2 bits
                    xxxxxx   - UI Style 6 bits
                  xx   - Orientation 2 bits

The rest of the bits (high word) are reserved for future/licensee extensions.

Parameters

TInt aUiConfigMode

The unique identifier.

ScreenMode()

IMPORT_C TQikScreenMode ScreenMode() const;

Description

Returns the screen mode.

Return value

TQikScreenMode

The screen mode.

SetScreenMode()

IMPORT_C void SetScreenMode(TQikScreenMode aScreenMode);

Description

Sets the screen mode.

Parameters

TQikScreenMode aScreenMode

The screen mode.

Orientation()

IMPORT_C TQikOrientation Orientation() const;

Description

Returns the orientation.

Return value

TQikOrientation

The orientation.

SetOrientation()

IMPORT_C void SetOrientation(TQikOrientation aOrientation);

Description

Sets the orientation.

Parameters

TQikOrientation aOrientation

the orientation.

InteractionStyle()

IMPORT_C TQikInteractionStyle InteractionStyle() const;

Description

Returns the ui style.

Return value

TQikInteractionStyle

The screen mode.

SetInteractionStyle()

IMPORT_C void SetInteractionStyle(TQikInteractionStyle aInteractionStyle);

Description

Sets the ui style.

Parameters

TQikInteractionStyle aInteractionStyle

TouchScreen()

IMPORT_C TQikTouchScreen TouchScreen() const;

Description

Returns the touch screen.

Return value

TQikTouchScreen

The touch screen.

SetTouchScreen()

IMPORT_C void SetTouchScreen(TQikTouchScreen aTouchScreen);

Description

Sets the touch screen.

Parameters

TQikTouchScreen aTouchScreen

the touch screen.

[Previous] [Top] [Next]

Terms and conditions of use of the material