QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
qgsmessagebaritem.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsmessagebaritem.h - description
3
-------------------
4
begin : August 2013
5
copyright : (C) 2013 by Denis Rouzaud
6
email : denis.rouzaud@gmail.com
7
***************************************************************************/
8
9
/***************************************************************************
10
* *
11
* This program is free software; you can redistribute it and/or modify *
12
* it under the terms of the GNU General Public License as published by *
13
* the Free Software Foundation; either version 2 of the License, or *
14
* (at your option) any later version. *
15
* *
16
***************************************************************************/
17
#ifndef QGSMESSAGEBARITEM_H
18
#define QGSMESSAGEBARITEM_H
19
20
#include "
qgis.h
"
21
#include "qgis_gui.h"
22
23
#include <QHBoxLayout>
24
#include <QIcon>
25
#include <QWidget>
26
27
class
QTextBrowser;
28
class
QLabel;
29
class
QgsMessageBar
;
30
38
class
GUI_EXPORT
QgsMessageBarItem
:
public
QWidget
39
{
40
Q_OBJECT
41
public
:
52
QgsMessageBarItem
(
const
QString &
text
,
Qgis::MessageLevel
level
=
Qgis::MessageLevel::Info
,
int
duration
= 0, QWidget *parent
SIP_TRANSFERTHIS
=
nullptr
);
53
64
QgsMessageBarItem
(
const
QString &
title
,
const
QString &
text
,
Qgis::MessageLevel
level
=
Qgis::MessageLevel::Info
,
int
duration
= 0, QWidget *parent
SIP_TRANSFERTHIS
=
nullptr
);
65
76
QgsMessageBarItem
(
const
QString &
title
,
const
QString &
text
, QWidget *
widget
,
Qgis::MessageLevel
level
=
Qgis::MessageLevel::Info
,
int
duration
= 0, QWidget *parent
SIP_TRANSFERTHIS
=
nullptr
);
77
88
QgsMessageBarItem
( QWidget *
widget
,
Qgis::MessageLevel
level
=
Qgis::MessageLevel::Info
,
int
duration
= 0, QWidget *parent
SIP_TRANSFERTHIS
=
nullptr
);
89
95
QgsMessageBarItem
*
setText
(
const
QString &
text
);
96
102
QString
text
()
const
;
103
109
QgsMessageBarItem
*
setTitle
(
const
QString &
title
);
110
116
QString
title
()
const
;
117
124
QgsMessageBarItem
*
setLevel
(
Qgis::MessageLevel
level
);
125
131
Qgis::MessageLevel
level
()
const
;
132
138
QgsMessageBarItem
*
setWidget
( QWidget *
widget
);
139
145
QWidget *
widget
()
const
;
146
152
QgsMessageBarItem
*
setIcon
(
const
QIcon &
icon
);
153
159
QIcon
icon
()
const
;
160
168
QgsMessageBarItem
*
setDuration
(
int
duration
);
169
178
int
duration
()
const
{
return
mDuration; }
179
184
QString
getStyleSheet
()
const
{
return
mStyleSheet; }
185
186
public
slots:
187
195
void
dismiss();
196
197
signals:
198
203
void
styleChanged
(
const
QString &styleSheet );
204
205
private
slots:
206
207
void
urlClicked(
const
QUrl &url );
208
209
private
:
210
void
writeContent();
211
212
QString mTitle;
213
QString mText;
214
Qgis::MessageLevel
mLevel;
215
int
mDuration;
216
QWidget *mWidget =
nullptr
;
217
QIcon mUserIcon;
218
QHBoxLayout *mLayout =
nullptr
;
219
QLabel *mLblIcon =
nullptr
;
220
QString mStyleSheet;
221
QTextBrowser *mTextBrowser =
nullptr
;
222
QgsMessageBar
*mMessageBar =
nullptr
;
223
224
friend
class
QgsMessageBar
;
225
};
226
227
#endif
// QGSMESSAGEBARITEM_H
Qgis::MessageLevel
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition
qgis.h:160
Qgis::Info
@ Info
Information message.
Definition
qgis.h:161
QgsMessageBarItem::styleChanged
void styleChanged(const QString &styleSheet)
Emitted when the item's message level has changed and the message bar style will need to be updated a...
QgsMessageBarItem::icon
QIcon icon() const
Returns the icon for the message.
Definition
qgsmessagebaritem.cpp:285
QgsMessageBarItem::setLevel
QgsMessageBarItem * setLevel(Qgis::MessageLevel level)
Sets the message level for the item, which controls how the message bar is styled when the item is di...
Definition
qgsmessagebaritem.cpp:241
QgsMessageBarItem::duration
int duration() const
Returns the duration (in seconds) of the message.
Definition
qgsmessagebaritem.h:178
QgsMessageBarItem::setText
QgsMessageBarItem * setText(const QString &text)
Sets the message text to show in the item.
Definition
qgsmessagebaritem.cpp:217
QgsMessageBarItem::setIcon
QgsMessageBarItem * setIcon(const QIcon &icon)
Sets the icon associated with the message.
Definition
qgsmessagebaritem.cpp:279
QgsMessageBarItem::text
QString text() const
Returns the text for the message.
Definition
qgsmessagebaritem.cpp:224
QgsMessageBarItem::widget
QWidget * widget() const
Returns the widget for the message.
Definition
qgsmessagebaritem.cpp:274
QgsMessageBarItem::QgsMessageBar
friend class QgsMessageBar
Definition
qgsmessagebaritem.h:224
QgsMessageBarItem::QgsMessageBarItem
QgsMessageBarItem(const QString &text, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=0, QWidget *parent=nullptr)
Constructor for QgsMessageBarItem, containing a message with the specified text to be displayed on th...
Definition
qgsmessagebaritem.cpp:36
QgsMessageBarItem::title
QString title() const
Returns the title for the message.
Definition
qgsmessagebaritem.cpp:236
QgsMessageBarItem::getStyleSheet
QString getStyleSheet() const
Returns the styleSheet which should be used to style a QgsMessageBar object when this item is display...
Definition
qgsmessagebaritem.h:184
QgsMessageBarItem::setTitle
QgsMessageBarItem * setTitle(const QString &title)
Sets the title for in the item.
Definition
qgsmessagebaritem.cpp:229
QgsMessageBarItem::level
Qgis::MessageLevel level() const
Returns the message level for the message.
Definition
qgsmessagebaritem.cpp:253
QgsMessageBarItem::setDuration
QgsMessageBarItem * setDuration(int duration)
Sets the duration (in seconds) to show the message for.
Definition
qgsmessagebaritem.cpp:291
QgsMessageBarItem::setWidget
QgsMessageBarItem * setWidget(QWidget *widget)
Sets a custom widget to show in the item.
Definition
qgsmessagebaritem.cpp:258
QgsMessageBar
A bar for displaying non-blocking messages to the user.
Definition
qgsmessagebar.h:61
qgis.h
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition
qgis_sip.h:52
Generated on
for QGIS API Documentation by
1.17.0