LeechCraft Azoth  0.6.70-10870-g558588d6ec
Modular multiprotocol IM plugin for LeechCraft
LeechCraft::Azoth::IMUCConfigWidget Class Referenceabstract

This interface is for widgets used to configure the room. More...

#include "iconfigurablemuc.h"

Public Member Functions

virtual ~IMUCConfigWidget ()
 
virtual void accept ()=0
 This function is called to accept the configuration. More...
 
virtual void dataReady ()=0
 This signal notifies about the widget's readiness. More...
 

Detailed Description

This interface is for widgets used to configure the room.

The widgets that are returned from the IConfigurableMUC::GetConfigurationWidget() method must implement this interface.

They are shown to the user, and since it's better to pre-fill the widget with current room configuration, but fetching the configuration may require communicating to the server, the widget would be in disabled state until the dataReady() signal is emitted.

When the user chooses to accept the widget, then accept() method or IConfigurableMUC::AcceptConfiguration() method would be called depending on the context, but never both at once. It's suggested that one should just be implemented by calling the other.

Definition at line 57 of file iconfigurablemuc.h.

Constructor & Destructor Documentation

◆ ~IMUCConfigWidget()

virtual LeechCraft::Azoth::IMUCConfigWidget::~IMUCConfigWidget ( )
inlinevirtual

Definition at line 60 of file iconfigurablemuc.h.

Member Function Documentation

◆ accept()

virtual void LeechCraft::Azoth::IMUCConfigWidget::accept ( )
pure virtual

This function is called to accept the configuration.

If the user chooses to accept the configuration, then this function is called.

Note
This function is expected to be a slot.

◆ dataReady()

virtual void LeechCraft::Azoth::IMUCConfigWidget::dataReady ( )
pure virtual

This signal notifies about the widget's readiness.

When the current room configuration data arrives and the widget is filled with it, this signal should be emitted to notify Azoth that it's now safe to allow the user to interact with the widget.

Note
This function is expected to be a signal.

The documentation for this class was generated from the following file: