QGIS/src/gui/qgsmessageviewer.h
timlinux e8b9f2d024 Updates for doxygen for gui module
git-svn-id: http://svn.osgeo.org/qgis/trunk@9221 c8812cc2-4d05-0410-92ff-de0c093fc19c
2008-08-30 23:38:26 +00:00

76 lines
2.7 KiB
C++

/***************************************************************************
qgsmessageviewer.h - description
-------------------
begin : Wed Jun 4 2003
copyright : (C) 2002 by Gary E.Sherman
email : sherman at mrcc.com
***************************************************************************/
/***************************************************************************
* *
* 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. *
* *
***************************************************************************/
/* $Id$ */
#ifndef QGSMESSAGEVIEWER_H
#define QGSMESSAGEVIEWER_H
#include <ui_qgsmessageviewer.h>
#include <qgisgui.h>
#include "qgsmessageoutput.h"
#include <QString>
/** \ingroup gui
* A generic message view for displaying QGIS messages.
*/
class GUI_EXPORT QgsMessageViewer: public QDialog, public QgsMessageOutput, private Ui::QgsMessageViewer
{
Q_OBJECT
public:
QgsMessageViewer( QWidget *parent = 0, Qt::WFlags fl = QgisGui::ModalDialogFlags );
~QgsMessageViewer();
virtual void setMessage( const QString& message, MessageType msgType );
virtual void appendMessage( const QString& message );
virtual void showMessage( bool blocking = true );
virtual void setTitle( const QString& title );
// Call one of the setMessage...() functions first.
// Subsequent calls to appendMessage use the format as determined
// by the call to setMessage...()
// Treats the given text as html.
void setMessageAsHtml( const QString& msg );
// Treats the given text as plain text
void setMessageAsPlainText( const QString& msg );
// A checkbox that can be used for something like
// "don't show this message again"
void setCheckBoxText( const QString& text );
// Make the check box visible/invisible
void setCheckBoxVisible( bool visible );
// Sets the check state
void setCheckBoxState( Qt::CheckState state );
// Get checkbox state
Qt::CheckState checkBoxState();
// Specifies a QSettings tag to store/retrieve the checkbox
// state to/from. Use an empty QString to disable this feature.
void setCheckBoxQSettingsLabel( QString label );
private slots:
void on_checkBox_toggled( bool );
private:
QString mCheckBoxQSettingsLabel;
};
#endif