Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Problems.GrammaticalOptimization/SharpVectorCore/Events/IMutationNameEvent.cs @ 12762

Last change on this file since 12762 was 12762, checked in by aballeit, 9 years ago

#2283 GUI updates, Tree-chart, MCTS Version 2 (prune leaves)
File size: 4.7 KB
Line 
1using System;
2
3namespace SharpVectors.Dom.Events
4{
5  /// <summary>
6  /// The <see cref="IMutationNameEvent">IMutationNameEvent</see> interface
7  /// provides specific contextual information associated with Mutation
8  /// name event types.
9  /// </summary>
10  /// <remarks>
11  /// Note: To create an instance of the
12  /// <see cref="IMutationNameEvent">IMutationNameEvent</see> interface,
13  /// use the feature string <c>"MutationNameEvent"</c> as the value of the
14  /// input parameter used with the
15  /// <see cref="CreateEvent">CreateEvent</see> method of the
16  /// <see cref="IDocumentEvent">IDocumentEvent</see> interface.
17  /// </remarks>
18  public interface IMutationNameEvent
19  {
20    /// <summary>
21    /// The previous value of the
22    /// <see cref="RelatedNode">RelatedNode</see>'s namespace URI.
23    /// </summary>
24    string PrevNamespaceUri
25    {
26      get;
27    }
28   
29    /// <summary>
30    /// The previous value of the
31    /// <see cref="RelatedNode">RelatedNode</see>'s nodeName.
32    /// </summary>
33    string PrevNodeName
34    {
35      get;
36    }
37   
38    /// <summary>
39    /// The <see cref="InitMutationNameEvent">InitMutationNameEvent</see>
40    /// method is used to initialize the value of a
41    /// <see cref="IMutationNameEvent">IMutationNameEvent</see> created
42    /// using the
43    /// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
44    /// method. This method may only be called before the
45    /// <see cref="IMutationNameEvent">IMutationNameEvent</see> has been
46    /// dispatched via the
47    /// <see cref="IEventTarget.DispatchEvent">IEventTarget.DispatchEvent</see>
48    /// method, though it may be called multiple times during that phase
49    /// if necessary. If called multiple times, the final invocation
50    /// takes precedence.
51    /// </summary>
52    /// <param name="typeArg">
53    /// Specifies the event type.
54    /// </param>
55    /// <param name="canBubbleArg">
56    /// Specifies whether or not the event can bubble.
57    /// </param>
58    /// <param name="cancelableArg">
59    /// Specifies whether or not the event's default action can be prevented.
60    /// </param>
61    /// <param name="relatedNodeArg">
62    /// Specifies the <see cref="IEvent">IEvent</see>'s related Node.
63    /// </param>
64    /// <param name="prevNamespaceUri">
65    /// Specifies the previous <see cref="NamespaceUri">NamespaceUri</see>
66    /// of the related <see cref="INode">INode</see>. This value may be
67    /// <c>null</c>.
68    /// </param>
69    /// <param name="prevNodeName">
70    /// Specifies the previous <see cref="NodeName">NodeName</see> of the
71    /// related Node.
72    /// </param>
73    void InitMutationNameEvent(
74      string typeArg,
75      bool canBubbleArg,
76      bool cancelableArg,
77      INode relatedNodeArg,
78      string prevNamespaceUri,
79      string prevNodeName);
80   
81    /// <summary>
82    /// The
83    /// <see cref="InitMutationNameEventNs">InitMutationNameEventNs</see>
84    /// method is used to initialize the value of a
85    /// <see cref="IMutationNameEvent">IMutationNameEvent</see> created
86    /// using the
87    /// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
88    /// method. This method may only be called before the
89    /// <see cref="IMutationNameEvent">IMutationNameEvent</see> has been
90    /// dispatched via the
91    /// <see cref="IEventTarget.DispatchEvent">IEventTarget.DispatchEvent</see>
92    /// method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.
93    /// </summary>
94    /// <param name="namespaceUri">
95    /// Specifies the
96    /// <see cref="http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/glossary.html#dt-namespaceURI">namespace URI</see>
97    /// associated with this event, or <c>null</c> if the application
98    /// wish to have no namespace.
99    /// </param>
100    /// <param name="typeArg">
101    /// Specifies the event type.
102    /// </param>
103    /// <param name="canBubbleArg">
104    /// Specifies whether or not the event can bubble.
105    /// </param>
106    /// <param name="cancelableArg">
107    /// Specifies whether or not the event's default action can be prevented.
108    /// </param>
109    /// <param name="relatedNodeArg">
110    /// Specifies the <see cref="IEvent">IEvent</see>'s related Node.
111    /// </param>
112    /// <param name="prevNamespaceUri">
113    /// Specifies the previous
114    /// <see cref="INode.NamespaceUri">NamespaceUri</see> of the related
115    /// Node. This value may be <c>null</c>.
116    /// </param>
117    /// <param name="prevNodeName">
118    /// Specifies the previous <see cref="INode.NodeName">NodeName</see>
119    /// of the related Node.
120    /// </param>
121    void InitMutationNameEventNs(
122      string namespaceUri,
123      string typeArg,
124      bool canBubbleArg,
125      bool cancelableArg,
126      INode relatedNodeArg,
127      string prevNamespaceUri,
128      string prevNodeName);
129  }
130}
Note: See TracBrowser for help on using the repository browser.