fresh/Python/Gui/pQueuedMessageWidget.sip

/*!
	\brief The is the \c message structure used by the pQueuedMessageWidget class.
	\details It allow to configure the message to show.
	\details Each variable is directly accessible and mostly optionnal except \c message.
	\details A default \c Ok button is added if \c buttons is empty.
*/
struct pQueuedMessage
{
%TypeHeaderCode
#include <gui/queuedmessage/pQueuedMessageWidget.h>
%End
	
	pQueuedMessage();
	
	bool operator==( const pQueuedMessage& other ) const;
	
	/*! \details The message to show */
	QString message;
	/*! \details The millisecond time to wait before the message is auto closed. Use 0 for unilimited time */
	int milliSeconds;
	/*! \details The pixmap to show before the message */
	QPixmap pixmap;
	/*! \details The brush to use as background */
	QBrush background;
	/*! \details The brush to use as foreground */
	QBrush foreground;
	/*! \details A hash representing a StandardButton role, and it's optionnal text overridding the default StandardButton text */
	QHash<QDialogButtonBox::StandardButton, QString> buttons; // StandardButton, Button Text ( null text for standard text )
	/*! \details The object that is used to invoke \c Slot */
	//QWeakPointer<QObject> object;
	/*!
		\details If \c object is not null, it will invoke this \c slot, the slot must take 2 parameters :
		\details QDialogButtonBox::StandardButton : The StandardButton clicked
		\details pQueuedMessage : The message from where the button was clicked
	*/
	const char* slot;
	/*! \details A place to stock custom user data */
	QVariant userData;
};

/*!
	\brief A QMessageBox like Widget, that can show queued message.
	\details The messages are queued until they are closed by user or elapsed time is timeout
*/
class pQueuedMessageWidget : QWidget
{
%TypeHeaderCode
#include <gui/queuedmessage/pQueuedMessageWidget.h>
%End

public:
	pQueuedMessageWidget( QWidget* parent = 0 );
	
	virtual QSize sizeHint() const;
	
	bool openExternalLinks() const;
	int defaultTimeout() const;
	QPixmap defaultPixmap() const;
	QBrush defaultBackground() const;
	QBrush defaultForeground() const;
	void currentMessageInformations( QPixmap* pixmap, QBrush* background, QBrush* foreground ) const;
	
	int pendingMessageCount() const;
	pQueuedMessage currentMessage() const;
	pQueuedMessage append( const QString& message, int milliSeconds = -1 );

public slots:
	void setOpenExternalLinks( bool open );
	void setDefaultTimeout( int timeout );
	void setDefaultPixmap( const QPixmap& pixmap );
	void setDefaultBackground( const QBrush& brush );
	void setDefaultForeground( const QBrush& brush );
	void append( const pQueuedMessage& message );
	void remove( const pQueuedMessage& message );
	void clear();

protected:
	
	void paintEvent( QPaintEvent* event );

protected slots:
	void buttonClicked( QAbstractButton* button );
	void showMessage();
	void closeMessage();
	void clearMessage();

signals:
	void shown( const pQueuedMessage& message );
	void closed( const pQueuedMessage& message );
	void cleared();
	void finished();
	void linkActivated( const QString& link );
	void linkHovered( const QString& link );
};