LeechCraft Azoth  0.6.70-15082-g543737046d
Modular multiprotocol IM plugin for LeechCraft
Public Member Functions | List of all members
LC::Azoth::ISupportBookmarks Class Referenceabstract

Interface for accounts supporting bookmarks. More...

#include "isupportbookmarks.h"

Public Member Functions

virtual ~ISupportBookmarks ()
 
virtual QWidget * GetMUCBookmarkEditorWidget ()=0
 Returns the editor widget for the bookmarks of this protocol. More...
 
virtual QVariantList GetBookmarkedMUCs () const =0
 Returns the list of bookmarked MUCs, if any. More...
 
virtual void SetBookmarkedMUCs (const QVariantList &bookmarks)=0
 Sets the bookmarked MUCs for the given account. More...
 
virtual void bookmarksChanged ()=0
 Notifies that bookmarks have been changed. More...
 

Detailed Description

Interface for accounts supporting bookmarks.

This interface should be implemented by accounts that support bookmarking conferences.

If this interface is implemented by an entry, the parent account must also implement IMUCProtocol.

See also
IMUCProtocol

Definition at line 30 of file isupportbookmarks.h.

Constructor & Destructor Documentation

◆ ~ISupportBookmarks()

virtual LC::Azoth::ISupportBookmarks::~ISupportBookmarks ( )
inlinevirtual

Definition at line 33 of file isupportbookmarks.h.

Member Function Documentation

◆ bookmarksChanged()

virtual void LC::Azoth::ISupportBookmarks::bookmarksChanged ( )
pure virtual

Notifies that bookmarks have been changed.

This signal should be emitted whenever the list of the bookmarks changes. Particularly, it should be emitted after SetBookmarkedMUCs() is called, for example, when server acknowledges bookmarks are saved successfully if they are stored remotely, or immediately if they are stored locally.

See also
SetBookmarkedMUCs()

◆ GetBookmarkedMUCs()

virtual QVariantList LC::Azoth::ISupportBookmarks::GetBookmarkedMUCs ( ) const
pure virtual

Returns the list of bookmarked MUCs, if any.

The returned list is a list of QVariantMaps which should have the same format as the ones returned from the GetIdentifyingData(). Please refer to documentation for GetIdentifyingData() for more information about maps' contents.

Returns
List of bookmarks parameters.
See also
GetIdentifyingData()

◆ GetMUCBookmarkEditorWidget()

virtual QWidget* LC::Azoth::ISupportBookmarks::GetMUCBookmarkEditorWidget ( )
pure virtual

Returns the editor widget for the bookmarks of this protocol.

The returned widget must implement the IMUCBookmarkEditorWidget interface.

This function should create a new widget each time it is called, since the ownership is transferred to the caller and the widget will be deleted by the caller when appropriate.

See also
IMUCBookmarkEditorWidget

◆ SetBookmarkedMUCs()

virtual void LC::Azoth::ISupportBookmarks::SetBookmarkedMUCs ( const QVariantList &  bookmarks)
pure virtual

Sets the bookmarked MUCs for the given account.

The passed list is typically based on the result of the corresponding IMUCBookmarkEditWidget::GetIdentifyingData() return values.

The bookmarksChanged() signal should be emitted soon after this call.

Parameters
[in]bookmarksThe list of variant maps with bookmarks.
See also
bookmarksChanged()
The documentation for this class was generated from the following file: