File: script-common.h

package info (click to toggle)
kig 4%3A25.04.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 18,892 kB
  • sloc: cpp: 41,461; xml: 843; python: 486; perl: 23; sh: 17; makefile: 3
file content (53 lines) | stat: -rw-r--r-- 1,653 bytes parent folder | download | duplicates (2)
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
// SPDX-FileCopyrightText: 2004 Pino Toscano <toscano.pino@tiscali.it>

// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#include <algorithm>
#include <list>

#include "../objects/object_holder.h"

class QString;

class ScriptType
{
public:
    /**
     * This enum represents all the script language types actually in
     * Kig. The first type ( Unknown ) can be used if we don't want
     * particular tunings for a script language.
     */
    enum Type { Unknown = 0, Python = 1 };
    /**
     * Returns an i18n'ed statement like 'Now fill in the code:' with
     * the name of the script language.
     */
    static QString fillCodeStatement(ScriptType::Type type);
    /**
     * Returns a template code for a script language.
     */
    static QString templateCode(ScriptType::Type type, std::list<ObjectHolder *> args);
    /**
     * Update the existing script function definition with the new argument selection
     */
    static void updateCodeFunction(ScriptType::Type type, std::list<ObjectHolder *> args, QString &script);
    /**
     * Return the function definition for the script
     */
    static QString scriptFunctionDefinition(ScriptType::Type type, std::list<ObjectHolder *> args);
    /**
     * Returns the icon's name for a script language.
     */
    static const char *icon(ScriptType::Type type);
    /**
     * Returns the Kate highlight stytle name for a script language.
     */
    static QString highlightStyle(ScriptType::Type type);
    /**
     * Converts an int to a ScriptType::Type. Useful when reading script
     * types from files.
     */
    static ScriptType::Type intToType(int type);
};