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

#include "mouseWatcherParameter.h"

Inheritance diagram for MouseWatcherParameter:

Public Types
enum	Flags { F_has_button = 0x001, F_has_mouse = 0x002, F_is_outside = 0x004, F_has_keycode = 0x008, F_has_candidate = 0x010, F_is_keyrepeat = 0x020 }

Public Member Functions
	MouseWatcherParameter (const MouseWatcherParameter &other)

ButtonHandle	get_button () const
	Returns the mouse or keyboard button associated with this event. More...

const std::wstring &	get_candidate_string () const
	Returns the candidate string associated with this event. More...

std::string	get_candidate_string_encoded () const
	Returns the candidate string associated with this event. More...

std::string	get_candidate_string_encoded (TextEncoder::Encoding encoding) const
	Returns the candidate string associated with this event. More...

size_t	get_cursor_pos () const
	Returns the position of the user's edit cursor within the candidate string. More...

size_t	get_highlight_end () const
	Returns one more than the last highlighted character in the candidate string. More...

size_t	get_highlight_start () const
	Returns the first highlighted character in the candidate string. More...

int	get_keycode () const
	Returns the keycode associated with this event. More...

const ModifierButtons &	get_modifier_buttons () const
	Returns the set of modifier buttons that were being held down while the event was generated. More...

