Class: Wx::ScrollWinEvent

Inherits:

Event

• Object
• Object
• Event
• Wx::ScrollWinEvent

Defined in:

lib/wx/doc/gen/events.rb

Overview

A scroll event holds information about events sent from scrolling windows.

Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events from the receiving window.

Events using this class

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

• EvtHandler#evt_scrollwin(meth = nil, &block): Process all scroll events.

• EvtHandler#evt_scrollwin_top(meth = nil, &block): Process EVT_SCROLLWIN_TOP scroll-to-top events.

• EvtHandler#evt_scrollwin_bottom(meth = nil, &block): Process EVT_SCROLLWIN_BOTTOM scroll-to-bottom events.

• EvtHandler#evt_scrollwin_lineup(meth = nil, &block): Process EVT_SCROLLWIN_LINEUP line up events.

• EvtHandler#evt_scrollwin_linedown(meth = nil, &block): Process EVT_SCROLLWIN_LINEDOWN line down events.

• EvtHandler#evt_scrollwin_pageup(meth = nil, &block): Process EVT_SCROLLWIN_PAGEUP page up events.

• EvtHandler#evt_scrollwin_pagedown(meth = nil, &block): Process EVT_SCROLLWIN_PAGEDOWN page down events.

• EvtHandler#evt_scrollwin_thumbtrack(meth = nil, &block): Process EVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent as the user drags the thumbtrack).

• EvtHandler#evt_scrollwin_thumbrelease(meth = nil, &block): Process EVT_SCROLLWIN_THUMBRELEASE thumb release events.

Category: Events

See Also:

• ScrollEvent
• and Event Handling

Instance Method Summary

• #get_orientation ⇒ Integer (also: #orientation)

  Returns Orientation::HORIZONTAL or Orientation::VERTICAL, depending on the orientation of the scrollbar.

• #get_pixel_offset ⇒ Integer (also: #pixel_offset)

  Offset of the scroll position from the nearest position expressed in scroll units.

• #get_position ⇒ Integer (also: #position)

  Returns the position of the scrollbar for the thumb track and release events.

• #initialize(commandType = Wx::EVT_NULL, pos = 0, orientation = 0) ⇒ Wx::ScrollWinEvent constructor

  Constructor.

• #set_orientation(orient) ⇒ void (also: #orientation=)
• #set_position(pos) ⇒ void (also: #position=)

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(commandType = Wx::EVT_NULL, pos = 0, orientation = 0) ⇒ Wx::ScrollWinEvent

Constructor.

Parameters:

• commandType (Wx::GRID::Grid::EventType) (defaults to: Wx::EVT_NULL)
• pos (Integer) (defaults to: 0)
• orientation (Integer) (defaults to: 0)

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

def initialize(commandType=Wx::EVT_NULL, pos=0, orientation=0) end

Instance Method Details

#get_orientation ⇒ Integer Also known as: orientation

Returns Orientation::HORIZONTAL or Orientation::VERTICAL, depending on the orientation of the scrollbar.

TodoOrientation::HORIZONTAL and Orientation::VERTICAL should go in their own enum

Returns:

• (Integer)

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

def get_orientation; end

#get_pixel_offset ⇒ Integer Also known as: pixel_offset

Offset of the scroll position from the nearest position expressed in scroll units.

In cases where scrolling is possible with single pixel precision, such as when panning on a touch screen with fingers, this returns the offset in pixels of the real position compared to the position obtained by multiplying the current scroll position in scroll units by the size of scroll unit in pixels. For example, if the scroll unit size (pixels per line) is 20px, this function returns a value which can be between 0 and 19.

Returns:

• (Integer)

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

def get_pixel_offset; end

#get_position ⇒ Integer Also known as: position

Returns the position of the scrollbar for the thumb track and release events.

Note that this field can’t be used for the other events, you need to query the window itself for the current position in that case.

Returns:

• (Integer)

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

def get_position; end

#set_orientation(orient) ⇒ void Also known as: orientation=

This method returns an undefined value.

Parameters:

• orient (Integer)

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

def set_orientation(orient) end

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

This method returns an undefined value.

Parameters:

• pos (Integer)

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

def set_position(pos) end