Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.PluginInfrastructure/PluginManagerActionEventArgs.cs @ 1189

Last change on this file since 1189 was 1189, checked in by vdorfer, 15 years ago

Created parts of the API documentation for HeuristicLab.PluginInfrastructure namespace (#331)

File size: 2.7 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Text;
25
26namespace HeuristicLab.PluginInfrastructure {
27  /// <summary>
28  /// Enum for all possible actions the plugin manager can execute.
29  /// </summary>
30  public enum PluginManagerAction { Initializing, InitializingPlugin, InitializedPlugin, Initialized, Starting }
31  /// <summary>
32  /// Event handler for all action events of the plugin manager.
33  /// </summary>
34  /// <param name="sender">The sender of the action event.</param>
35  /// <param name="e">The event arguments.</param>
36  public delegate void PluginManagerActionEventHandler(object sender, PluginManagerActionEventArgs e);
37
38  // this class must be serializable because EventArgs are transmitted over AppDomain boundaries
39  /// <summary>
40  /// Class for the event arguments of plugin manager action events.
41  /// </summary>
42  [Serializable]
43  public class PluginManagerActionEventArgs {
44    private PluginManagerAction action;
45    /// <summary>
46    /// Gets or sets the action that has been performed.
47    /// </summary>
48    public PluginManagerAction Action {
49      get { return action; }
50      set { this.action = value; }
51    }
52    private string id;
53    /// <summary>
54    /// Gets or sets the id of the action event arguments.
55    /// </summary>
56    public string Id {
57      get { return id; }
58      set { id = value; }
59    }
60
61    /// <summary>
62    /// Initializes a new instance of <see cref="PluginManagerActionEventArgs"/> with the given
63    /// <paramref name="id"/> and <paramref name="action"/>.
64    /// </summary>
65    /// <param name="id">The id of the action event arguments.</param>
66    /// <param name="action">The action of the plugin manager.</param>
67    public PluginManagerActionEventArgs(string id, PluginManagerAction action) {
68      this.Id = id;
69      this.Action = action;
70    }
71  }
72}
Note: See TracBrowser for help on using the repository browser.