const LPoint2 &	get_mouse () const
	Returns the mouse position at the time the event was generated, in the normalized range (-1 . More...

bool	has_button () const
	Returns true if this parameter has an associated mouse or keyboard button, false otherwise. More...

bool	has_candidate () const
	Returns true if this parameter has an associated candidate string, false otherwise. More...

bool	has_keycode () const
	Returns true if this parameter has an associated keycode, false otherwise. More...

bool	has_mouse () const
	Returns true if this parameter has an associated mouse position, false otherwise. More...

bool	is_keyrepeat () const
	Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down. More...

bool	is_outside () const
	Returns true if the mouse was outside the region at the time the event was generated, false otherwise. More...

void	operator= (const MouseWatcherParameter &other)

void	output (std::ostream &out) const

void	set_button (const ButtonHandle &button)
	Sets the mouse or keyboard button that generated this event, if any. More...

void	set_candidate (const std::wstring &candidate_string, size_t highlight_start, size_t higlight_end, size_t cursor_pos)
	Sets the candidate string associated with this event, if any. More...

void	set_keycode (int keycode)
	Sets the keycode associated with this event, if any. More...

void	set_keyrepeat (bool flag)
	Sets the state of the "keyrepeat" flag. More...

void	set_modifier_buttons (const ModifierButtons &mods)
	Sets the modifier buttons that were being held while this event was generated. More...

void	set_mouse (const LPoint2 &mouse)
	Sets the mouse position that was current at the time the event was generated. More...

void	set_outside (bool flag)
	Sets the state of the "outside" flag. More...

Public Attributes
ButtonHandle	_button

std::wstring	_candidate_string

size_t	_cursor_pos

int	_flags

size_t	_highlight_end

size_t	_highlight_start

int	_keycode

ModifierButtons	_mods

LPoint2	_mouse

Detailed 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.

Definition at line 28 of file mouseWatcherParameter.h.

Member Function Documentation

◆ get_button()

ButtonHandle MouseWatcherParameter::get_button ( ) const

inline

Returns the mouse or keyboard button associated with this event.

If has_button(), above, returns false, this returns ButtonHandle::none().

Definition at line 148 of file mouseWatcherParameter.I.

Referenced by PGEntry::accept(), PGEntry::accept_failed(), PGButton::click(), PGButton::press(), PGSliderBar::press(), PGEntry::press(), PGItem::press(), PGButton::release(), PGSliderBar::release(), and PGItem::release().

◆ get_candidate_string()

const std::wstring & MouseWatcherParameter::get_candidate_string ( ) const

inline

Returns the candidate string associated with this event.

If has_candidate(), above, returns false, this returns the empty string.

Definition at line 192 of file mouseWatcherParameter.I.

Referenced by PGEntry::candidate().

◆ get_candidate_string_encoded() [1/2]

std::string MouseWatcherParameter::get_candidate_string_encoded ( ) const

inline

Returns the candidate string associated with this event.

If has_candidate(), above, returns false, this returns the empty string.

Definition at line 201 of file mouseWatcherParameter.I.

◆ get_candidate_string_encoded() [2/2]

std::string MouseWatcherParameter::get_candidate_string_encoded ( TextEncoder::Encoding encoding ) const

inline

Returns the candidate string associated with this event.

If has_candidate(), above, returns false, this returns the empty string.

Definition at line 210 of file mouseWatcherParameter.I.

References TextEncoder::encode_wtext().

◆ get_cursor_pos()

size_t MouseWatcherParameter::get_cursor_pos ( ) const

inline

Returns the position of the user's edit cursor within the candidate string.

Definition at line 235 of file mouseWatcherParameter.I.

Referenced by PGEntry::candidate().

◆ get_highlight_end()

size_t MouseWatcherParameter::get_highlight_end ( ) const

inline

Returns one more than the last highlighted character in the candidate string.

Definition at line 227 of file mouseWatcherParameter.I.

Referenced by PGEntry::candidate().

◆ get_highlight_start()

size_t MouseWatcherParameter::get_highlight_start ( ) const

inline

Returns the first highlighted character in the candidate string.

Definition at line 218 of file mouseWatcherParameter.I.

Referenced by PGEntry::candidate().

◆ get_keycode()

int MouseWatcherParameter::get_keycode ( ) const

inline

Returns the keycode associated with this event.

If has_keycode(), above, returns false, this returns 0.

Definition at line 174 of file mouseWatcherParameter.I.

Referenced by PGEntry::keystroke().

◆ get_modifier_buttons()

const ModifierButtons & MouseWatcherParameter::get_modifier_buttons ( ) const

inline

Returns the set of modifier buttons that were being held down while the event was generated.

Definition at line 244 of file mouseWatcherParameter.I.

◆ get_mouse()

const LPoint2 & MouseWatcherParameter::get_mouse ( ) const

inline

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.

Definition at line 263 of file mouseWatcherParameter.I.

Referenced by PGSliderBar::move(), and PGSliderBar::press().

◆ has_button()

bool MouseWatcherParameter::has_button ( ) const

inline

Returns true if this parameter has an associated mouse or keyboard button, false otherwise.

Definition at line 139 of file mouseWatcherParameter.I.

Referenced by PGEntry::press().

◆ has_candidate()

bool MouseWatcherParameter::has_candidate ( ) const

inline

Returns true if this parameter has an associated candidate string, false otherwise.

Definition at line 183 of file mouseWatcherParameter.I.

Referenced by PGEntry::candidate().

◆ has_keycode()

bool MouseWatcherParameter::has_keycode ( ) const

inline

Returns true if this parameter has an associated keycode, false otherwise.

Definition at line 165 of file mouseWatcherParameter.I.

Referenced by PGEntry::keystroke().

◆ has_mouse()

bool MouseWatcherParameter::has_mouse ( ) const

inline

Returns true if this parameter has an associated mouse position, false otherwise.

Definition at line 253 of file mouseWatcherParameter.I.

Referenced by PGSliderBar::press().

◆ is_keyrepeat()

bool MouseWatcherParameter::is_keyrepeat ( ) const

inline

Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down.

Definition at line 157 of file mouseWatcherParameter.I.

Referenced by PGItem::press().

◆ is_outside()

bool MouseWatcherParameter::is_outside ( ) const

inline

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.

Definition at line 273 of file mouseWatcherParameter.I.

Referenced by PGButton::release().

◆ set_button()

void MouseWatcherParameter::set_button ( const ButtonHandle & button )

inline

Sets the mouse or keyboard button that generated this event, if any.

Definition at line 59 of file mouseWatcherParameter.I.

◆ set_candidate()

void MouseWatcherParameter::set_candidate	(	const std::wstring &	candidate_string,
		size_t	highlight_start,
		size_t	higlight_end,
		size_t	cursor_pos
	)

inline

Sets the candidate string associated with this event, if any.

Definition at line 91 of file mouseWatcherParameter.I.

◆ set_keycode()

void MouseWatcherParameter::set_keycode ( int keycode )

inline

Sets the keycode associated with this event, if any.

Definition at line 82 of file mouseWatcherParameter.I.

◆ set_keyrepeat()

void MouseWatcherParameter::set_keyrepeat ( bool flag )

inline

Sets the state of the "keyrepeat" flag.

This is true if a button-press event was generated due to keyrepeat, or false if it is an original button press.

Definition at line 70 of file mouseWatcherParameter.I.

◆ set_modifier_buttons()

void MouseWatcherParameter::set_modifier_buttons ( const ModifierButtons & mods )

inline

Sets the modifier buttons that were being held while this event was generated.

Definition at line 106 of file mouseWatcherParameter.I.

◆ set_mouse()

void MouseWatcherParameter::set_mouse ( const LPoint2 & mouse )

inline

Sets the mouse position that was current at the time the event was generated.

Definition at line 115 of file mouseWatcherParameter.I.

◆ set_outside()

void MouseWatcherParameter::set_outside ( bool flag )

inline

Sets the state of the "outside" flag.

This is true if the mouse was outside the region at the time the event was generated, false otherwise. This only has meaning for "release" events.

Definition at line 126 of file mouseWatcherParameter.I.

The documentation for this class was generated from the following files:

panda/src/tform/mouseWatcherParameter.h
panda/src/tform/mouseWatcherParameter.cxx
panda/src/tform/mouseWatcherParameter.I

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ get_button()

◆ get_candidate_string()

◆ get_candidate_string_encoded() [1/2]

◆ get_candidate_string_encoded() [2/2]

◆ get_cursor_pos()

◆ get_highlight_end()

◆ get_highlight_start()

◆ get_keycode()

◆ get_modifier_buttons()

◆ get_mouse()

◆ has_button()

◆ has_candidate()

◆ has_keycode()

◆ has_mouse()

◆ is_keyrepeat()

◆ is_outside()

◆ set_button()

◆ set_candidate()

◆ set_keycode()

◆ set_keyrepeat()

◆ set_modifier_buttons()

◆ set_mouse()

◆ set_outside()