Symbian^3 Application Developer Library >

CCalenViewInfo Class Reference

class CCalenViewInfo : public CBase

Wrapper around views. This lets us quickly get info on views. When accessed through general settings, native views won't be constructed so their iView pointer will be NULL.

Inherits from

Public Member Functions
~CCalenViewInfo ()
IMPORT_C CCalenView::TCyclePosition CyclePosition ()
IMPORT_C TInt CyclePositionComparison (const CCalenViewInfo &, const CCalenViewInfo &)
IMPORT_C TBool Hidden ()
IMPORT_C void Hide ( TBool )
IMPORT_C const TDesC & MenuName ()
IMPORT_C CCalenViewInfo * NewL ( TUid , TUid , const TDesC &, const TDesC &, CCalenView::TCyclePosition)
IMPORT_C TUid PluginUid ()
IMPORT_C const TDesC & SettingsName ()
IMPORT_C TBool ViewInfoIdentifier (const TUid *, const CCalenViewInfo &)
IMPORT_C TBool ViewPluginIdentifier (const TUid *, const CCalenViewInfo &)
IMPORT_C TUid ViewUid ()
Private Member Functions
CCalenViewInfo ( TUid , TUid , CCalenView::TCyclePosition)
void ConstructL (const TDesC &, const TDesC &)
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()
Private Attributes
CCalenView::TCyclePosition iCyclePos
TBool iHidden
HBufC * iMenuName
TUid iPluginUid
HBufC * iSettingsName
TUid iViewUid

Constructor & Destructor Documentation

CCalenViewInfo(TUid, TUid, CCalenView::TCyclePosition)

CCalenViewInfo ( TUid aViewUid,
TUid aPluginUid,
CCalenView::TCyclePosition aCyclePos
) [private]

Parameters

TUid aViewUid
TUid aPluginUid
CCalenView::TCyclePosition aCyclePos

~CCalenViewInfo()

~CCalenViewInfo ( ) [virtual]

Member Functions Documentation

ConstructL(const TDesC &, const TDesC &)

void ConstructL ( const TDesC & aMenuName,
const TDesC & aSettingsName
) [private]

Parameters

const TDesC & aMenuName
const TDesC & aSettingsName

CyclePosition()

IMPORT_C CCalenView::TCyclePosition CyclePosition ( ) const

Position the view would like to go in view cycling.

CyclePositionComparison(const CCalenViewInfo &, const CCalenViewInfo &)

IMPORT_C TInt CyclePositionComparison ( const CCalenViewInfo & aFirstView,
const CCalenViewInfo & aSecondView
) [static]

Compares two views based upon their view cycle position used for sorting CCalenViewInfo arrays.

Parameters

const CCalenViewInfo & aFirstView
const CCalenViewInfo & aSecondView

Hidden()

IMPORT_C TBool Hidden ( ) const

Is the view hidden?

Hide(TBool)

IMPORT_C void Hide ( TBool aHide )

Hide the view from the view cycle list

Parameters

TBool aHide

MenuName()

IMPORT_C const TDesC & MenuName ( ) const

Localised view name, as appears in e.g. view cycle menu.

NewL(TUid, TUid, const TDesC &, const TDesC &, CCalenView::TCyclePosition)

IMPORT_C CCalenViewInfo * NewL ( TUid aViewUid,
TUid aPluginUid,
const TDesC & aMenuName,
const TDesC & aSettingsName,
CCalenView::TCyclePosition aCyclePos
) [static]

Parameters

TUid aViewUid
TUid aPluginUid
const TDesC & aMenuName
const TDesC & aSettingsName
CCalenView::TCyclePosition aCyclePos

PluginUid()

IMPORT_C TUid PluginUid ( ) const

UID of the plugin.

SettingsName()

IMPORT_C const TDesC & SettingsName ( ) const

Localised view name, as appears in default view settings page.

ViewInfoIdentifier(const TUid *, const CCalenViewInfo &)

IMPORT_C TBool ViewInfoIdentifier ( const TUid * aUid,
const CCalenViewInfo & aArrayItem
) [static]

Matches a CCalenViewInfo object with its view Uid

Parameters

const TUid * aUid
const CCalenViewInfo & aArrayItem

ViewPluginIdentifier(const TUid *, const CCalenViewInfo &)

IMPORT_C TBool ViewPluginIdentifier ( const TUid * aUid,
const CCalenViewInfo & aArrayItem
) [static]

Matches a CCalenViewInfo object with its plugin uid.

Parameters

const TUid * aUid
const CCalenViewInfo & aArrayItem

ViewUid()

IMPORT_C TUid ViewUid ( ) const

UID of the view.

Member Data Documentation

CCalenView::TCyclePosition iCyclePos

CCalenView::TCyclePosition iCyclePos [private]

TBool iHidden

TBool iHidden [private]

HBufC * iMenuName

HBufC * iMenuName [private]

TUid iPluginUid

TUid iPluginUid [private]

HBufC * iSettingsName

HBufC * iSettingsName [private]

TUid iViewUid

TUid iViewUid [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.