Collapse all Symbian^3 Product Developer Library

TDisplayConfiguration1 Class Reference

class TDisplayConfiguration1 : public TDisplayConfigurationBase

First collection of display configuration settings.

Inherits from

TDisplayConfiguration1
- TDisplayConfigurationBase

Public Member Functions
	TDisplayConfiguration1()
TBool	GetResolution(TSize &)
TBool	GetResolutionTwips(TSize &)
TBool	GetRotation(TRotation &)
void	SetResolution(const TSize &)
void	SetResolutionTwips(const TSize &)
void	SetRotation(TRotation)

Protected Member Functions
	TDisplayConfiguration1(TInt)
TBool	operator==(const TDisplayConfiguration1 &)

Private Member Functions
	TDisplayConfiguration1(const TDisplayConfiguration1 &)
TDisplayConfiguration1	operator=(const TDisplayConfiguration1 &)

Inherited Functions
	TDisplayConfigurationBase::Clear(TAttribute)
	TDisplayConfigurationBase::ClearAll()
	TDisplayConfigurationBase::IsDefined(TAttribute)const
	TDisplayConfigurationBase::MemberAccessible(const TMember &)const
	TDisplayConfigurationBase::Panic(TInt)
	TDisplayConfigurationBase::TDisplayConfigurationBase(TInt)
	TDisplayConfigurationBase::Version()const
	TDisplayConfigurationBase::operator==(const TDisplayConfigurationBase &)const

Public Member Enumerations
enum	TRotation { ERotationNormal, ERotation90CW, ERotation180, ERotation270CW, ERotationIllegal }

Inherited Enumerations
	TDisplayConfigurationBase:TAttribute
	TDisplayConfigurationBase:TPanics

Private Attributes
TSize	iResolution
TInt	iRotation
TSize	iTwipsSize

Inherited Attributes
	TDisplayConfigurationBase::iDefined
	TDisplayConfigurationBase::iVersion

Constructor & Destructor Documentation

TDisplayConfiguration1()

TDisplayConfiguration1

(

)

[inline]

Construct a TDisplayConfiguration1 version object with all attributes undefined.

This can be used to create a specific version of configuration: TDisplayConfiguration config(TDisplayConfiguration1.Version());

TDisplayConfiguration1(TInt)

TDisplayConfiguration1

(

TInt

aVersion

)

[protected, inline]

Constructor for passing through a version already supplied.

Generally used internally in the constructor chain.

Parameters

TInt aVersion

- Version of the class already calculated and being passed up through the classes.

TDisplayConfiguration1(const TDisplayConfiguration1 &)

TDisplayConfiguration1

(

const TDisplayConfiguration1 &

aDisplayConfiguration1

)

[private, inline]

Parameters

const TDisplayConfiguration1 & aDisplayConfiguration1

Member Functions Documentation

GetResolution(TSize &)

TBool

GetResolution

(

TSize &

aSize

)

const [inline]

Retrieves the resolution, if defined.

If the resolution is undefined, the parameter is left unchanged. A resolution of (0,0) means the display is disabled.

IsDefined TAttribute::EResolution

Parameters

TSize & aSize

Receives the resolution.

GetResolutionTwips(TSize &)

TBool

GetResolutionTwips

(

TSize &

aSize

)

const [inline]

Retrieves the physical size of the display resolution area, in twips, if defined.

For displays that have a fixed size, or can report their size, the physical dimensions corresponding to the current resolution shall be defined. Where the display's physical size cannot be determined (such as with composite video output, or a projector) an arbitrary size shall be defined that reflects the pixel aspect ratio.

If the display is not connected or output is disabled, the physical size shall not be defined. If the physical size is undefined, the parameter is left unchanged.

IsDefined TAttribute::EResolutionTwips

Parameters

TSize & aSize

GetRotation(TRotation &)

TBool

GetRotation

(

TRotation &

)

const [inline]

Retrieves the rotation, if defined.

If the rotation is undefined, the parameter is left unchanged.

IsDefined TAttribute::ERotation

Parameters

TRotation &

SetResolution(const TSize &)

void

SetResolution

(

const TSize &

aSize

)

[inline]

Defines the resolution for the display, in pixels.

This always corresponds to a rotation of ERotationNormal. If a display can be disabled, (0,0) can be used to do so. A display can be disabled if the resolution list includes (0,0).

Parameters

const TSize & aSize

The resolution in pixels.

SetResolutionTwips(const TSize &)

void

SetResolutionTwips

(

const TSize &

aSize

)

[inline]

Defines the physical size of the display resolution area, in twips.

Parameters

const TSize & aSize

SetRotation(TRotation)

void

SetRotation

(

TRotation

)

[inline]

Defines the rotation for the display.

The values that can be passed in here correspond directly to UI rotation values that can be passed in to CWsScreenDevice::SetScreenSizeAndRotation(), CWsScreenDevice::SetCurrentRotations() and so on, although the type is defined locally to avoid undesirable interdependencies in the interface. Variables of the two types may be freely cast to the other type.

CFbsBitGc::TGraphicsOrientation CWsScreenDevice

Parameters

TRotation

operator=(const TDisplayConfiguration1 &)

TDisplayConfiguration1

operator=

(

const TDisplayConfiguration1 &

aRhs

)

const [private, inline]

Parameters

const TDisplayConfiguration1 & aRhs

operator==(const TDisplayConfiguration1 &)

TBool

operator==

(

const TDisplayConfiguration1 &

aRhs

)

const [protected, inline]

Compares two TDisplayConfiguration1 instances.

Generally used internally in the comparison chain. The two objects are equivalent if they have the same version, the same set of attributes defined and all the defined attributes are the same. Undefined attributes are not compared.

Parameters

const TDisplayConfiguration1 & aRhs

The object to compare with this object.

Member Enumerations Documentation

Enum TRotation

Defines possible rotation values.

Enumerators

ERotationNormal	Normal orientation is supported.
ERotation90CW	A 90 degree rotation is supported.
ERotation180	A 180 degree rotation is supported.
ERotation270CW	A 270 degree rotation is supported.
ERotationIllegal	Illegal rotation value.

Member Data Documentation

TSize iResolution

TSize

iResolution

[private]

TInt iRotation

TInt

iRotation

[private]

TSize iTwipsSize

TSize

iTwipsSize

[private]