Class: Wx::MouseState

Inherits:
KeyboardState show all
Defined in:
lib/wx/doc/gen/mouse_state.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Represents the mouse state.

This class is used as a base class by MouseEvent and so its methods may be used to obtain information about the mouse state for the mouse events. It also inherits from KeyboardState and so carries information about the keyboard state and not only the mouse one. This class is implemented entirely inline in </mousestate.h> and thus has no linking requirements.

Category: Events

See Also:

Instance Method Summary collapse

Methods inherited from KeyboardState

#alt_down, #cmd_down, #control_down, #get_modifiers, #has_any_modifiers, #has_modifiers, #meta_down, #raw_control_down, #set_alt_down, #set_control_down, #set_meta_down, #set_raw_control_down, #set_shift_down, #shift_down

Constructor Details

#initialize ⇒ Wx::MouseState

Default constructor.



70
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 70

def initialize; end

Instance Method Details

#aux1is_down ⇒ Boolean

Returns true if the first extra button mouse button is currently down.

Returns:

  • (Boolean) 


96
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 96

def aux1is_down; end

#aux2is_down ⇒ Boolean

Returns true if the second extra button mouse button is currently down.

Returns:

  • (Boolean) 


100
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 100

def aux2is_down; end

#get_position ⇒ Wx::Point Also known as: position

Returns the physical mouse position.

Returns:



65
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 65

def get_position; end

#get_x ⇒ Integer Also known as: x

Returns X coordinate of the physical mouse event position.

Returns:

  • (Integer) 


74
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 74

def get_x; end

#get_y ⇒ Integer Also known as: y

Returns Y coordinate of the physical mouse event position.

Returns:

  • (Integer) 


79
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 79

def get_y; end

#left_is_down ⇒ Boolean

Returns true if the left mouse button is currently down.

Returns:

  • (Boolean) 


84
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 84

def left_is_down; end

#middle_is_down ⇒ Boolean

Returns true if the middle mouse button is currently down.

Returns:

  • (Boolean) 


88
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 88

def middle_is_down; end

#right_is_down ⇒ Boolean

Returns true if the right mouse button is currently down.

Returns:

  • (Boolean) 


92
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 92

def right_is_down; end

#set_aux1down(down) ⇒ void Also known as: aux1down=

This method returns an undefined value.

Parameters:

  • down (Boolean) 


134
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 134

def set_aux1down(down) end

#set_aux2down(down) ⇒ void Also known as: aux2down=

This method returns an undefined value.

Parameters:

  • down (Boolean) 


139
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 139

def set_aux2down(down) end

#set_left_down(down) ⇒ void Also known as: left_down=

This method returns an undefined value.

Parameters:

  • down (Boolean) 


119
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 119

def set_left_down(down) end

#set_middle_down(down) ⇒ void Also known as: middle_down=

This method returns an undefined value.

Parameters:

  • down (Boolean) 


124
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 124

def set_middle_down(down) end

#set_position(pos) ⇒ void Also known as: position=

This method returns an undefined value.

Parameters:



114
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 114

def set_position(pos) end

#set_right_down(down) ⇒ void Also known as: right_down=

This method returns an undefined value.

Parameters:

  • down (Boolean) 


129
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 129

def set_right_down(down) end

#set_state(state) ⇒ void Also known as: state=

This method returns an undefined value.

Parameters:



144
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 144

def set_state(state) end

#set_x(x) ⇒ void Also known as: x=

This method returns an undefined value.

Parameters:

  • x (Integer) 


104
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 104

def set_x(x) end

#set_y(y) ⇒ void Also known as: y=

This method returns an undefined value.

Parameters:

  • y (Integer) 


109
 
# File 'lib/wx/doc/gen/mouse_state.rb', line 109

def set_y(y) end