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