Panda3D
|
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"
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. | |
const wstring & | get_candidate_string () const |
Returns the candidate string associated with this event. | |
string | get_candidate_string_encoded () const |
Returns the candidate string associated with this event. | |
string | get_candidate_string_encoded (TextEncoder::Encoding encoding) const |
Returns the candidate string associated with this event. | |
size_t | get_cursor_pos () const |
Returns the position of the user's edit cursor within the candidate string. | |
size_t | get_highlight_end () const |
Returns one more than the last highlighted character in the candidate string. | |
size_t | get_highlight_start () const |
Returns the first highlighted character in the candidate string. | |
int | get_keycode () const |
Returns the keycode associated with this event. | |
const ModifierButtons & | get_modifier_buttons () const |
Returns the set of modifier buttons that were being held down while the event was generated. | |
const LPoint2 & | get_mouse () const |
Returns the mouse position at the time the event was generated, in the normalized range (-1 . | |
bool | has_button () const |
Returns true if this parameter has an associated mouse or keyboard button, false otherwise. | |
bool | has_candidate () const |
Returns true if this parameter has an associated candidate string, false otherwise. | |
bool | has_keycode () const |
Returns true if this parameter has an associated keycode, false otherwise. | |
bool | has_mouse () const |
Returns true if this parameter has an associated mouse position, false otherwise. | |
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. | |
bool | is_outside () const |
Returns true if the mouse was outside the region at the time the event was generated, false otherwise. | |
void | operator= (const MouseWatcherParameter &other) |
void | output (ostream &out) const |
void | set_button (const ButtonHandle &button) |
Sets the mouse or keyboard button that generated this event, if any. | |
void | set_candidate (const 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. | |
void | set_keycode (int keycode) |
Sets the keycode associated with this event, if any. | |
void | set_keyrepeat (bool flag) |
Sets the state of the "keyrepeat" flag. | |
void | set_modifier_buttons (const ModifierButtons &mods) |
Sets the modifier buttons that were being held while this event was generated. | |
void | set_mouse (const LPoint2 &mouse) |
Sets the mouse position that was current at the time the event was generated. | |
void | set_outside (bool flag) |
Sets the state of the "outside" flag. | |
Public Attributes | |
ButtonHandle | _button |
wstring | _candidate_string |
size_t | _cursor_pos |
int | _flags |
size_t | _highlight_end |
size_t | _highlight_start |
short | _keycode |
ModifierButtons | _mods |
LPoint2 | _mouse |
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 31 of file mouseWatcherParameter.h.
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 181 of file mouseWatcherParameter.I.
Referenced by PGEntry::accept(), PGEntry::accept_failed(), PGButton::click(), PGSliderBar::press(), PGItem::press(), PGEntry::press(), PGButton::press(), PGSliderBar::release(), PGItem::release(), and PGButton::release().
const 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 238 of file mouseWatcherParameter.I.
Referenced by PGEntry::candidate().
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 250 of file mouseWatcherParameter.I.
References TextEncoder::get_default_encoding().
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 262 of file mouseWatcherParameter.I.
References TextEncoder::encode_wtext().
size_t MouseWatcherParameter::get_cursor_pos | ( | ) | const [inline] |
Returns the position of the user's edit cursor within the candidate string.
Definition at line 295 of file mouseWatcherParameter.I.
Referenced by PGEntry::candidate().
size_t MouseWatcherParameter::get_highlight_end | ( | ) | const [inline] |
Returns one more than the last highlighted character in the candidate string.
Definition at line 284 of file mouseWatcherParameter.I.
Referenced by PGEntry::candidate().
size_t MouseWatcherParameter::get_highlight_start | ( | ) | const [inline] |
Returns the first highlighted character in the candidate string.
Definition at line 273 of file mouseWatcherParameter.I.
Referenced by PGEntry::candidate().
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 215 of file mouseWatcherParameter.I.
Referenced by PGEntry::keystroke().
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 306 of file mouseWatcherParameter.I.
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 329 of file mouseWatcherParameter.I.
References has_mouse().
Referenced by PGSliderBar::item_move(), PGSliderBar::item_press(), PGSliderBar::move(), and PGSliderBar::press().
bool MouseWatcherParameter::has_button | ( | ) | const [inline] |
Returns true if this parameter has an associated mouse or keyboard button, false otherwise.
Definition at line 169 of file mouseWatcherParameter.I.
Referenced by PGEntry::press().
bool MouseWatcherParameter::has_candidate | ( | ) | const [inline] |
Returns true if this parameter has an associated candidate string, false otherwise.
Definition at line 226 of file mouseWatcherParameter.I.
Referenced by PGEntry::candidate().
bool MouseWatcherParameter::has_keycode | ( | ) | const [inline] |
Returns true if this parameter has an associated keycode, false otherwise.
Definition at line 204 of file mouseWatcherParameter.I.
Referenced by PGEntry::keystroke().
bool MouseWatcherParameter::has_mouse | ( | ) | const [inline] |
Returns true if this parameter has an associated mouse position, false otherwise.
Definition at line 317 of file mouseWatcherParameter.I.
Referenced by get_mouse(), PGSliderBar::item_press(), and PGSliderBar::press().
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 193 of file mouseWatcherParameter.I.
Referenced by PGItem::press().
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 342 of file mouseWatcherParameter.I.
Referenced by PGButton::release().
void MouseWatcherParameter::set_button | ( | const ButtonHandle & | button | ) | [inline] |
Sets the mouse or keyboard button that generated this event, if any.
Definition at line 72 of file mouseWatcherParameter.I.
Referenced by MouseWatcher::enter_region(), MouseWatcher::exit_region(), MouseWatcher::press(), and MouseWatcher::release().
void MouseWatcherParameter::set_candidate | ( | const 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 112 of file mouseWatcherParameter.I.
Referenced by MouseWatcher::candidate().
void MouseWatcherParameter::set_keycode | ( | int | keycode | ) | [inline] |
Sets the keycode associated with this event, if any.
Definition at line 100 of file mouseWatcherParameter.I.
Referenced by MouseWatcher::keystroke().
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 86 of file mouseWatcherParameter.I.
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 129 of file mouseWatcherParameter.I.
Referenced by MouseWatcher::clear_current_regions(), MouseWatcher::move(), and MouseWatcher::set_current_regions().
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 140 of file mouseWatcherParameter.I.
Referenced by MouseWatcher::clear_current_regions().
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 154 of file mouseWatcherParameter.I.