Skip to content

Commit

Permalink
Doxymentation for QgsMessageBar
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed Jun 2, 2015
1 parent f7489e0 commit afa389f
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions src/gui/qgsmessagebar.h
Expand Up @@ -55,9 +55,12 @@ class GUI_EXPORT QgsMessageBar: public QFrame
QgsMessageBar( QWidget *parent = 0 );
~QgsMessageBar();

/*! display a message item on the bar after hiding the currently visible one
* and putting it in a stack.
* @param item item to display
/**
* 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 );

Expand Down Expand Up @@ -97,7 +100,7 @@ class GUI_EXPORT QgsMessageBar: public QFrame

public slots:
/*! remove the currently displayed widget from the bar and
* display the next in the stack if any or hide the bar
* display the next in the stack if any or hide the bar.
* @return true if the widget was removed, false otherwise
*/
bool popWidget();
Expand All @@ -108,15 +111,15 @@ class GUI_EXPORT QgsMessageBar: public QFrame
bool clearWidgets();

/**
* Pushes a warning with default timeout to the message bar
* 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 warning with default timeout to the message bar
* 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
Expand All @@ -132,7 +135,7 @@ class GUI_EXPORT QgsMessageBar: public QFrame
void pushWarning( const QString& title, const QString& message );

/**
* Pushes a warning with default timeout to the message bar
* 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
Expand Down

0 comments on commit afa389f

Please sign in to comment.