Collapse all Symbian^3 Application Developer Library

CCoeControlStaticSettings Class Reference

class CCoeControlStaticSettings : public CCoeStatic

Holds global settings for all CCoeControls.

This class is not designed for general use. It is intended to be used to override certain settings on a system-wide basis at startup. At present, the only settings it contains are 1. To set whether or not CCoeControls take focus on creation. By default, a CCoeControl does take focus - this class can be used to change that. To use it, CCoeControlStaticSettings::SetFocusedByDefaultL() should be called from a "start-up" DLL to set the default once. Changing the default on the fly will almost certainly cause instability. 2. To set whether the CC This class should only be used by developers of User Interfaces for Symbian OS phones.

Inherits from

CCoeControlStaticSettings
- CCoeStatic
  - CBase

Public Member Functions
IMPORT_C TBool	FocusedByDefault ()
IMPORT_C TBool	FocusedByDefault ( CCoeEnv *)
IMPORT_C void	GetLogicalToPixelFontSizesL ( RArray < TInt > &)
IMPORT_C TBool	OrdinalForAllViews ()
IMPORT_C TBool	ParentByDefault ()
IMPORT_C void	SetFocusedByDefaultL ( TBool )
IMPORT_C void	SetLogicalToPixelFontSizesL (const RArray < TInt > &)
IMPORT_C void	SetOrdinalForAllViewsL ( TBool )
IMPORT_C void	SetParentByDefaultL ( TBool )
IMPORT_C void	SetSystemTypefaceL (const TDesC &)
IMPORT_C const TDesC &	SystemTypeface ()

Private Member Functions
	CCoeControlStaticSettings ()
	~CCoeControlStaticSettings ()
void	ConstructL ()
CCoeControlStaticSettings *	NewL ()
CCoeControlStaticSettings *	Self ( CCoeEnv *)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CCoeStatic::CCoeStatic()
	CCoeStatic::CCoeStatic(TUid,TInt,TScope)
	CCoeStatic::CCoeStatic(TUid,TScope)
	CCoeStatic::~CCoeStatic()

Inherited Enumerations
	CCoeStatic:@77
	CCoeStatic:TScope

Private Attributes
TBool	iFocusedByDefault
RArray < TInt >	iLogicalToPixelSizes
TBool	iOrdinalForAllViews
TTypeface	iTypeface

Constructor & Destructor Documentation

CCoeControlStaticSettings()

CCoeControlStaticSettings

(

)

[private]

Constructor

~CCoeControlStaticSettings()

~CCoeControlStaticSettings

(

)

[private]

Class Destructor

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

Second stage construction of CCoeControlStaticSettings class

FocusedByDefault()

IMPORT_C TBool

FocusedByDefault

(

)

[static]

Retrieves the global setting that determines whether CCoeControls take focus when created.

If the CCoeControlStaticSettings object does not exist, then the default is to return true, which gives unchanged behaviour from pre-v9.0 releases.

FocusedByDefault(CCoeEnv *)

IMPORT_C TBool

FocusedByDefault

(

CCoeEnv *

aCoeEnv

)

[static]

Retrieves the global setting that determines whether CCoeControls take focus when created.

If the CCoeControlStaticSettings object does not exist, then the default is to return true, which gives unchanged behaviour from pre-v9.0 releases.

Parameters

CCoeEnv * aCoeEnv

The Control environment.

GetLogicalToPixelFontSizesL(RArray< TInt > &)

IMPORT_C void

GetLogicalToPixelFontSizesL

(

RArray < TInt > &

aLogicalToPixelSizes

)

[static]

Populates the TInt array provided as a parameter with the font pixel sizes.

Parameters

RArray < TInt > & aLogicalToPixelSizes

TInt array to be poulated with font sizes

NewL()

CCoeControlStaticSettings *

NewL

(

)

[private, static]

Creates new instance of CCoeControlStaticSettings class

OrdinalForAllViews()

IMPORT_C TBool

OrdinalForAllViews

(

)

[static]

Retrieves the global setting that determines whether a window's ordinal is set for all views (ETrue) or only when the top view is not active (EFalse)

If the CCoeControlStaticSettings object does not exist, then the default is to return EFalse.

ParentByDefault()

IMPORT_C TBool

ParentByDefault

(

)

[static]

Returns value of ROM-patchable constant KCoeSetControlParentByDefault. Patch for emulator builds by adding "patchdata_cone_dll_KCoeSetControlParentByDefault X" to epoc.ini where X is either 0 (zero) for "off" or 1 (one) for "on". Only valid in Symbian OS 9.3 and 9.4.

Self(CCoeEnv *)

CCoeControlStaticSettings *

Self

(

CCoeEnv *

aCoeEnv = NULL

)

[private, static]

Retrieve the one and only CCoeControlStaticSettings object, if it exists.

Parameters

CCoeEnv * aCoeEnv = NULL

SetFocusedByDefaultL(TBool)

IMPORT_C void

SetFocusedByDefaultL

(

TBool

aFocusedByDefault

)

[static]

Globally sets whether CCoeControls should take focus when they are created.

This function should be called from within a CEikLibrary plugin.

Parameters

TBool aFocusedByDefault

True if CCoeControls should take focus when created, false if not.

SetLogicalToPixelFontSizesL(const RArray< TInt > &)

IMPORT_C void

SetLogicalToPixelFontSizesL

(

const RArray < TInt > &

aLogicalToPixelSizes

)

[static]

Sets the default array of font pixel sizes.

Parameters

const RArray < TInt > & aLogicalToPixelSizes

TInt array to use as default with font sizes

SetOrdinalForAllViewsL(TBool)

IMPORT_C void

SetOrdinalForAllViewsL

(

TBool

aOrdinalForAllViews

)

[static]

Globally sets whether a window's ordinal is set for all views (ETrue) or only when the top view is not active (EFalse)

This function should be called from within a CEikLibrary plugin.

Parameters

TBool aOrdinalForAllViews

ETrue if the window's ordinal will be set for all views, EFalse if not.

SetParentByDefaultL(TBool)

IMPORT_C void

SetParentByDefaultL

(

TBool

aParentByDefault

)

[static]

Does nothing. CCoeControlStaticSettings::ParentByDefault()

Parameters

TBool aParentByDefault

SetSystemTypefaceL(const TDesC &)

IMPORT_C void

SetSystemTypefaceL

(

const TDesC &

aTypeface

)

[static]

Sets the default system type face name.

Parameters

const TDesC & aTypeface

is the name to set default system typeface name to

SystemTypeface()

IMPORT_C const TDesC &

SystemTypeface

(

)

[static]

Returns the default system type face name.

Member Data Documentation

TBool iFocusedByDefault

TBool

iFocusedByDefault

[private]

RArray< TInt > iLogicalToPixelSizes

RArray < TInt >

iLogicalToPixelSizes

[private]

TBool iOrdinalForAllViews

TBool

iOrdinalForAllViews

[private]

TTypeface iTypeface

TTypeface

iTypeface

[private]