org.kde.koala
Class TextEvent
public
class
TextEvent
extends UIEvent
DOM.TextEvent
The detail attribute inherited from UIEvent is used to indicate
the number of keypresses which have occurred during key repetition.
If this information is not available this value should be 0.
UNKNOWN: DOM.TextEvent The detail attribute inherited from UIEvent is used to indicate the number of keypresses which have occurred during key repetition.
Method Summary |
boolean | checkModifier(long modifierArg)
checkModifier
Note: the below description does not match the actual behavior.
it's extended in a way that you can query multiple modifiers
at once by logically OR`ing them.
also, we use the Qt modifier enum instead of the DOM one.
|
void | initModifier(long modifierArg, boolean valueArg)
initModifier
The initModifier method is used to initialize the values of any
modifiers associated with a TextEvent created through the
DocumentEvent interface. |
void | initTextEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, long detailArg, String outputStringArg, long keyValArg, long virtKeyValArg, boolean inputGeneratedArg, boolean numPadArg)
initTextEvent
The initTextEvent method is used to initialize the value of a
MouseEvent created through the DocumentEvent interface. |
boolean | inputGenerated()
inputGenerated of type booleanean
The inputGenerated attribute indicates whether the key event will
normally cause visible output. |
long | keyVal() keyVal of type unsigned long
The value of keyVal holds the value of the Unicode character
associated with the depressed key. |
boolean | numPad() numPad of type booleanean
The numPad attribute indicates whether or not the key event was
generated on the number pad section of the keyboard. |
String | outputString()
outputString of type DOMString
outputString holds the value of the output generated by the key
event. |
long | virtKeyVal() virtKeyVal of type unsigned long
When the key associated with a key event is not representable via
a Unicode character virtKeyVale holds the key code
associated with the depressed key. |
protected TextEvent(Class dummy)
public TextEvent()
public TextEvent(
Event other)
public boolean checkModifier(long modifierArg)
checkModifier
Note: the below description does not match the actual behavior.
it's extended in a way that you can query multiple modifiers
at once by logically OR`ing them.
also, we use the Qt modifier enum instead of the DOM one.
The CheckModifier method is used to check the status of a single
modifier key associated with a TextEvent. The identifier of the
modifier in question is passed into the CheckModifier function. If
the modifier is triggered it will return true. If not, it will
return false. The list of keys below represents the allowable
modifier parameters for this method:
DOM_VK_LEFT_ALT
DOM_VK_RIGHT_ALT
DOM_VK_LEFT_CONTROL
DOM_VK_RIGHT_CONTROL
DOM_VK_LEFT_SHIFT
DOM_VK_RIGHT_SHIFT
DOM_VK_META
Parameters:
modifier of type unsigned long
The modifier which the user wishes to query.
Return Value: booleanean
The status of the modifier represented as a booleanean.
No Exceptions
UNKNOWN: checkModifier
public void initModifier(long modifierArg, boolean valueArg)
initModifier
The initModifier method is used to initialize the values of any
modifiers associated with a TextEvent created through the
DocumentEvent interface. This method may only be called before the
TextEvent has been dispatched via the dispatchEvent method, though
it may be called multiple times during that phase if necessary. If
called multiple times with the same modifier property the final
invocation takes precedence. Unless explicitly give a value of
true, all modifiers have a value of false. This method has no
effect if called after the event has been dispatched. The list of
keys below represents the allowable modifier parameters for this
method:
DOM_VK_LEFT_ALT
DOM_VK_RIGHT_ALT
DOM_VK_LEFT_CONTROL
DOM_VK_RIGHT_CONTROL
DOM_VK_LEFT_SHIFT
DOM_VK_RIGHT_SHIFT
DOM_VK_META
Parameters:
modifier of type unsigned long
The modifier which the user wishes to initialize
value of type booleanean
The new value of the modifier.
No Return Value
No Exceptions
UNKNOWN: initModifier
public void initTextEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg,
AbstractView viewArg, long detailArg, String outputStringArg, long keyValArg, long virtKeyValArg, boolean inputGeneratedArg, boolean numPadArg)
initTextEvent
The initTextEvent method is used to initialize the value of a
MouseEvent created through the DocumentEvent interface. This
method may only be called before the TextEvent has been dispatched
via the dispatchEvent method, though it may be called multiple
times during that phase if necessary. If called multiple times,
the final invocation takes precedence. This method has no effect
if called after the event has been dispatched.
Parameters:
typeArg of type DOMString
Specifies the event type.
canBubbleArg of type booleanean
Specifies whether or not the event can bubble.
cancelableArg of type booleanean
Specifies whether or not the event's default action can be prevent.
viewArg of type views.AbstractView
Specifies the TextEvent's AbstractView.
detailArg of type unsigned short
Specifies the number of repeated keypresses, if available.
outputStringArg of type DOMString
Specifies the TextEvent's outputString attribute
keyValArg of type unsigned long
Specifies the TextEvent's keyValattribute
virtKeyValArg of type unsigned long
Specifies the TextEvent's virtKeyValattribute
inputGeneratedArg of type booleanean
Specifies the TextEvent's inputGeneratedattribute
numPadArg of type booleanean
Specifies the TextEvent's numPadattribute
No Return Value.
No Exceptions.
UNKNOWN: initTextEvent
public boolean inputGenerated()
inputGenerated of type booleanean
The inputGenerated attribute indicates whether the key event will
normally cause visible output. If the key event does not
generate any visible output, such as the use of a function key
or the combination of certain modifier keys used in conjunction
with another key, then the value will be false. If visible
output is normally generated by the key event then the value
will be true. The value of inputGenerated does not guarantee
the creation of a character. If a key event causing visible
output is cancelable it may be prevented from causing
output. This attribute is intended primarily to differentiate
between keys events which may or may not produce visible output
depending on the system state.
UNKNOWN: inputGenerated of type boolean
public long keyVal()
keyVal of type unsigned long
The value of keyVal holds the value of the Unicode character
associated with the depressed key. If the key has no Unicode
representation or no Unicode character is available the value is
0.
UNKNOWN: keyVal of type unsigned long
public boolean numPad()
numPad of type booleanean
The numPad attribute indicates whether or not the key event was
generated on the number pad section of the keyboard. If the number
pad was used to generate the key event the value is true,
otherwise the value is false.
UNKNOWN: numPad of type boolean
public String outputString()
outputString of type DOMString
outputString holds the value of the output generated by the key
event. This may be a single Unicode character or it may be a
string. It may also be null in the case where no output was
generated by the key event.
UNKNOWN: outputString of type DOMString
public long virtKeyVal()
virtKeyVal of type unsigned long
When the key associated with a key event is not representable via
a Unicode character virtKeyVale holds the key code
associated with the depressed key. If the key has a Unicode
representation or no code is available the value is
DOM_VK_UNDEFINED.
UNKNOWN: virtKeyVal of type unsigned long