cppcheck/gui/applicationlist.h

140 lines
3.4 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
2023-06-21 16:41:22 +02:00
* Copyright (C) 2007-2023 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 APPLICATIONLIST_H
#define APPLICATIONLIST_H
#include "application.h"
#include <QList>
2022-02-02 16:17:28 +01:00
#include <QObject>
#include <QString>
2022-02-02 16:17:28 +01:00
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief List of applications user has specified to open errors with.
*/
2011-10-13 20:53:06 +02:00
class ApplicationList : public QObject {
Q_OBJECT
public:
explicit ApplicationList(QObject *parent = nullptr);
~ApplicationList() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Load all applications
*
* @return true if loading succeeded, false if there is problem with
* application list. Most probably because of older version settings need
* to be upgraded.
*/
2017-07-28 05:18:43 +02:00
bool loadSettings();
/**
2021-08-07 20:51:18 +02:00
* @brief Save all applications
*/
2017-07-28 05:18:43 +02:00
void saveSettings() const;
/**
2021-08-07 20:51:18 +02:00
* @brief Get the amount of applications in the list
* @return The count of applications
*/
2017-07-28 05:18:43 +02:00
int getApplicationCount() const;
/**
2021-08-07 20:51:18 +02:00
* @brief Get specific application's name
*
* @param index Index of the application whose name to get
* @return Name of the application
*/
2017-07-28 05:18:43 +02:00
const Application& getApplication(const int index) const;
Application& getApplication(const int index);
/**
2021-08-07 20:51:18 +02:00
* @brief Return the default application.
* @return Index of the default application.
*/
2017-07-28 05:18:43 +02:00
int getDefaultApplication() const {
return mDefaultApplicationIndex;
}
/**
2021-08-07 20:51:18 +02:00
* @brief Add a new application
*
* @param app Application to add.
*/
2017-07-28 05:18:43 +02:00
void addApplication(const Application &app);
/**
2021-08-07 20:51:18 +02:00
* @brief Remove an application from the list
*
* @param index Index of the application to remove.
*/
2017-07-28 05:18:43 +02:00
void removeApplication(const int index);
/**
2021-08-07 20:51:18 +02:00
* @brief Set application as default application.
* @param index Index of the application to make the default one
*/
2017-07-28 05:18:43 +02:00
void setDefault(const int index);
/**
2021-08-07 20:51:18 +02:00
* @brief Remove all applications from this list and copy all applications from
* list given as a parameter.
* @param list Copying source
*/
2017-07-28 05:18:43 +02:00
void copy(const ApplicationList *list);
protected:
/**
2021-08-07 20:51:18 +02:00
* @brief Clear the list
*
*/
2017-07-28 05:18:43 +02:00
void clear();
#ifdef _WIN32
/**
2021-08-07 20:51:18 +02:00
* @brief Find editor used by default in Windows.
* Check if Notepad++ is installed and use it. If not, use Notepad.
*/
2017-07-28 05:18:43 +02:00
bool findDefaultWindowsEditor();
#endif
private:
bool checkAndAddApplication(const QString& appPath, const QString& name, const QString& parameters);
/**
2021-08-07 20:51:18 +02:00
* @brief List of applications
*
*/
QList<Application> mApplications;
/**
2021-08-07 20:51:18 +02:00
* @brief Index of the default application.
*
*/
int mDefaultApplicationIndex;
};
/// @}
#endif // APPLICATIONLIST_H