CAgnTodoListNames

Support

Supported from 5.0

Description

A list of to-do list names and their IDs each of which uniquely identifies a to-do list.

Derivation

CAgnTodoListNames A list of to-do list names and their IDs each of which uniquely identifies a to-do list CBase Base class for all classes to be instantiated on the heap

Defined in CAgnTodoListNames:
AppendL(), Count(), InsertL(), NewL(), Reset(), SortOrder(), TListItem, TodoListId(), TodoListName(), operator[](), ~CAgnTodoListNames()

Inherited from CBase:
operator new()

static CAgnTodoListNames* NewL();

Description

Allocates and constructs a list of to-do list names and corresponding IDs.

Return value

CAgnTodoListNames* Pointer to the created list.

virtual ~CAgnTodoListNames();

Description

Destructs the list of names.

void Reset();

Description

Deletes the list of names and frees the allocated memory.

TInt Count() const;

Description

Gets the number of names in the name list.

Return value

TInt The number of names.

CAgnTodoList::TSortOrder SortOrder(TInt aIndex) const;

Description

Returns the sort order of the to-do list given its index in the name list.

Parameters

TInt aIndex The index of the list in the name list.

Return value

CAgnTodoList::TSortOrder The sort order of the to-do list.

TAgnTodoListId TodoListId(TInt aIndex) const;

Description

Returns a list ID given its index in the name list.

Parameters

TInt aIndex The index of the ID in the name list.

Return value

TAgnTodoListId The ID of the indexed item in the name list.

const TDesC& TodoListName(TInt aIndex) const;

Description

Returns the to-do list name at the indexed position in the name list.

Parameters

TInt aIndex The index of the name in the name list.

Return value

TDesC& The to-do list name.

const TListItem& operator[](TInt aIndex) const;

Description

Returns a reference to the list item at the indexed position.

Parameters

TInt aIndex The index of the required item.

Return value

TListItem& Reference to the item.

void InsertL(TInt aPosition,const TListItem& aItem);

Description

Inserts an item into the list of names at the indexed position.

Parameters

TInt aPosition The index for the item in the list. const TListItem& aItem The item to insert.

void AppendL(const TListItem& aItem);

Description

Appends a name to the end of the name list.

Parameters

const TListItem& aItem The name to append.

CAgnTodoListNames::TListItem

Description

These functions are used to set or get a property of a to-do list.

Defined in CAgnTodoListNames::TListItem:
Name(), SetName(), SetSortOrder(), SetTodoListId(), SortOrder(), TodoListId()

const TDesC& Name() const;

Description

Returns the to-do list name.

Return value

TDesC& The name of the to-do list.

CAgnTodoList::TSortOrder SortOrder() const;

Description

Gets the sort order of the list.

Return value

CAgnTodoList::TSortOrder The sort order.

TAgnTodoListId TodoListId() const;

Description

Gets the to-do list ID.

Return value

TAgnTodoListId The list ID.

void SetName(const TDesC& aName);

Description

Sets the name of the list item.

Parameters

const TDesC& aName The name.

void SetSortOrder(CAgnTodoList::TSortOrder aSortOrder);

Description

Sets the sort order for the list

Parameters

CAgnTodoList::TSortOrder aSortOrder The sort order.

void SetTodoListId(TAgnTodoListId aTodoListId);

Description

Sets the to-do list ID.

Parameters

TAgnTodoListId aTodoListId The ID.