tbx  0.7.6
Public Types | Public Member Functions | List of all members
tbx::ScrollRequestEvent Class Reference

Information for ScrollRequest listener. More...

#include <scrollrequestlistener.h>

Inheritance diagram for tbx::ScrollRequestEvent:
tbx::EventInfo

Public Types

enum  ScrollXDirection {
  PAGE_LEFT = -2, LEFT = -1, NONE_X = 0, RIGHT = 1,
  PAGE_RIGHT = 2
}
 Enumeration of how the window should be scrolled in the X direction. More...
 
enum  ScrollYDirection {
  PAGE_DOWN = -2, DOWN = -1, NONE_Y = 0, UP = 1,
  PAGE_UP = 2
}
 Enumeration of how the window should be scrolled in the y direction. More...
 

Public Member Functions

 ScrollRequestEvent (IdBlock &id_block, PollBlock &poll_block)
 Construct the event from Toolbox and WIMP event data. More...
 
const WindowOpenInfoopen_info () const
 Window open information with details of visible area and current scroll setttings.
 
ScrollXDirection x_scroll () const
 Direction requested for scroll in x direction.
 
ScrollYDirection y_scroll () const
 Direction requested for scroll in y direction.
 
- Public Member Functions inherited from tbx::EventInfo
 EventInfo (const IdBlock &id_block, PollBlock &data)
 Contruct the event information from the id_block and data update by the toolbox.
 
const IdBlockid_block () const
 IdBlock for the current event. More...
 

Additional Inherited Members

- Protected Attributes inherited from tbx::EventInfo
PollBlock_data
 raw data from the event
 

Detailed Description

Information for ScrollRequest listener.

Member Enumeration Documentation

◆ ScrollXDirection

Enumeration of how the window should be scrolled in the X direction.

Enumerator
PAGE_LEFT 

Scroll left by one page.

LEFT 

Scroll left by one.

NONE_X 

No scrolling in X direction.

RIGHT 

Scroll right by one.

PAGE_RIGHT 

Scroll right be one page.

◆ ScrollYDirection

Enumeration of how the window should be scrolled in the y direction.

Enumerator
PAGE_DOWN 

Scroll down by one page.

DOWN 

Scroll down by one.

NONE_Y 

No scrolling in Y direction.

UP 

Scroll up by one.

PAGE_UP 

Scroll up by one page.

Constructor & Destructor Documentation

◆ ScrollRequestEvent()

tbx::ScrollRequestEvent::ScrollRequestEvent ( IdBlock id_block,
PollBlock poll_block 
)
inline

Construct the event from Toolbox and WIMP event data.

Parameters
id_blockToolbox IDs for this event
poll_blockInformation returned from the WIMP for this event

The documentation for this class was generated from the following file: