/usr/include/qgis/qgsmessagebar.h is in libqgis-dev 2.14.11+dfsg-3+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | /***************************************************************************
qgsmessagebar.h - description
-------------------
begin : June 2012
copyright : (C) 2012 by Giuseppe Sucameli
email : sucameli at faunalia dot it
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSMESSAGEBAR_H
#define QGSMESSAGEBAR_H
#include <qgisgui.h>
#include <QString>
#include <QFrame>
#include <QIcon>
#include <QColor>
#include <QList>
class QWidget;
class QGridLayout;
class QMenu;
class QProgressBar;
class QToolButton;
class QLabel;
class QAction;
class QTimer;
class QgsMessageBarItem;
/** \ingroup gui
* A bar for displaying non-blocking messages to the user.
*/
class GUI_EXPORT QgsMessageBar: public QFrame
{
Q_OBJECT
public:
enum MessageLevel
{
INFO = 0,
WARNING = 1,
CRITICAL = 2,
SUCCESS = 3
};
QgsMessageBar( QWidget *parent = nullptr );
~QgsMessageBar();
/**
* Display a message item on the bar after hiding the currently visible one
* and putting it in a stack.
* The message bar will take ownership of the item.
*
* @param item Item to display
*/
void pushItem( QgsMessageBarItem *item );
/** Display a widget as a message on the bar after hiding the currently visible one
* and putting it in a stack.
* @param widget message widget to display
* @param level is QgsMessageBar::INFO, WARNING, CRITICAL or SUCCESS
* @param duration timeout duration of message in seconds, 0 value indicates no timeout
*/
QgsMessageBarItem *pushWidget( QWidget *widget, MessageLevel level = INFO, int duration = 0 );
/** Remove the passed widget from the bar (if previously added),
* then display the next one in the stack if any or hide the bar
* @param item item to remove
* @return true if the widget was removed, false otherwise
*/
bool popWidget( QgsMessageBarItem *item );
//! make out a widget containing a message to be displayed on the bar
static QgsMessageBarItem* createMessage( const QString &text, QWidget *parent = nullptr );
//! make out a widget containing title and message to be displayed on the bar
static QgsMessageBarItem* createMessage( const QString &title, const QString &text, QWidget *parent = nullptr );
//! make out a widget containing title and message to be displayed on the bar
static QgsMessageBarItem* createMessage( QWidget *widget, QWidget *parent = nullptr );
//! convenience method for pushing a message to the bar
void pushMessage( const QString &text, MessageLevel level = INFO, int duration = 0 ) { return pushMessage( QString::null, text, level, duration ); }
//! convenience method for pushing a message with title to the bar
void pushMessage( const QString &title, const QString &text, MessageLevel level = INFO, int duration = 0 );
QgsMessageBarItem *currentItem() { return mCurrentItem; }
signals:
//! emitted when a message widget is added to the bar
void widgetAdded( QgsMessageBarItem *item );
//! emitted when a message widget was removed from the bar
void widgetRemoved( QgsMessageBarItem *item );
public slots:
/** Remove the currently displayed widget from the bar and
* display the next in the stack if any or hide the bar.
* @return true if the widget was removed, false otherwise
*/
bool popWidget();
/** Remove all items from the bar's widget list
* @return true if all items were removed, false otherwise
*/
bool clearWidgets();
/**
* Pushes a success message with default timeout to the message bar
* @param title title string for message
* @param message The message to be displayed
* @note added in 2.8
*/
void pushSuccess( const QString& title, const QString& message );
/**
* Pushes a information message with default timeout to the message bar
* @param title title string for message
* @param message The message to be displayed
* @note added in 2.8
*/
void pushInfo( const QString& title, const QString& message );
/**
* Pushes a warning with default timeout to the message bar
* @param title title string for message
* @param message The message to be displayed
* @note added in 2.8
*/
void pushWarning( const QString& title, const QString& message );
/**
* Pushes a critical warning with default timeout to the message bar
* @param title title string for message
* @param message The message to be displayed
* @note added in 2.8
*/
void pushCritical( const QString& title, const QString& message );
protected:
void mousePressEvent( QMouseEvent * e ) override;
private:
void popItem( QgsMessageBarItem *item );
void showItem( QgsMessageBarItem *item );
QgsMessageBarItem *mCurrentItem;
QList<QgsMessageBarItem *> mItems;
QMenu *mCloseMenu;
QToolButton *mCloseBtn;
QGridLayout *mLayout;
QLabel *mItemCount;
QAction *mActionCloseAll;
QTimer *mCountdownTimer;
QProgressBar *mCountProgress;
QString mCountStyleSheet;
private slots:
//! updates count of items in widget list
void updateItemCount();
//! updates the countdown for widgets that have a timeout duration
void updateCountdown();
void resetCountdown();
};
#endif
|