MouseWatcherParameter¶

class MouseWatcherParameter¶

This is sent along as a parameter to most events generated for a region to indicate the mouse and button state for the event.

Inheritance diagram

digraph inheritanceead9e5d99a { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "MouseWatcherParameter" [URL="acron.core.MouseWatcherParameter.html#acron.core.MouseWatcherParameter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "MouseWatcherParameter" [arrowsize=0.75,style=""]; }

MouseWatcherParameter.get_button()¶: Returns the mouse or keyboard button associated with this event. If has_button(), above, returns false, this returns ButtonHandle::none().

MouseWatcherParameter.get_candidate_string_encoded()¶

Returns the candidate string associated with this event. If has_candidate(), above, returns false, this returns the empty string.

MouseWatcherParameter.get_cursor_pos()¶: Returns the position of the user’s edit cursor within the candidate string.

MouseWatcherParameter.get_highlight_end()¶: Returns one more than the last highlighted character in the candidate string.

MouseWatcherParameter.get_highlight_start()¶: Returns the first highlighted character in the candidate string.

MouseWatcherParameter.get_keycode()¶: Returns the keycode associated with this event. If has_keycode(), above, returns false, this returns 0.

MouseWatcherParameter.get_modifier_buttons()¶: Returns the set of modifier buttons that were being held down while the event was generated.

MouseWatcherParameter.get_mouse()¶: Returns the mouse position at the time the event was generated, in the normalized range (-1 .. 1). It is valid to call this only if has_mouse() returned true.

MouseWatcherParameter.has_button()¶: Returns true if this parameter has an associated mouse or keyboard button, false otherwise.

MouseWatcherParameter.has_candidate()¶: Returns true if this parameter has an associated candidate string, false otherwise.

MouseWatcherParameter.has_keycode()¶: Returns true if this parameter has an associated keycode, false otherwise.

MouseWatcherParameter.has_mouse()¶: Returns true if this parameter has an associated mouse position, false otherwise.

MouseWatcherParameter.is_keyrepeat()¶: Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down.

MouseWatcherParameter.is_outside()¶: Returns true if the mouse was outside the region at the time the event was generated, false otherwise. This is only valid for “release” type events.

MouseWatcherParameter.output()¶