File: application.h

package info (click to toggle)
cppcheck 2.17.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 25,384 kB
  • sloc: cpp: 263,341; python: 19,737; ansic: 7,953; sh: 1,018; makefile: 996; xml: 994; cs: 291
file content (114 lines) | stat: -rw-r--r-- 3,067 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/* -*- C++ -*-
 * Cppcheck - A tool for static C/C++ code analysis
 * Copyright (C) 2007-2024 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 APPLICATION_H
#define APPLICATION_H

#include <QString>

/**
 * @brief A class containing information of the application to execute.
 *
 * Each application has a name and a path. Name is displayed to the user
 * and has no other meaning. It isn't used to start the application.
 * Path contains the full path to the application containing the executable name.
 * Parameters contains the command line arguments for the executable.
 *
 * User can also specify certain predefined strings to parameters. These strings
 * will be replaced with appropriate values concerning the error. Strings are:
 * (file) - Filename containing the error
 * (line) - Line number containing the error
 * (message) - Error message
 * (severity) - Error severity
 *
 * Example opening a file with Kate and make Kate scroll to the correct line.
 * Executable: kate
 * Parameters: -l(line) (file)
 */
class Application {
public:
    Application() = default;
    Application(QString name, QString path, QString params);

    /**
     * @brief Get application name.
     * @return Application name.
     */
    const QString& getName() const {
        return mName;
    }

    /**
     * @brief Get application path.
     * @return Application path.
     */
    const QString& getPath() const {
        return mPath;
    }

    /**
     * @brief Get application command line parameters.
     * @return Application command line parameters.
     */
    const QString& getParameters() const {
        return mParameters;
    }

    /**
     * @brief Set application name.
     * @param name Application name.
     */
    void setName(const QString &name) {
        mName = name;
    }

    /**
     * @brief Set application path.
     * @param path Application path.
     */
    void setPath(const QString &path) {
        mPath = path;
    }

    /**
     * @brief Set application command line parameters.
     * @param parameters Application command line parameters.
     */
    void setParameters(const QString &parameters) {
        mParameters = parameters;
    }

private:

    /**
     * @brief Application's name
     */
    QString mName;

    /**
     * @brief Application's path
     */
    QString mPath;

    /**
     * @brief Application's parameters
     */
    QString mParameters;
};

#endif // APPLICATION_H