GUI: Formatting comments
This commit is contained in:
Daniel Marjamäki
parent
0e78dd5eac
commit
143e7bf8b1
266
gui/mainwindow.h
266
gui/mainwindow.h
|
|
@ -42,9 +42,9 @@ class QAction;
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Main window for cppcheck-gui
|
* @brief Main window for cppcheck-gui
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
class MainWindow : public QMainWindow {
|
class MainWindow : public QMainWindow {
|
||||||
Q_OBJECT
|
Q_OBJECT
|
||||||
public:
|
public:
|
||||||
|
|
@ -72,16 +72,10 @@ public:
|
||||||
|
|
||||||
public slots:
|
public slots:
|
||||||
|
|
||||||
/**
|
/** @brief Slot for check files menu item */
|
||||||
* @brief Slot for check files menu item
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void CheckFiles();
|
void CheckFiles();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to recheck all files */
|
||||||
* @brief Slot to recheck all files
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ReCheckAll();
|
void ReCheckAll();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -90,22 +84,13 @@ public slots:
|
||||||
*/
|
*/
|
||||||
void PerformSelectedFilesCheck(QStringList selectedFilesList);
|
void PerformSelectedFilesCheck(QStringList selectedFilesList);
|
||||||
|
|
||||||
/**
|
/** @brief Slot to recheck modified files */
|
||||||
* @brief Slot to recheck modified files
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ReCheckModified();
|
void ReCheckModified();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to clear all search results */
|
||||||
* @brief Slot to clear all search results
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ClearResults();
|
void ClearResults();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to open XML report file */
|
||||||
* @brief Slot to open XML report file
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void OpenResults();
|
void OpenResults();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -144,185 +129,101 @@ public slots:
|
||||||
*/
|
*/
|
||||||
void ShowInformation(bool checked);
|
void ShowInformation(bool checked);
|
||||||
|
|
||||||
/**
|
/** @brief Slot to check all "Show errors" menu items */
|
||||||
* @brief Slot to check all "Show errors" menu items
|
|
||||||
*/
|
|
||||||
void CheckAll();
|
void CheckAll();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to uncheck all "Show errors" menu items */
|
||||||
* @brief Slot to uncheck all "Show errors" menu items
|
|
||||||
*/
|
|
||||||
void UncheckAll();
|
void UncheckAll();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for check directory menu item */
|
||||||
* @brief Slot for check directory menu item
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void CheckDirectory();
|
void CheckDirectory();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to open program's settings dialog */
|
||||||
* @brief Slot to open program's settings dialog
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ProgramSettings();
|
void ProgramSettings();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to open program's about dialog */
|
||||||
* @brief Slot to open program's about dialog
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void About();
|
void About();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to to show license text */
|
||||||
* @brief Slot to to show license text
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ShowLicense();
|
void ShowLicense();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to to show authors list */
|
||||||
* @brief Slot to to show authors list
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ShowAuthors();
|
void ShowAuthors();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to save results */
|
||||||
* @brief Slot to stop processing files
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void Save();
|
void Save();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to create new project file */
|
||||||
* @brief Slot to create new project file
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void NewProjectFile();
|
void NewProjectFile();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to open project file and start checking contained paths. */
|
||||||
* @brief Slot to open project file and start checking contained paths.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void OpenProjectFile();
|
void OpenProjectFile();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to show scratchpad. */
|
||||||
* @brief Slot to open project file and start checking contained paths.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ShowScratchpad();
|
void ShowScratchpad();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to close open project file. */
|
||||||
* @brief Slot to close open project file.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void CloseProjectFile();
|
void CloseProjectFile();
|
||||||
|
|
||||||
/**
|
/** @brief Slot to edit project file. */
|
||||||
* @brief Slot to edit project file.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void EditProjectFile();
|
void EditProjectFile();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for showing the log view. */
|
||||||
* @brief Slot for showing the log view.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ShowLogView();
|
void ShowLogView();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for showing the scan and project statistics. */
|
||||||
* @brief Slot for showing the scan and project statistics.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ShowStatistics();
|
void ShowStatistics();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for showing the library editor */
|
||||||
* @brief Slot for showing the library editor
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ShowLibraryEditor();
|
void ShowLibraryEditor();
|
||||||
|
|
||||||
protected slots:
|
protected slots:
|
||||||
|
|
||||||
/**
|
/** @brief Slot for checkthread's done signal */
|
||||||
* @brief Slot for checkthread's done signal
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void CheckDone();
|
void CheckDone();
|
||||||
|
|
||||||
/**
|
/** @brief Lock down UI while checking */
|
||||||
* @brief Lock down UI while checking
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void CheckLockDownUI();
|
void CheckLockDownUI();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for enabling save and clear button */
|
||||||
* @brief Slot for enabling save and clear button
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ResultsAdded();
|
void ResultsAdded();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for showing/hiding standard toolbar */
|
||||||
* @brief Slot for showing/hiding standard toolbar
|
|
||||||
*/
|
|
||||||
void ToggleMainToolBar();
|
void ToggleMainToolBar();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for showing/hiding Categories toolbar */
|
||||||
* @brief Slot for showing/hiding Categories toolbar
|
|
||||||
*/
|
|
||||||
void ToggleViewToolBar();
|
void ToggleViewToolBar();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for showing/hiding Filter toolbar */
|
||||||
* @brief Slot for showing/hiding Filter toolbar
|
|
||||||
*/
|
|
||||||
void ToggleFilterToolBar();
|
void ToggleFilterToolBar();
|
||||||
|
|
||||||
/**
|
/** @brief Slot for updating View-menu before it is shown. */
|
||||||
* @brief Slot for updating View-menu before it is shown.
|
|
||||||
*/
|
|
||||||
void AboutToShowViewMenu();
|
void AboutToShowViewMenu();
|
||||||
|
|
||||||
/**
|
/** @brief Slot when stop checking button is pressed */
|
||||||
* @brief Slot when stop checking button is pressed
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void StopChecking();
|
void StopChecking();
|
||||||
|
|
||||||
/**
|
/** @brief Open help file contents */
|
||||||
* @brief Open help file contents
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void OpenHelpContents();
|
void OpenHelpContents();
|
||||||
|
|
||||||
/**
|
/** @brief Add new line to log. */
|
||||||
* @brief Add new line to log.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void Log(const QString &logline);
|
void Log(const QString &logline);
|
||||||
|
|
||||||
/**
|
/** @brief Handle new debug error. */
|
||||||
* @brief Handle new debug error.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void DebugError(const ErrorItem &item);
|
void DebugError(const ErrorItem &item);
|
||||||
|
|
||||||
/**
|
/** @brief Filters the results in the result list. */
|
||||||
* @brief Filters the results in the result list.
|
|
||||||
*/
|
|
||||||
void FilterResults();
|
void FilterResults();
|
||||||
|
|
||||||
/**
|
/** @brief Opens recently opened project file. */
|
||||||
* @brief Opens recently opened project file.
|
|
||||||
*/
|
|
||||||
void OpenRecentProject();
|
void OpenRecentProject();
|
||||||
|
|
||||||
/**
|
/** @brief Selects the platform as checked platform. */
|
||||||
* @brief Selects the platform as checked platform.
|
|
||||||
*/
|
|
||||||
void SelectPlatform();
|
void SelectPlatform();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
|
||||||
/**
|
/** @brief Rechecks files */
|
||||||
* @brief Rechecks files
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void ReCheck(bool all);
|
void ReCheck(bool all);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -344,9 +245,7 @@ private:
|
||||||
*/
|
*/
|
||||||
void SetLanguage(const QString &code);
|
void SetLanguage(const QString &code);
|
||||||
|
|
||||||
/**
|
/** @brief Event coming when application is about to close. */
|
||||||
* @brief Event coming when application is about to close.
|
|
||||||
*/
|
|
||||||
virtual void closeEvent(QCloseEvent *event);
|
virtual void closeEvent(QCloseEvent *event);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -355,10 +254,7 @@ private:
|
||||||
*/
|
*/
|
||||||
void ToggleAllChecked(bool checked);
|
void ToggleAllChecked(bool checked);
|
||||||
|
|
||||||
/**
|
/** @brief Helper function to enable/disable all check,recheck buttons */
|
||||||
* @brief Helper function to enable/disable all check,recheck buttons
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void EnableCheckButtons(bool enable);
|
void EnableCheckButtons(bool enable);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -373,7 +269,6 @@ private:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Check project
|
* @brief Check project
|
||||||
*
|
|
||||||
* @param p imported project
|
* @param p imported project
|
||||||
*/
|
*/
|
||||||
void DoCheckProject(ImportProject p);
|
void DoCheckProject(ImportProject p);
|
||||||
|
|
@ -392,16 +287,10 @@ private:
|
||||||
*/
|
*/
|
||||||
Settings GetCppcheckSettings();
|
Settings GetCppcheckSettings();
|
||||||
|
|
||||||
/**
|
/** @brief Load program settings */
|
||||||
* @brief Load program settings
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void LoadSettings();
|
void LoadSettings();
|
||||||
|
|
||||||
/**
|
/** @brief Save program settings */
|
||||||
* @brief Save program settings
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
void SaveSettings() const;
|
void SaveSettings() const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -410,9 +299,7 @@ private:
|
||||||
*/
|
*/
|
||||||
void FormatAndSetTitle(const QString &text = QString());
|
void FormatAndSetTitle(const QString &text = QString());
|
||||||
|
|
||||||
/**
|
/** @brief Show help contents */
|
||||||
* @brief Show help contents
|
|
||||||
*/
|
|
||||||
void OpenOnlineHelp();
|
void OpenOnlineHelp();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -495,79 +382,46 @@ private:
|
||||||
*/
|
*/
|
||||||
void RemoveProjectMRU(const QString &project);
|
void RemoveProjectMRU(const QString &project);
|
||||||
|
|
||||||
/**
|
/** @brief Program settings */
|
||||||
* @brief Program settings
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
QSettings *mSettings;
|
QSettings *mSettings;
|
||||||
|
|
||||||
/**
|
/** @brief Thread to check files */
|
||||||
* @brief Thread to check files
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
ThreadHandler *mThread;
|
ThreadHandler *mThread;
|
||||||
|
|
||||||
/**
|
/** @brief List of user defined applications to open errors with */
|
||||||
* @brief List of user defined applications to open errors with
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
ApplicationList *mApplications;
|
ApplicationList *mApplications;
|
||||||
|
|
||||||
/**
|
/** @brief Class to handle translation changes */
|
||||||
* @brief Class to handle translation changes
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
TranslationHandler *mTranslation;
|
TranslationHandler *mTranslation;
|
||||||
|
|
||||||
/**
|
/** @brief Class holding all UI components */
|
||||||
* @brief Class holding all UI components
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
Ui::MainWindow mUI;
|
Ui::MainWindow mUI;
|
||||||
|
|
||||||
/**
|
/** @brief Current checked directory. */
|
||||||
* @brief Current checked directory.
|
|
||||||
*/
|
|
||||||
QString mCurrentDirectory;
|
QString mCurrentDirectory;
|
||||||
|
|
||||||
/**
|
/** @brief Log view. */
|
||||||
* @brief Log view.
|
|
||||||
*/
|
|
||||||
LogView *mLogView;
|
LogView *mLogView;
|
||||||
|
|
||||||
/**
|
/** @brief Scratchpad. */
|
||||||
* @brief Scratchpad.
|
|
||||||
*/
|
|
||||||
ScratchPad* mScratchPad;
|
ScratchPad* mScratchPad;
|
||||||
|
|
||||||
/**
|
/** @brief Project (file). */
|
||||||
* @brief Project (file).
|
|
||||||
*/
|
|
||||||
Project *mProject;
|
Project *mProject;
|
||||||
|
|
||||||
/**
|
/** @brief Filter field in the Filter toolbar. */
|
||||||
* @brief Filter field in the Filter toolbar.
|
|
||||||
*/
|
|
||||||
QLineEdit* mLineEditFilter;
|
QLineEdit* mLineEditFilter;
|
||||||
|
|
||||||
/**
|
/** @brief Timer to delay filtering while typing. */
|
||||||
* @brief Timer to delay filtering while typing.
|
|
||||||
*/
|
|
||||||
QTimer* mFilterTimer;
|
QTimer* mFilterTimer;
|
||||||
|
|
||||||
/**
|
/** @brief GUI actions for selecting the checked platform. */
|
||||||
* @brief GUI actions for selecting the checked platform.
|
|
||||||
*/
|
|
||||||
QActionGroup *mPlatformActions;
|
QActionGroup *mPlatformActions;
|
||||||
|
|
||||||
/**
|
/** @brief GUI actions for selecting the coding standard. */
|
||||||
* @brief GUI actions for selecting the coding standard.
|
|
||||||
*/
|
|
||||||
QActionGroup *mCStandardActions, *mCppStandardActions;
|
QActionGroup *mCStandardActions, *mCppStandardActions;
|
||||||
|
|
||||||
/**
|
/** @brief GUI actions for selecting language. */
|
||||||
* @brief GUI actions for selecting language.
|
|
||||||
*/
|
|
||||||
QActionGroup *mSelectLanguageActions;
|
QActionGroup *mSelectLanguageActions;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -577,9 +431,7 @@ private:
|
||||||
*/
|
*/
|
||||||
bool mExiting;
|
bool mExiting;
|
||||||
|
|
||||||
/**
|
/** @brief Set to true in case of loading log file. */
|
||||||
* @brief Set to true in case of loading log file.
|
|
||||||
*/
|
|
||||||
bool mIsLogfileLoaded;
|
bool mIsLogfileLoaded;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue