QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Slots | Signals | Public Member Functions | Friends | List of all members
QgsMessageBarItem Class Reference

#include <qgsmessagebaritem.h>

Inheritance diagram for QgsMessageBarItem:
Inheritance graph
[legend]

Public Slots

void dismiss ()
 Dismisses the item, removing it from the message bar and deleting it. More...
 

Signals

void styleChanged (const QString &styleSheet)
 emitted when the message level has changed More...
 

Public Member Functions

 QgsMessageBarItem (const QString &text, Qgis::MessageLevel level=Qgis::Info, int duration=0, QWidget *parent=nullptr)
 make out a widget containing a message to be displayed on the bar More...
 
 QgsMessageBarItem (const QString &title, const QString &text, Qgis::MessageLevel level=Qgis::Info, int duration=0, QWidget *parent=nullptr)
 make out a widget containing title and message to be displayed on the bar More...
 
 QgsMessageBarItem (const QString &title, const QString &text, QWidget *widget, Qgis::MessageLevel level=Qgis::Info, int duration=0, QWidget *parent=nullptr)
 make out a widget containing title, message and widget to be displayed on the bar More...
 
 QgsMessageBarItem (QWidget *widget, Qgis::MessageLevel level=Qgis::Info, int duration=0, QWidget *parent=nullptr)
 make out a widget containing a widget to be displayed on the bar More...
 
int duration () const
 returns the duration in second of the message More...
 
QString getStyleSheet ()
 returns the styleSheet More...
 
QIcon icon () const
 Returns the icon for the message. More...
 
Qgis::MessageLevel level () const
 Returns the message level for the message. More...
 
QgsMessageBarItemsetDuration (int duration)
 
QgsMessageBarItemsetIcon (const QIcon &icon)
 
QgsMessageBarItemsetLevel (Qgis::MessageLevel level)
 
QgsMessageBarItemsetText (const QString &text)
 
QgsMessageBarItemsetTitle (const QString &title)
 
QgsMessageBarItemsetWidget (QWidget *widget)
 
QString text () const
 Returns the text for the message. More...
 
QString title () const
 Returns the title for the message. More...
 
QWidget * widget () const
 Returns the widget for the message. More...
 

Friends

class QgsMessageBar
 

Detailed Description

Definition at line 36 of file qgsmessagebaritem.h.

Constructor & Destructor Documentation

◆ QgsMessageBarItem() [1/4]

QgsMessageBarItem::QgsMessageBarItem ( const QString &  text,
Qgis::MessageLevel  level = Qgis::Info,
int  duration = 0,
QWidget *  parent = nullptr 
)

make out a widget containing a message to be displayed on the bar

Definition at line 29 of file qgsmessagebaritem.cpp.

◆ QgsMessageBarItem() [2/4]

QgsMessageBarItem::QgsMessageBarItem ( const QString &  title,
const QString &  text,
Qgis::MessageLevel  level = Qgis::Info,
int  duration = 0,
QWidget *  parent = nullptr 
)

make out a widget containing title and message to be displayed on the bar

Definition at line 38 of file qgsmessagebaritem.cpp.

◆ QgsMessageBarItem() [3/4]

QgsMessageBarItem::QgsMessageBarItem ( const QString &  title,
const QString &  text,
QWidget *  widget,
Qgis::MessageLevel  level = Qgis::Info,
int  duration = 0,
QWidget *  parent = nullptr 
)

make out a widget containing title, message and widget to be displayed on the bar

Definition at line 48 of file qgsmessagebaritem.cpp.

◆ QgsMessageBarItem() [4/4]

QgsMessageBarItem::QgsMessageBarItem ( QWidget *  widget,
Qgis::MessageLevel  level = Qgis::Info,
int  duration = 0,
QWidget *  parent = nullptr 
)

make out a widget containing a widget to be displayed on the bar

Definition at line 61 of file qgsmessagebaritem.cpp.

Member Function Documentation

◆ dismiss

void QgsMessageBarItem::dismiss ( )
slot

Dismisses the item, removing it from the message bar and deleting it.

Calling this on items which have not been added to a message bar has no effect.

Since
QGIS 3.4

Definition at line 273 of file qgsmessagebaritem.cpp.

◆ duration()

int QgsMessageBarItem::duration ( ) const
inline

returns the duration in second of the message

Definition at line 90 of file qgsmessagebaritem.h.

◆ getStyleSheet()

QString QgsMessageBarItem::getStyleSheet ( )
inline

returns the styleSheet

Definition at line 93 of file qgsmessagebaritem.h.

◆ icon()

QIcon QgsMessageBarItem::icon ( ) const

Returns the icon for the message.

Definition at line 261 of file qgsmessagebaritem.cpp.

◆ level()

Qgis::MessageLevel QgsMessageBarItem::level ( ) const

Returns the message level for the message.

Definition at line 229 of file qgsmessagebaritem.cpp.

◆ setDuration()

QgsMessageBarItem * QgsMessageBarItem::setDuration ( int  duration)

Definition at line 267 of file qgsmessagebaritem.cpp.

◆ setIcon()

QgsMessageBarItem * QgsMessageBarItem::setIcon ( const QIcon &  icon)

Definition at line 255 of file qgsmessagebaritem.cpp.

◆ setLevel()

QgsMessageBarItem * QgsMessageBarItem::setLevel ( Qgis::MessageLevel  level)

Definition at line 221 of file qgsmessagebaritem.cpp.

◆ setText()

QgsMessageBarItem * QgsMessageBarItem::setText ( const QString &  text)

Definition at line 197 of file qgsmessagebaritem.cpp.

◆ setTitle()

QgsMessageBarItem * QgsMessageBarItem::setTitle ( const QString &  title)

Definition at line 209 of file qgsmessagebaritem.cpp.

◆ setWidget()

QgsMessageBarItem * QgsMessageBarItem::setWidget ( QWidget *  widget)

Definition at line 234 of file qgsmessagebaritem.cpp.

◆ styleChanged

void QgsMessageBarItem::styleChanged ( const QString &  styleSheet)
signal

emitted when the message level has changed

◆ text()

QString QgsMessageBarItem::text ( ) const

Returns the text for the message.

Definition at line 204 of file qgsmessagebaritem.cpp.

◆ title()

QString QgsMessageBarItem::title ( ) const

Returns the title for the message.

Definition at line 216 of file qgsmessagebaritem.cpp.

◆ widget()

QWidget * QgsMessageBarItem::widget ( ) const

Returns the widget for the message.

Definition at line 250 of file qgsmessagebaritem.cpp.

Friends And Related Function Documentation

◆ QgsMessageBar

friend class QgsMessageBar
friend

Definition at line 129 of file qgsmessagebaritem.h.


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