Collapse all Symbian^3 Product Developer Library

TSurfaceConfiguration2 Class Reference

class TSurfaceConfiguration2 : public TSurfaceConfiguration1

The second set of surface configuration attributes containing the flip attribute of the surface, along with a SupportsAllMembers function to help identify which attributes are available.

Inherits from

TSurfaceConfiguration2
- TSurfaceConfiguration1
  - TSurfaceConfigurationSize

Public Member Functions
	TSurfaceConfiguration2()
TBool	Flip()
TInt	SetFlip(TBool)
TBool	SupportsAllMembers()

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

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

Inherited Functions
	TSurfaceConfiguration1::GetExtent(TRect &)const
	TSurfaceConfiguration1::GetSurfaceId(TSurfaceId &)const
	TSurfaceConfiguration1::GetViewport(TRect &)const
	TSurfaceConfiguration1::Orientation()const
	TSurfaceConfiguration1::SetExtent(const TRect &)
	TSurfaceConfiguration1::SetOrientation(CFbsBitGc::TGraphicsOrientation)
	TSurfaceConfiguration1::SetSurfaceId(const TSurfaceId &)
	TSurfaceConfiguration1::SetViewport(const TRect &)
	TSurfaceConfiguration1::TSurfaceConfiguration1()
	TSurfaceConfiguration1::TSurfaceConfiguration1(TInt)
	TSurfaceConfiguration1::operator==(const TSurfaceConfiguration1 &)const
	TSurfaceConfigurationSize::MemberAccessible(const Member &)const
	TSurfaceConfigurationSize::Size()const
	TSurfaceConfigurationSize::TSurfaceConfigurationSize(TInt)
	TSurfaceConfigurationSize::operator==(const TSurfaceConfigurationSize &)const

Private Attributes
TBool	iFlip

Inherited Attributes
	TSurfaceConfigurationSize::iSize

Constructor & Destructor Documentation

TSurfaceConfiguration2()

TSurfaceConfiguration2

(

)

[inline]

Default constructor for configuration 2

TSurfaceConfiguration2(TInt)

TSurfaceConfiguration2

(

TInt

aSize

)

[protected, inline]

Constructor for configuration 2 passing through a size already calculated

Parameters

TInt aSize

Size of the class already calculated and being passed up through the classes

TSurfaceConfiguration2(const TSurfaceConfiguration2 &)

TSurfaceConfiguration2

(

const TSurfaceConfiguration2 &

)

[private, inline]

Parameters

const TSurfaceConfiguration2 &

Member Functions Documentation

Flip()

TBool

Flip

(

)

const [inline]

The method gets the flip attribute of the surface stored in the object of this class. If the flip was not set, the value returned will be EFalse.

Post-condition: If the instance of TSurfaceConfiguration is too small, the default EFalse setting will be returned.

SetFlip(TBool)

TInt

SetFlip

(

TBool

aFlip

)

[inline]

This method sets the flip attribute to the surface. The default value is EFalse.

Post-condition: The flip attribute is updated in the object of this class. This does not imply that the flip is set for the surface content. The SetBackgroundSurface API must be called passing an object of this class as parameter to get the desired effect.

Parameters

TBool aFlip

When ETrue enalbes flip in the x-axis

SupportsAllMembers()

TBool

SupportsAllMembers

(

)

[inline]

This method identifies which attributes are available to use.

Generally, any version of the server will accept any version of TSurfaceConfiguration, ignoring newer version attributes it does not recognize and substituting defaults for attributes not present in older version.

However, by using this method in conjunction with GetBackgroundSurface() the intelligent client can identify which blocks of attributes are actually present and supported after a call to GetBackgroundSurface, avoiding preparing complex attributes, or reducing user-interface control gadgets.