File: CommandLinePluginInterface.h

package info (click to toggle)
veyon 4.5.3%2Brepack1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 10,884 kB
  • sloc: cpp: 44,678; ansic: 6,852; python: 218; makefile: 200; sh: 47
file content (61 lines) | stat: -rw-r--r-- 1,745 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
/*
 * CommandLinePluginInterface.h - interface class for command line plugins
 *
 * Copyright (c) 2017-2021 Tobias Junghans <tobydox@veyon.io>
 *
 * This file is part of Veyon - https://veyon.io
 *
 * 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.
 *
 * 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 (see COPYING); if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */

#pragma once

#include "PluginInterface.h"

// clazy:excludeall=copyable-polymorphic

class VEYON_CORE_EXPORT CommandLinePluginInterface
{
	Q_GADGET
public:
	enum RunResult
	{
		Unknown,
		Successful,
		Failed,
		InvalidArguments,
		NotEnoughArguments,
		InvalidCommand,
		NotLicensed,
		NoResult,
		RunResultCount
	} ;

	Q_ENUM(RunResult)

	virtual QString commandLineModuleName() const = 0;
	virtual QString commandLineModuleHelp() const = 0;
	virtual QStringList commands() const = 0;
	virtual QString commandHelp( const QString& command ) const = 0;

};

using CommandLinePluginInterfaceList = QList<CommandLinePluginInterface *>;

#define CommandLinePluginInterface_iid "io.veyon.Veyon.Plugins.CommandLinePluginInterface"

Q_DECLARE_INTERFACE(CommandLinePluginInterface, CommandLinePluginInterface_iid)