-
Notifications
You must be signed in to change notification settings - Fork 44
/
IPlugin.cs
49 lines (42 loc) · 1.58 KB
/
IPlugin.cs
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
using System.Windows.Forms;
namespace Nikse.SubtitleEdit.PluginLogic
{
public interface IPlugin
{
/// <summary>
/// Name of the plug-in
/// </summary>
string Name { get; }
/// <summary>
/// Text used in Subtitle Edit menu
/// </summary>
string Text { get; }
/// <summary>
/// Version number of plugin
/// </summary>
decimal Version { get; }
/// <summary>
/// Description of what plugin does
/// </summary>
string Description { get; }
/// <summary>
/// Can be one of these: file, tool, sync, translate, spellcheck
/// </summary>
string ActionType { get; }
/// <summary>
/// Shortcut used to active plugin - e.g. Control+Shift+F9
/// </summary>
string Shortcut { get; }
/// <summary>
/// This action of callsed when Subtitle Edit calls plugin
/// </summary>
/// <param name="parentForm">Main form in Subtitle Edit</param>
/// <param name="subtitle">SubRip text</param>
/// <param name="frameRate">Current frame rate</param>
/// <param name="subtitleFileName">Current subtitle file name</param>
/// <param name="videoFileName">Current video file name</param>
/// <param name="rawText">Subtitle raw format</param>
/// <returns>Dialog</returns>
string DoAction(Form parentForm, string subtitle, double frameRate, string listViewLineSeparatorString, string subtitleFileName, string videoFileName, string rawText);
}
}