Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

MouseButton Class Reference

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard mouse buttons. More...

#include <mouseButton.h>

List of all members.

Static Public Member Functions

ButtonHandle button (int button_number)
 Returns the ButtonHandle associated with the particular numbered mouse button (zero-based), if there is one, or ButtonHandle::none() if there is not.

ButtonHandle one ()
 Returns the ButtonHandle associated with the first mouse button.

ButtonHandle two ()
 Returns the ButtonHandle associated with the second mouse button.

ButtonHandle three ()
 Returns the ButtonHandle associated with the third mouse button.

bool is_mouse_button (ButtonHandle button)
 Returns true if the indicated ButtonHandle is a mouse button, false if it is some other kind of button.

void init_mouse_buttons ()
 This is intended to be called only once, by the static initialization performed in config_util.cxx.

Detailed Description

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard mouse buttons.

Definition at line 40 of file mouseButton.h.

Member Function Documentation

ButtonHandle MouseButton::button (  int  button_number  )  [static]
 

Returns the ButtonHandle associated with the particular numbered mouse button (zero-based), if there is one, or ButtonHandle::none() if there is not.

Definition at line 47 of file mouseButton.cxx.

References _buttons.

void MouseButton::init_mouse_buttons (   )  [static]
 

This is intended to be called only once, by the static initialization performed in config_util.cxx.

Definition at line 131 of file mouseButton.cxx.

bool MouseButton::is_mouse_button (  ButtonHandle  button  )  [static]
 

Returns true if the indicated ButtonHandle is a mouse button, false if it is some other kind of button.

Definition at line 110 of file mouseButton.cxx.

ButtonHandle MouseButton::one (   )  [static]
 

Returns the ButtonHandle associated with the first mouse button.

Definition at line 65 of file mouseButton.cxx.

Referenced by Trackball::apply().

ButtonHandle MouseButton::three (   )  [static]
 

Returns the ButtonHandle associated with the third mouse button.

Definition at line 95 of file mouseButton.cxx.

References _buttons, nassertv, num_mouse_buttons, ButtonRegistry::ptr(), and ButtonRegistry::register_button().

Referenced by Trackball::apply().

ButtonHandle MouseButton::two (   )  [static]
 

Returns the ButtonHandle associated with the second mouse button.

Definition at line 80 of file mouseButton.cxx.

References _buttons, and num_mouse_buttons.

Referenced by Trackball::apply().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:52:19 2003 for Panda by doxygen1.3