Class: Wx::Cursor
- Defined in:
- lib/wx/doc/gen/cursor.rb
Overview
This class is untracked and should not be derived from nor instances extended!
A cursor is a small bitmap usually used for denoting where the mouse pointer is, with a picture that might indicate the interpretation of a mouse click.
As with icons, cursors in X and MS Windows are created in a different manner. Therefore, separate cursors will be created for the different environments. Platform-specific methods for creating a Cursor object are catered for, and this is an occasion where conditional compilation will probably be required (see Icon for an example). A single cursor object may be used in many windows (any subwindow type). The wxWidgets convention is to set the cursor for a window, as in X, rather than to set it globally as in MS Windows, although a global set_cursor function is also available for MS Windows use.
Category: Graphics Device Interface (GDI) Predefined objects/pointers: - NULL_CURSOR - STANDARD_CURSOR - HOURGLASS_CURSOR - CROSS_CURSOR
Instance Method Summary collapse
-
#get_hot_spot ⇒ Wx::Point
(also: #hot_spot)
Returns the coordinates of the cursor hot spot.
-
#initialize(*args) ⇒ Cursor
constructor
A new instance of Cursor.
-
#is_ok ⇒ Boolean
(also: #ok?)
Returns true if cursor data is present.
Methods inherited from GDIObject
Methods inherited from Object
#clone, #dup, #is_same_as, #un_share
Constructor Details
#initialize ⇒ Wx::Cursor #initialize(cursorName, type = Wx::CURSOR_DEFAULT_TYPE, hotSpotX = 0, hotSpotY = 0) ⇒ Wx::Cursor #initialize(cursorId) ⇒ Wx::Cursor #initialize(image) ⇒ Wx::Cursor #initialize(cursor) ⇒ Wx::Cursor
Returns a new instance of Cursor.
79 |
# File 'lib/wx/doc/gen/cursor.rb', line 79 def initialize(*args) end |
Instance Method Details
#get_hot_spot ⇒ Wx::Point Also known as: hot_spot
Returns the coordinates of the cursor hot spot.
The hot spot is the point at which the mouse is actually considered to be when this cursor is used. This method is currently only implemented in WXMSW and WXGTK2+ and simply returns DEFAULT_POSITION in the other ports.
91 |
# File 'lib/wx/doc/gen/cursor.rb', line 91 def get_hot_spot; end |
#is_ok ⇒ Boolean Also known as: ok?
Returns true if cursor data is present.
83 |
# File 'lib/wx/doc/gen/cursor.rb', line 83 def is_ok; end |