wizard.json

{
    "version": 1,
    "supportedProjectTypes": [ "CMakeProjectManager.CMakeProject" ],
    "id": "An rqt plugin",
    "category": "I.Projects",
    "trDescription": "Creates a simple C++ rqt plugin project which will contain an empty QWidget.",
    "trDisplayName": "rqt plugin",
    "trDisplayCategory": "Non-Qt Project",
    "icon": "ros_icon.png",
    "enabled": "%{JS: [ %{Plugins} ].indexOf('CppEditor') >= 0 && ([ %{Plugins} ].indexOf('QmakeProjectManager') >= 0 || [ %{Plugins} ].indexOf('QbsProjectManager') >= 0 || [ %{Plugins} ].indexOf('CMakeProjectManager') >= 0)}",
    "options":
    [
        { "key": "TargetPath", "value": "%{Path}" },
        { "key": "Plugin", "value": "%{PluginName}" },
        { "key": "License", "value": "%{LicenseEdit}" },
        { "key": "CN", "value": "%{ClassName}" },
        { "key": "FN", "value": "%{FriendlyName}" },
        { "key": "GUARD", "value": "%{JS: Cpp.headerGuard('%{PluginName}')}" }
    ],
    "pages":
    [
        {
            "trDisplayName": "Project Location",
            "trShortTitle": "Location",
            "typeId": "Project"
        },
        {
            "trDisplayName": "Plugin Information",
            "trShortTitle": "Plugin info",
            "typeId": "Fields",
            "data": [
                {
                    "name": "PluginName",
                    "trDisplayName": "Plugin name:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": {
                        "trPlaceholder": "Must start with rqt_ and could contain only lower case letters, numbers and _",
                        "trText": "rqt_test_plugin",
                        "validator": "rqt_[a-z][a-z_0-9]*"
                    }
                },
                {
                    "name": "ClassName",
                    "trDisplayName": "Class name:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": {
                        "trPlaceholder": "Name of the main class of the plugin",
                        "validator": "[a-zA-Z][a-zA-Z0-9_]*",
                        "trText": "TestPlugin"
                    }
                },
                {
                    "name": "FriendlyName",
                    "trDisplayName": "Friendly name:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": {
                        "trPlaceholder": "This will appear in the rqt menu for e.g.",
                        "validator": "^(?!\s*$).+",
                        "trText": "Test plugin"
                    }
                },
                {
                    "name": "MaintainerName",
                    "trDisplayName": "Maintainer name:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": { 
                        "trText": "Jane Doe",
                        "validator": "^(?!\s*$).+"
                    }
                },
                {
                    "name": "MaintainerEmail",
                    "trDisplayName": "Maintainer e-mail address:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": {
                        "validator": "([^@]+@[^\.]+\..+)",
                        "trText": "jane.doe@example.com"
                    }
                },
                {
                    "name": "LicenseEdit",
                    "trDisplayName": "License:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": {
                        "trPlaceholder": "Commonly used license strings: BSD, MIT, Boost Software License, GPLv2, GPLv3, LGPLv2.1, LGPLv3...",
                        "validator": "^(?!\s*$).+",
                        "trText": "LGPLv3"
                    }
                },
                {
                    "name": "Group",
                    "trDisplayName": "Plugin group:",
                    "mandatory": true,
                    "type": "LineEdit",
                    "data": {
                        "trPlaceholder": "rqt plugins",
                        "trText": "rqt plugins"
                    }
                },
                {
                    "name": "PluginDescription",
                    "trDisplayName": "Description:",
                    "mandatory": false,
                    "type": "TextEdit"
                }
            ]
        }
    ],
    "generators":
    [
        {
            "typeId": "File",
            "data":
            [
                {
                    "source": "plugin.creator",
                    "target": "%{ProjectName}.creator",
                    "openAsProject": true
                },
                {
                    "source": "plugin.includes",
                    "target": "%{ProjectName}.includes"
                },
                {
                    "source": "plugin.config",
                    "target": "%{ProjectName}.config"
                },
                {
                    "source": "plugin.files",
                    "target": "%{ProjectName}.files"
                },
                {
                    "source": "package.xml",
                    "target": "package.xml"
                },
                {
                    "source": "plugin.xml",
                    "target": "plugin.xml"
                },
                {
                    "source": "CMakeLists.txt",
                    "target": "CMakeLists.txt"
                },
                {
                    "source": "rqt_plugin.h",
                    "target": "include/%{Plugin}/%{Plugin}.h"
                },
                {
                    "source": "rqt_plugin_widget.h",
                    "target": "include/%{Plugin}/%{Plugin}_widget.h"
                },
                {
                    "source": "rqt_plugin.cpp",
                    "target": "src/%{Plugin}/%{Plugin}.cpp"
                },
                {
                    "source": "rqt_plugin_widget.cpp",
                    "target": "src/%{Plugin}/%{Plugin}_widget.cpp"
                },
                {
                    "source": "rqt_plugin_widget.ui",
                    "target": "ui/%{Plugin}/%{Plugin}_widget.ui"
                }
            ]
        }
    ]
}