# MouseWatcherParameter

from pandac.PandaModules import MouseWatcherParameter

Class : MouseWatcherParameter
Description : 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:

MouseWatcherParameter:

## Methods of MouseWatcherParameter:

getButton
getCandidateStringEncoded
getCursorPos
getHighlightEnd
getHighlightStart
getKeycode
getModifierButtons
getMouse
hasButton
hasCandidate
hasKeycode
hasMouse
isKeyrepeat
isOutside
output

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

getCandidateStringEncoded string MouseWatcherParameter::get_candidate_string_encoded(void) const; Description: Returns the candidate string associated with this event. If has_candidate(), above, returns false, this returns the empty string.

getCursorPos unsigned int MouseWatcherParameter::get_cursor_pos(void) const; Description: Returns the position of the user's edit cursor within the candidate string.

getHighlightEnd unsigned int MouseWatcherParameter::get_highlight_end(void) const; Description: Returns one more than the last highlighted character in the candidate string.

getHighlightStart unsigned int MouseWatcherParameter::get_highlight_start(void) const; Description: Returns the first highlighted character in the candidate string.

getKeycode int MouseWatcherParameter::get_keycode(void) const; Description: Returns the keycode associated with this event. If has_keycode(), above, returns false, this returns 0.

getModifierButtons ModifierButtons const &MouseWatcherParameter::get_modifier_buttons(void) const; Description: Returns the set of modifier buttons that were being held down while the event was generated.

getMouse LPoint2f const &MouseWatcherParameter::get_mouse(void) const; Description: 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.

hasButton bool MouseWatcherParameter::has_button(void) const; Description: Returns true if this parameter has an associated mouse or keyboard button, false otherwise.

hasCandidate bool MouseWatcherParameter::has_candidate(void) const; Description: Returns true if this parameter has an associated candidate string, false otherwise.

hasKeycode bool MouseWatcherParameter::has_keycode(void) const; Description: Returns true if this parameter has an associated keycode, false otherwise.

hasMouse bool MouseWatcherParameter::has_mouse(void) const; Description: Returns true if this parameter has an associated mouse position, false otherwise.

isKeyrepeat bool MouseWatcherParameter::is_keyrepeat(void) const; Description: Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down.

isOutside bool MouseWatcherParameter::is_outside(void) const; Description: 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.

output void MouseWatcherParameter::output(ostream &out) const; Description: