| 1 | using System;
|
|---|
| 2 | using SharpVectors.Dom.Views;
|
|---|
| 3 |
|
|---|
| 4 | namespace SharpVectors.Dom.Events
|
|---|
| 5 | {
|
|---|
| 6 | /// <summary>
|
|---|
| 7 | /// The <see cref="IUiEvent">IUiEvent</see> interface provides specific
|
|---|
| 8 | /// contextual information associated with User Interface events.
|
|---|
| 9 | /// </summary>
|
|---|
| 10 | /// <remarks>
|
|---|
| 11 | /// Note: To create an instance of the <see cref="IUiEvent">IUiEvent</see>
|
|---|
| 12 | /// interface, use the feature string <c>"UIEvent"</c> as the value of the
|
|---|
| 13 | /// input parameter used with the
|
|---|
| 14 | /// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
|
|---|
| 15 | /// method.
|
|---|
| 16 | /// </remarks>
|
|---|
| 17 | public interface IUiEvent
|
|---|
| 18 | : IEvent
|
|---|
| 19 | {
|
|---|
| 20 | /// <summary>
|
|---|
| 21 | /// The <see cref="View">View</see> attribute identifies the
|
|---|
| 22 | /// <see cref="IAbstractView">IAbstractView</see> from which the
|
|---|
| 23 | /// event was generated.
|
|---|
| 24 | /// </summary>
|
|---|
| 25 | IAbstractView View
|
|---|
| 26 | {
|
|---|
| 27 | get;
|
|---|
| 28 | }
|
|---|
| 29 |
|
|---|
| 30 | /// <summary>
|
|---|
| 31 | /// Specifies some detail information about the
|
|---|
| 32 | /// <see cref="IEvent">IEvent</see>, depending on the type of event.
|
|---|
| 33 | /// </summary>
|
|---|
| 34 | long Detail
|
|---|
| 35 | {
|
|---|
| 36 | get;
|
|---|
| 37 | }
|
|---|
| 38 |
|
|---|
| 39 | /// <summary>
|
|---|
| 40 | /// The <see cref="InitUiEvent">InitUiEvent</see> method is used to
|
|---|
| 41 | /// initialize the value of a <see cref="IUiEvent">IUiEvent</see>
|
|---|
| 42 | /// created using the
|
|---|
| 43 | /// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
|
|---|
| 44 | /// method.
|
|---|
| 45 | /// </summary>
|
|---|
| 46 | /// <remarks>
|
|---|
| 47 | /// This method may only be called before the
|
|---|
| 48 | /// <see cref="InitUiEvent">InitUiEvent</see> has been dispatched via
|
|---|
| 49 | /// the
|
|---|
| 50 | /// <see cref="IEventTarget.DispatchEvent">IEventTarget.DispatchEvent</see>
|
|---|
| 51 | /// method, though it may be called multiple times during that phase
|
|---|
| 52 | /// if necessary. If called multiple times, the final invocation takes
|
|---|
| 53 | /// precedence.
|
|---|
| 54 | /// </remarks>
|
|---|
| 55 | /// <param name="typeArg">
|
|---|
| 56 | /// Specifies the event type.
|
|---|
| 57 | /// </param>
|
|---|
| 58 | /// <param name="canBubbleArg">
|
|---|
| 59 | /// Specifies whether or not the event can bubble. This parameter
|
|---|
| 60 | /// overrides the intrinsic bubbling behavior of the event.
|
|---|
| 61 | /// </param>
|
|---|
| 62 | /// <param name="cancelableArg">
|
|---|
| 63 | /// Specifies whether or not the event's default action can be
|
|---|
| 64 | /// prevented. This parameter overrides the intrinsic cancelable
|
|---|
| 65 | /// behavior of the event.
|
|---|
| 66 | /// </param>
|
|---|
| 67 | /// <param name="viewArg">
|
|---|
| 68 | /// Specifies the <see cref="IEvent">IEvent</see>'s
|
|---|
| 69 | /// <see cref="IAbstractView">IAbstractView</see>.
|
|---|
| 70 | /// </param>
|
|---|
| 71 | /// <param name="detailArg">
|
|---|
| 72 | /// Specifies the <see cref="IEvent">IEvent</see>'s detail.
|
|---|
| 73 | /// </param>
|
|---|
| 74 | void InitUiEvent(
|
|---|
| 75 | string typeArg,
|
|---|
| 76 | bool canBubbleArg,
|
|---|
| 77 | bool cancelableArg,
|
|---|
| 78 | IAbstractView viewArg,
|
|---|
| 79 | long detailArg);
|
|---|
| 80 |
|
|---|
| 81 | /// <summary>
|
|---|
| 82 | /// The <see cref="InitUiEventNs">InitUiEventNs</see> method is used
|
|---|
| 83 | /// to initialize the value of a <see cref="IUiEvent">IUiEvent</see>
|
|---|
| 84 | /// created using the
|
|---|
| 85 | /// <see cref="IDocumentEvent.CreateEvent">IDocumentEvent.CreateEvent</see>
|
|---|
| 86 | /// method. This method may only be called before the
|
|---|
| 87 | /// <see cref="IUiEvent">IUiEvent</see> has been dispatched via the
|
|---|
| 88 | /// <see cref="IEventTarget.DispatchEvent">IEventTarget.DispatchEvent</see>
|
|---|
| 89 | /// method, though it may be called multiple times during that phase
|
|---|
| 90 | /// if necessary. If called multiple times, the final invocation
|
|---|
| 91 | /// takes precedence.
|
|---|
| 92 | /// </summary>
|
|---|
| 93 | /// <param name="namespaceURI">
|
|---|
| 94 | /// Specifies the
|
|---|
| 95 | /// <see href="http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/glossary.html#dt-namespaceURI">namespace URI</see>
|
|---|
| 96 | /// associated with this event, or <c>null</c> if the application wish
|
|---|
| 97 | /// not to use namespaces.
|
|---|
| 98 | /// </param>
|
|---|
| 99 | /// <param name="typeArg">
|
|---|
| 100 | /// Specifies the event type (see also the description of the
|
|---|
| 101 | /// <c>type</c> attribute in the <see cref="IEvent">IEvent</see>
|
|---|
| 102 | /// interface).
|
|---|
| 103 | /// </param>
|
|---|
| 104 | /// <param name="canBubbleArg">
|
|---|
| 105 | /// Specifies whether or not the event can bubble.
|
|---|
| 106 | /// </param>
|
|---|
| 107 | /// <param name="cancelableArg">
|
|---|
| 108 | /// Specifies whether or not the event's default action can be prevented.
|
|---|
| 109 | /// </param>
|
|---|
| 110 | /// <param name="viewArg">
|
|---|
| 111 | /// Specifies the <see cref="IEvent">Event</see>'s
|
|---|
| 112 | /// <see cref="IAbstractView">IAbstractView</see>
|
|---|
| 113 | /// </param>
|
|---|
| 114 | /// <param name="detailArg">
|
|---|
| 115 | /// Specifies the <see cref="IEvent">IEvent</see>'s detail.
|
|---|
| 116 | /// </param>
|
|---|
| 117 | void InitUiEventNs(
|
|---|
| 118 | string namespaceURI,
|
|---|
| 119 | string typeArg,
|
|---|
| 120 | bool canBubbleArg,
|
|---|
| 121 | bool cancelableArg,
|
|---|
| 122 | IAbstractView viewArg,
|
|---|
| 123 | long detailArg);
|
|---|
| 124 | }
|
|---|
| 125 | }
|
|---|
