PrivacyListHandler Class Reference

A virtual interface that allows to retrieve Privacy Lists. More...

#include <privacylisthandler.h>

List of all members.

Public Types

enum  resultEnum {
  RESULT_STORE_SUCCESS, RESULT_ACTIVATE_SUCCESS, RESULT_DEFAULT_SUCCESS, RESULT_REMOVE_SUCCESS,
  RESULT_REQUEST_NAMES_SUCCESS, RESULT_REQUEST_LIST_SUCCESS, RESULT_CONFLICT, RESULT_ITEM_NOT_FOUND,
  RESULT_BAD_REQUEST
}
typedef std::list< PrivacyItemPrivacyList

Public Member Functions

virtual ~PrivacyListHandler ()
virtual void handlePrivacyListNames (const std::string &active, const std::string &def, const StringList &lists)=0
virtual void handlePrivacyList (const std::string &name, PrivacyList &items)=0
virtual void handlePrivacyListChanged (const std::string &name)=0
virtual void handlePrivacyListResult (const std::string &id, resultEnum result)=0


Detailed Description

A virtual interface that allows to retrieve Privacy Lists.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.3

Definition at line 31 of file privacylisthandler.h.


Member Typedef Documentation

typedef std::list<PrivacyItem> PrivacyList

A list of PrivacyItems.

Definition at line 55 of file privacylisthandler.h.


Member Enumeration Documentation

enum resultEnum

The possible results of an operation on a privacy list.

Enumerator:
RESULT_STORE_SUCCESS  Storing was successful.
RESULT_ACTIVATE_SUCCESS  Activation was successful.
RESULT_DEFAULT_SUCCESS  Setting the default list was successful.
RESULT_REMOVE_SUCCESS  Removing a list was successful.
RESULT_REQUEST_NAMES_SUCCESS  Requesting the list names was successful.
RESULT_REQUEST_LIST_SUCCESS  The list was requested successfully.
RESULT_CONFLICT  A conflict occurred when activating a list or setting the default list.
RESULT_ITEM_NOT_FOUND  The requested list does not exist.
RESULT_BAD_REQUEST  Bad request.

Definition at line 38 of file privacylisthandler.h.


Constructor & Destructor Documentation

virtual ~PrivacyListHandler (  )  [inline, virtual]

Virtual Destructor.

Definition at line 60 of file privacylisthandler.h.


Member Function Documentation

virtual void handlePrivacyListNames ( const std::string &  active,
const std::string &  def,
const StringList lists 
) [pure virtual]

Reimplement this function to retrieve the list of privacy list names after requesting it using PrivacyManager::requestListNames().

Parameters:
active The name of the active list.
def The name of the default list.
lists All the lists.

Referenced by PrivacyManager::handleIqID().

virtual void handlePrivacyList ( const std::string &  name,
PrivacyList items 
) [pure virtual]

Reimplement this function to retrieve the content of a privacy list after requesting it using PrivacyManager::requestList().

Parameters:
name The name of the list.
items A list of PrivacyItem's.

Referenced by PrivacyManager::handleIqID().

virtual void handlePrivacyListChanged ( const std::string &  name  )  [pure virtual]

Reimplement this function to be notified about new or changed lists.

Parameters:
name The name of the new or changed list.

Referenced by PrivacyManager::handleIq().

virtual void handlePrivacyListResult ( const std::string &  id,
resultEnum  result 
) [pure virtual]

Reimplement this function to receive results of stores etc.

Parameters:
id The ID of the request, as returned by the initiating function.
result The result of an operation.

Referenced by PrivacyManager::handleIqID().


The documentation for this class was generated from the following file:
Generated on Tue May 1 14:20:25 2007 for gloox by  doxygen 1.5.1