cppcheck/gui/resultsview.h

228 lines
5.1 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2011 Daniel Marjamäki and Cppcheck team.
*
* 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 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef RESULTSVIEW_H
#define RESULTSVIEW_H
#include <QWidget>
#include "../lib/errorlogger.h"
2009-03-22 18:39:44 +01:00
#include "common.h"
#include "report.h"
#include "ui_resultsview.h"
class ErrorItem;
2010-11-24 16:39:53 +01:00
class ApplicationList;
2010-11-22 23:37:29 +01:00
class QModelIndex;
class QSettings;
class CheckStatistics;
/// @addtogroup GUI
/// @{
/**
* @brief Widget to show cppcheck progressbar and result
*
*/
class ResultsView : public QWidget
{
Q_OBJECT
public:
2009-03-22 18:39:44 +01:00
ResultsView(QWidget * parent = 0);
void Initialize(QSettings *settings, ApplicationList *list);
virtual ~ResultsView();
/**
* @brief Function to show/hide certain type of errors
* Refreshes the tree.
*
* @param type Type of error to show/hide
2010-03-14 18:18:17 +01:00
* @param show Should specified errors be shown (true) or hidden (false)
*/
2009-03-22 18:39:44 +01:00
void ShowResults(ShowTypes type, bool show);
/**
* @brief Clear results
*
*/
void Clear();
/**
* @brief Save results to a file
*
* @param filename Filename to save results to
* @param type Type of the report.
*/
void Save(const QString &filename, Report::Type type);
/**
* @brief Update tree settings
*
* @param showFullPath Show full path of files in the tree
* @param saveFullPath Save full path of files in reports
* @param saveAllErrors Save all visible errors
2010-03-14 18:18:17 +01:00
* @param showNoErrorsMessage Show "no errors"?
*/
void UpdateSettings(bool showFullPath,
bool saveFullPath,
bool saveAllErrors,
bool showNoErrorsMessage);
/**
* @brief Set the directory we are checking
*
* This is used to split error file path to relative if necessary
* @param dir Directory we are checking
*/
void SetCheckDirectory(const QString &dir);
/**
* @brief Inform the view that checking has started
*
* @param count Count of files to be checked.
*/
void CheckingStarted(int count);
/**
* @brief Inform the view that checking finished.
*
*/
void CheckingFinished();
/**
* @brief Do we have visible results to show?
*
* @return true if there is at least one warning/error to show.
*/
bool HasVisibleResults() const;
/**
* @brief Do we have results from check?
*
* @return true if there is at least one warning/error, hidden or visible.
*/
bool HasResults() const;
/**
* @brief Save View's settings
*
* @param settings program settings.
*/
void SaveSettings(QSettings *settings);
/**
* @brief Translate this view
*
*/
void Translate();
void DisableProgressbar();
/**
* @brief Read errors from report XML file.
* @param filename Report file to read.
*
*/
void ReadErrorsXml(const QString &filename);
/**
* @brief Return checking statistics.
* @param Pointer to checking statistics.
*
*/
CheckStatistics *GetStatistics() const
{
return mStatistics;
}
signals:
/**
* @brief Signal to be emitted when we have results
*
*/
void GotResults();
/**
* @brief Signal that results have been hidden or shown
*
* @param hidden true if there are some hidden results, or false if there are not
*/
void ResultsHidden(bool hidden);
public slots:
2009-06-01 23:49:15 +02:00
/**
* @brief Slot for updating the checking progress
*
* @param value Current progress value
*/
void Progress(int value);
/**
* @brief Slot for new error to be displayed
*
* @param item Error data
*/
void Error(const ErrorItem &item);
/**
* @brief Collapse all results in the result list.
*/
void CollapseAllResults();
/**
* @brief Expand all results in the result list.
*/
void ExpandAllResults();
2010-11-21 19:55:34 +01:00
/**
* @brief Show hidden results in the result list.
*/
void ShowHiddenResults();
/**
* @brief Update detailed message when selected item is changed.
*
* @param index Position of new selected item.
*/
void UpdateDetails(const QModelIndex &index);
protected:
/**
* @brief Have any errors been found
*/
bool mErrorsFound;
/**
2010-12-15 18:45:53 +01:00
* @brief Should we show a "No errors found dialog" every time no errors were found?
*/
bool mShowNoErrorsMessage;
Ui::ResultsView mUI;
CheckStatistics *mStatistics;
private:
};
/// @}
#endif // RESULTSVIEW_H