# MouseButton

from pandac.PandaModules import MouseButton

Class : MouseButton
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.

## Inheritance:

MouseButton:

## Methods of MouseButton:

button
five
four
isMouseButton
one
three
two
wheelDown
wheelLeft
wheelRight
wheelUp

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

five static ButtonHandle MouseButton::five(void); Description: Returns the ButtonHandle associated with the fifth mouse button.

four static ButtonHandle MouseButton::four(void); Description: Returns the ButtonHandle associated with the fourth mouse button.

isMouseButton static bool MouseButton::is_mouse_button(ButtonHandle button); Description: Returns true if the indicated ButtonHandle is a mouse button, false if it is some other kind of button.

one static ButtonHandle MouseButton::one(void); Description: Returns the ButtonHandle associated with the first mouse button.

three static ButtonHandle MouseButton::three(void); Description: Returns the ButtonHandle associated with the third mouse button.

two static ButtonHandle MouseButton::two(void); Description: Returns the ButtonHandle associated with the second mouse button.

wheelDown static ButtonHandle MouseButton::wheel_down(void); Description: Returns the ButtonHandle generated when the mouse wheel is rolled one notch downwards.

wheelLeft static ButtonHandle MouseButton::wheel_left(void); Description: Returns the ButtonHandle generated when the mouse is scrolled to the left. Usually, you'll only find the horizontal scroll on laptops.

wheelRight static ButtonHandle MouseButton::wheel_right(void); Description: Returns the ButtonHandle generated when the mouse is scrolled to the right. Usually, you'll only find the horizontal scroll on laptops.

wheelUp static ButtonHandle MouseButton::wheel_up(void); Description: Returns the ButtonHandle generated when the mouse wheel is rolled one notch upwards.