BookmarkStorage Class Reference

This is an implementation of JEP-0048 (Bookmark Storage). More...

#include <bookmarkstorage.h>

Inherits PrivateXML, and PrivateXMLHandler.

Inheritance diagram for BookmarkStorage:

Inheritance graph
[legend]
Collaboration diagram for BookmarkStorage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BookmarkStorage (ClientBase *parent)
virtual ~BookmarkStorage ()
void storeBookmarks (const BookmarkHandler::BookmarkList &bList, const BookmarkHandler::ConferenceList &cList)
void requestBookmarks ()
void registerBookmarkHandler (BookmarkHandler *bmh)
void removeBookmarkHandler ()
virtual void handlePrivateXML (const std::string &tag, Tag *xml)
virtual void handlePrivateXMLResult (const std::string, PrivateXMLResult)

Detailed Description

This is an implementation of JEP-0048 (Bookmark Storage).

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

Definition at line 38 of file bookmarkstorage.h.


Constructor & Destructor Documentation

BookmarkStorage ClientBase parent  ) 
 

Constructs a new BookmarkStorage object.

Parameters:
parent The ClientBase to use for communication.

Definition at line 22 of file bookmarkstorage.cpp.

~BookmarkStorage  )  [virtual]
 

Virtual destructor.

Definition at line 28 of file bookmarkstorage.cpp.


Member Function Documentation

void handlePrivateXML const std::string &  tag,
Tag xml
[virtual]
 

Reimplement this function to receive the private XML that was requested earlier using PrivateXML::requestXML().

Parameters:
tag The tag of the storage packet.
xml The private xml, i.e. the first child of the <query> tag.

Implements PrivateXMLHandler.

Definition at line 76 of file bookmarkstorage.cpp.

References Tag::children().

void registerBookmarkHandler BookmarkHandler bmh  ) 
 

Use this function to register a BookmarkHandler.

Parameters:
bmh The BookmarkHandler which shall receive retrieved bookmarks.

Definition at line 125 of file bookmarkstorage.cpp.

void removeBookmarkHandler  ) 
 

Use this function to un-register the BookmarkHandler.

Definition at line 130 of file bookmarkstorage.cpp.

void requestBookmarks  ) 
 

Use this function to initiate retrieval of bookmarks. Use registerBookmarkHandler() to register an object which will receive the lists of bookmarks.

Definition at line 71 of file bookmarkstorage.cpp.

References PrivateXML::requestXML().

void storeBookmarks const BookmarkHandler::BookmarkList bList,
const BookmarkHandler::ConferenceList cList
 

Use this function to store a number of URL and conference bookmarks on the server. Make sure you store the whole set of bookmarks, not a 'delta'.

Parameters:
bList A list of URLs to store.
cList A list of conferences to store.

Definition at line 32 of file bookmarkstorage.cpp.

References Tag::addAttrib(), and Tag::addChild().


The documentation for this class was generated from the following files:
Generated on Mon Jan 16 16:19:56 2006 for gloox by  doxygen 1.4.6