Documentation for class File. More...

#include <File.hpp>

Inheritance diagram for FileSource:

Collaboration diagram for FileSource:

Public Member Functions
	FileSource (const std::string &f)
	Constructor. More...

virtual	~FileSource ()
	Destructor, virtual by default. More...

enum OpenAB_Source::Source::eInit	init ()
	Initializes Source. More...

enum OpenAB_Source::Source::eGetItemRet	getItem (OpenAB::SmartPtr< OpenAB::PIMItem > &item)
	Gets PIM Item from Source. If Source is suspended getItem() should block until Source will be resumed or cancelled. More...

enum OpenAB_Source::Source::eSuspendRet	suspend ()
	Suspends Source, if such operation is supported. More...

enum OpenAB_Source::Source::eResumeRet	resume ()
	Resumes Source, if such operation is supported. More...

enum OpenAB_Source::Source::eCancelRet	cancel ()
	Cancels Source, if such operation is supported. After canceling Source next call to getVCard() should return eGetItemRetError status. More...

int	getTotalCount () const
	Returns total count of items available from Source, if such information is available. More...

Public Member Functions inherited from OpenAB_Source::Source
	Source (OpenAB::PIMItemType t)
	Constructor. More...

virtual	~Source ()
	Destructor, virtual by default. More...

OpenAB::PIMItemType	getItemType () const
	Returns type of PIM Item supported by Source. More...

Additional Inherited Members
Public Types inherited from OpenAB_Source::Source
enum	eInit { eInitOk, eInitFail }

enum	eSuspendRet { eSuspendRetOk, eSuspendRetFail, eSuspendRetNotSupported }

enum	eResumeRet { eResumeRetOk, eResumeRetFail, eResumeRetNotSupported }

enum	eCancelRet { eCancelRetOk, eCancelRetFail, eCancelRetNotSupported }

enum	eGetItemRet { eGetItemRetOk, eGetItemRetEnd, eGetItemRetError }

Detailed Description

Documentation for class File.

Constructor & Destructor Documentation

FileSource::FileSource ( const std::string & f )

Constructor.

FileSource::~FileSource ( )

virtual

Destructor, virtual by default.

enum OpenAB_Source::Source::eCancelRet FileSource::cancel ( )

virtual

Cancels Source, if such operation is supported. After canceling Source next call to getVCard() should return eGetItemRetError status.

enum OpenAB_Source::Source::eGetItemRet FileSource::getItem ( OpenAB::SmartPtr< OpenAB::PIMItem > & item )

virtual

Gets PIM Item from Source. If Source is suspended getItem() should block until Source will be resumed or cancelled.

Parameters

[out] item item received from Source

Note: item is returned as smart pointer, its contents will be deleted automatically when no more references to it will exist, it's not advised to dereference and use direct pointer

int FileSource::getTotalCount ( ) const

virtual

Returns total count of items available from Source, if such information is available.