Class: Wx::SetCursorEvent

Inherits:
Event show all
Defined in:
lib/wx/doc/gen/events.rb

Overview

A SetCursorEvent is generated from Window when the mouse cursor is about to be set as a result of mouse motion.

This event gives the application the chance to perform specific mouse cursor processing based on the current position of the mouse within the window. Use #set_cursor to specify the cursor you want to be displayed.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for SetCursorEvent events. Event handler methods:

Category: Events

See Also:

Instance Method Summary collapse

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(x = 0, y = 0) ⇒ Wx::SetCursorEvent

Constructor, used by the library itself internally to initialize the event object.

Parameters:

  • x (Integer) (defaults to: 0)
  • y (Integer) (defaults to: 0) 


800
 
# File 'lib/wx/doc/gen/events.rb', line 800

def initialize(x=0, y=0) end

Instance Method Details

#get_cursor ⇒ Wx::Cursor Also known as: cursor

Returns a reference to the cursor specified by this event.

Returns:



804
 
# File 'lib/wx/doc/gen/events.rb', line 804

def get_cursor; end

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

Returns the mouse position for which the cursor is requested.

This position is expressed in the client coordinates of the window.

Returns:

See Also:



813
 
# File 'lib/wx/doc/gen/events.rb', line 813

def get_position; end

#get_x ⇒ Integer Also known as: x

Returns the X coordinate of the mouse in client coordinates.

Returns:

  • (Integer)

See Also:



821
 
# File 'lib/wx/doc/gen/events.rb', line 821

def get_x; end

#get_y ⇒ Integer Also known as: y

Returns the Y coordinate of the mouse in client coordinates.

Returns:

  • (Integer)

See Also:



829
 
# File 'lib/wx/doc/gen/events.rb', line 829

def get_y; end

#has_cursor ⇒ Boolean Also known as: has_cursor?

Returns true if the cursor specified by this event is a valid cursor.

Remark:

You cannot specify NULL_CURSOR with this event, as it is not considered a valid cursor.

Returns:

  • (Boolean) 


840
 
# File 'lib/wx/doc/gen/events.rb', line 840

def has_cursor; end

#set_cursor(cursor) ⇒ void Also known as: cursor=

This method returns an undefined value.

Sets the cursor associated with this event.

Parameters:



846
 
# File 'lib/wx/doc/gen/events.rb', line 846

def set_cursor(cursor) end