TDisplayConfigurationBase Class Reference

class TDisplayConfigurationBase

Base class for display configuration hierarchy. Defines common facilities for all configurations (size, mask, accessibility).

Constructor & Destructor Documentation

TDisplayConfigurationBase(TInt)

TDisplayConfigurationBase ( TInt aVersion ) [protected, inline]

Constructs a TDisplayConfigurationBase , setting the version to aVersion and all attributes undefined.

Generally used internally in the constructor chain.

Parameters

TInt aVersion The defined size of this object.

TDisplayConfigurationBase()

TDisplayConfigurationBase ( ) [private, inline]

TDisplayConfigurationBase(const TDisplayConfigurationBase &)

TDisplayConfigurationBase ( const TDisplayConfigurationBase & aDisplayConfigurationBase ) [private, inline]

Parameters

const TDisplayConfigurationBase & aDisplayConfigurationBase

Member Functions Documentation

Clear(TAttribute)

void Clear ( TAttribute aAttribute ) [inline]

Marks the given attribute as undefined.

Parameters

TAttribute aAttribute The attribute to set as undefined.

ClearAll()

void ClearAll ( ) [inline]

Marks all attributes as undefined.

IsDefined(TAttribute)

TBool IsDefined ( TAttribute aAttribute ) const [inline]

Check if a particular member is defined.

Parameters

TAttribute aAttribute The attribute to check.

MemberAccessible(const TMember &)

TBool MemberAccessible ( const TMember & aMember ) const [protected, inline]

Internal function for determining whether a given field name is accessible for an object of the current defined size. This must be used before trying to access any field.

Parameters

const TMember & aMember The name of the field to check.

Panic(TInt)

void Panic ( TInt aPanicNo ) [protected, inline]

Parameters

TInt aPanicNo

Version()

TInt Version ( ) const [inline]

Reads the version field.

The version is set automatically in the constructor, or by the GetDisplayConfiguration() method to indicate the sender's supported structure version. The version reported after GetDisplayConfiguration() will match the version of one of the hierarchy of TDisplayConfiguration classes documented in the header, and will never exceed the constructed version.

operator=(const TDisplayConfigurationBase &)

TDisplayConfigurationBase operator= ( const TDisplayConfigurationBase & aRhs ) const [private, inline]

Parameters

const TDisplayConfigurationBase & aRhs

operator==(const TDisplayConfigurationBase &)

TBool operator== ( const TDisplayConfigurationBase & aRhs ) const [protected, inline]

Compares two TDisplayConfigurationBase instances.

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

Parameters

const TDisplayConfigurationBase & aRhs The object to compare with this object

Member Enumerations Documentation

Enum TAttribute

Enumeration of all of the display configuration attributes. Used in combination when calling ClearSettings() and SettingsDefined(). If attributes are added, corresponding enumeration bits must also be added.

Enumerators

EResolution = 0
ERotation
EResolutionTwips
EAttributeMax

Enum TPanics

Enumeration of the panics that may be raised when filling the display configuration These are all contractual input checks and should be avoidable by correctly written callers.

Enumerators

EPanicNegResolution = 1
EPanicSemiZeroResolution
EPanicNonOpaqueBackground
EPanicIllegalRotation
EPanicNegTwips
EPanicSemiZeroTwips
EPanicConfigInvalid

Member Data Documentation

TBitFlags32 iDefined

TBitFlags32 iDefined [protected]

Indicates which fields in the configuration have defined values. If a field contains an undefined value, it must be ignored. See TAttribute for possible bit values.

TInt iVersion

TInt iVersion [protected]

Size to treat this object in bytes. Used to provide backward and forward compatibility.