CLogView Class Reference

#include <logview.h>

Link against: logcli.lib

class CLogView : public CLogActive

Inherits from

CLogView
- CLogActive
  - CActive
    - CBase

Protected Attributes
CLogClient &	iClient
TDes8 *	iData
CLogMaintainClientOp *	iMaintain
CLogPackage *	iPackage
TAny *	iSpare2
TBool	iValid
TLogViewId	iViewId
CLogViewWindow *	iWindow

Public Member Functions
	~CLogView()
IMPORT_C TInt	CountL()
const CLogEvent &	Event()
IMPORT_C TBool	FirstL(TRequestStatus &)
IMPORT_C TBool	LastL(TRequestStatus &)
IMPORT_C TBool	NextL(TRequestStatus &)
IMPORT_C TBool	PreviousL(TRequestStatus &)
IMPORT_C void	SetFlagsL(TLogFlags)

Protected Member Functions
	CLogView(CLogClient &, TInt)
void	ConstructL(TInt, MLogViewChangeObserver *)
virtual void	DoCancel()
TBool	IsValid()
TInt	LogViewRecordCount()
void	ReadEventFromWindowL()
void	ReawaitForChanges()

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()
	CLogActive::CLogActive(TInt)
	CLogActive::Complete(TInt)
	CLogActive::Queue(TRequestStatus &)
	CLogActive::~CLogActive()

Detailed Description

Navigates a view on the log database.

The class provides functions for navigating through a set of events and a function to retrieve the event at the current position within the view.

The class cannot be instantiated. Further classes are derived from this class to define and construct views on the log database.

The set of events in a view are always ordered so that the first event in a view is the most recent.

Member Attribute Documentation

iClient

CLogClient &

iClient

[protected]

iData

TDes8 *

iData

[protected]

iMaintain

CLogMaintainClientOp *

iMaintain

[protected]

iPackage

CLogPackage *

iPackage

[protected]

iSpare2

TAny *

iSpare2

[protected]

iValid

TBool

iValid

[protected]

iViewId

TLogViewId

iViewId

[protected]

iWindow

CLogViewWindow *

iWindow

[protected]

Constructor & Destructor Documentation

CLogView ( CLogClient &, TInt )

CLogView	(	CLogClient &	aClient,
		TInt	aPriority = CActive::EPriorityStandard
	)	[protected]

~CLogView ( )

IMPORT_C

~CLogView

(

)

Frees all resources owned by this object prior to its destruction. In particular, any outstanding asynchronous request is cancelled.

Member Function Documentation

ConstructL ( TInt, MLogViewChangeObserver * )

void	ConstructL	(	TInt	aType,
			MLogViewChangeObserver *	aObserver = 0
		)	[protected]

CountL ( )

IMPORT_C TInt

CountL

(

)

Gets the number of events in the view.

Return Value: The number of events in the view.

DoCancel ( )

void

DoCancel

(

)

[protected, virtual]

Reimplemented from CLogActive::DoCancel()

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

Event ( )

const CLogEvent &

Event

(

)

const [inline]

Returns details of the log event at the current position within the view.

Return Value: A reference to the log event details object. If a view does not contain any events, then the content of this object is undefined.

FirstL ( TRequestStatus & )

IMPORT_C TBool

FirstL

(

TRequestStatus &

aStatus

)

Moves the current position in the view to the first event. The first event is the most recent event.

This is an asynchronous request.

Parameters
aStatus	The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; otherwise, one of the other system wide error codes.

Return Value: ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

IsValid ( )

TBool

IsValid

(

)

const [protected, inline]

LastL ( TRequestStatus & )

IMPORT_C TBool

LastL

(

TRequestStatus &

aStatus

)

Moves the current position in the view to the last event. The last event is the oldest event.

This is an asynchronous request.

Parameters
aStatus	The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; otherwise, one of the other system wide error codes.

Return Value: ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

LogViewRecordCount ( )

TInt

LogViewRecordCount

(

)

const [protected]

NextL ( TRequestStatus & )

IMPORT_C TBool

NextL

(

TRequestStatus &

aStatus

)

Moves the current position in the view to the next event. The next event is always older than the current event, i.e. next implies movement in the first to last direction.

Parameters
aStatus	The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; otherwise, one of the other system wide error codes.

Return Value: ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

PreviousL ( TRequestStatus & )

IMPORT_C TBool

PreviousL

(

TRequestStatus &

aStatus

)

Moves the current position in the view to the previous event. The previous event is always more recent than the current event, i.e. previous implies movement in the last to first direction.

Parameters
aStatus	The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; otherwise, one of the other system wide error codes.

Return Value: ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

ReadEventFromWindowL ( )

void

ReadEventFromWindowL

(

)

[protected]

ReawaitForChanges ( )

void

ReawaitForChanges

(

)

[protected]

SetFlagsL ( TLogFlags )

IMPORT_C void

SetFlagsL

(

TLogFlags

aFlags

)

Capability
Note	For built-in event types, the required capability level is defined in the event type's write access policy.