Class CAgnTodoListList

CAgnTodoListList

Support

Supported from 5.0

Description

A list of to-do list IDs, each of which uniquely identifies a to-do list.

Derivation

CAgnTodoListList A list of to-do list IDs, each of which uniquely identifies a to-do list CBase Base class for all classes to be instantiated on the heap

Defined in CAgnTodoListList:
AppendL(), Count(), Delete(), DisplayInfo(), Find(), InsertL(), NewL(), ReplicationStatus(), TListItem, TodoListId(), ~CAgnTodoListList()

Inherited from CBase:
operator new()

static CAgnTodoListList* NewL();

Description

Allocates and constructs a new to-do list list.

Return value

CAgnTodoListList* A pointer to the new to-do list list.

virtual ~CAgnTodoListList();

Description

Destructs a to-do list list.

TInt Count() const;

Description

Returns the count of to-do lists.

Return value

TInt The number of to-do lists.

TAgnTodoDisplaySettings DisplayInfo(TInt aIndex) const;

Description

Returns the settings that determine how the indexed to-do list is displayed in other views.

Parameters

TInt aIndex The index of a list.

Return value

TAgnTodoDisplaySettings The display settings of the indexed list.

TAgnReplicationData::TStatus ReplicationStatus(TInt aIndex) const;

Description

Returns replication status data for the indexed to-do list, e.g. the last changed date.

Parameters

TInt aIndex The index of a list.

Return value

TAgnReplicationData::TStatus The replication status of the indexed list.

void AppendL(const TListItem* aItem);

Description

Appends a list ID to the end of the list of IDs.

Parameters

const TListItem* aItem A pointer to the ID.

void Delete(TInt aPosition);

Description

Deletes a list ID from the list of IDs.

Parameters

TAgnTodoListId aTodoListId The ID of the list to be deleted.

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

Description

Inserts a list ID into the list of IDs.

Parameters

TInt aPosition The index of the insertion point. const TListItem* aItem A pointer to the ID to be inserted.

TInt Find(TAgnTodoListId aTodoListId,TInt& aPos) const;

Description

Validates a to-do list ID and finds its position.

Parameters

TAgnTodoListId aTodoListId The required list ID. TInt& aPos On return, the index (if the ID is valid).

Return value

TInt 0 if aTodoListId can be found, 1 if it can't be found and –1 if the array is empty.

TAgnTodoListId TodoListId(TInt aIndex) const;

Description

Returns a to-do list ID given its index.

Parameters

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

Return value

TAgnTodoListId The list ID of aIndex'th item in the list of lists.

TListItem

Description

Represents one item in the to-do list list.

Defined in CAgnTodoListList::TListItem:
iDisplayInfo, iReplicationStatus, iTodoListId

Data members

iDisplayInfo

---

TAgnTodoDisplaySettings iDisplayInfo

Description

Contains the settings that determine how to-dos belonging to the to-do list are displayed in views other than the to-do view.

iReplicationStatus

---

TAgnReplicationData::TStatus iReplicationStatus

Description

Contains replication status data, e.g. last changed date.

iTodoListId

---

TAgnTodoListId iTodoListId

Description

Contains the unique ID of the to-do list.