# ButtonHandle

from pandac.PandaModules import ButtonHandle

Class : ButtonHandle
Description : A ButtonHandle represents a single button from any device, including keyboard buttons and mouse buttons (but see KeyboardButton and MouseButton).

## Inheritance:

ButtonHandle:

## Methods of ButtonHandle:

getAlias
getAsciiEquivalent
getClassType
getIndex
getName
hasAsciiEquivalent
matches
none
output

getAlias ButtonHandle ButtonHandle::get_alias(void) const; Description: Returns the alias (alternate name) associated with the button, if any, or ButtonHandle::none() if the button has no alias. Each button is allowed to have one alias, and multiple different buttons can refer to the same alias. The alias should be the more general name for the button, for instance, shift is an alias for lshift, but not vice-versa.

getAsciiEquivalent char ButtonHandle::get_ascii_equivalent(void) const; Description: Returns the character code associated with the button, or '\0' if no ASCII code was associated.

getClassType static TypeHandle ButtonHandle::get_class_type(void); Undocumented function.

getIndex int ButtonHandle::get_index(void) const; Description: Returns the integer index associated with this ButtonHandle. Each different ButtonHandle will have a different index. However, you probably shouldn't be using this method; you should just treat the ButtonHandles as opaque classes. This is provided for the convenience of non-C++ scripting languages to build a hashtable of ButtonHandles.

getName string ButtonHandle::get_name(void) const; Description: Returns the name of the button.

hasAsciiEquivalent bool ButtonHandle::has_ascii_equivalent(void) const; Description: Returns true if the button was created with an ASCII equivalent code (e.g. for a standard keyboard button).

matches bool ButtonHandle::matches(ButtonHandle const &other) const; Description: Returns true if this ButtonHandle is the same as the other one, or if the other one is an alias for this one. (Does not return true if this button is an alias for the other one, however.) This is a more general comparison than operator ==.

none static ButtonHandle ButtonHandle::none(void); Description: Returns a special zero-valued ButtonHandle that is used to indicate no button.

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