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

Class to store information for the Visible area of a window and provide work area to screen conversion. More...

#include <visiblearea.h>

Public Member Functions

 VisibleArea ()
 Construct an uninitialised visible area.
 
 VisibleArea (int *block)
 Construct a visible area from an array of 6 integers as provided by Wimp calls.
 
const BBoxbounds () const
 The visible area of the window on the screen. More...
 
BBoxbounds ()
 The visible area of the window on the screen. More...
 
const Pointscroll () const
 The scroll offset of the work area within the window.
 
Pointscroll ()
 The scroll offset of the work area within the window.
 
int work_x (int scr_x) const
 Convert screen x coordinate to work area.
 
int work_y (int scr_y) const
 Convert screen y coordinate to work area.
 
Pointwork (const Point &scr_pt, Point &work_pt) const
 Convert point from screen coordinates to work area coordinates. More...
 
Point work (const Point &scr_pt) const
 Convert point from screen coordinates to work area coordinates. More...
 
BBoxwork (const BBox &scr_box, BBox &work_box) const
 Convert bounding box from screen coordinates to work area coordinates. More...
 
BBox work (const BBox &scr_box) const
 Convert bounding box from screen coordinates to work area coordinates. More...
 
int screen_x (int work_x) const
 Convert work area x coordinate to screen.
 
int screen_y (int work_y) const
 Convert work area y coordinate to screen area.
 
Pointscreen (const Point &work_pt, Point &scr_pt) const
 Convert point from work coordinates to screen area coordinates. More...
 
Point screen (const Point &work_pt) const
 Convert point from work area coordinates to screen coordinates. More...
 
BBoxscreen (const BBox &work_box, BBox &scr_box) const
 Convert bounding box from work area coordinates to screen coordinates. More...
 
BBox screen (const BBox &work_box) const
 Convert bounding box from work area coordinates to screen coordinates. More...
 

Detailed Description

Class to store information for the Visible area of a window and provide work area to screen conversion.

Member Function Documentation

◆ bounds() [1/2]

BBox& tbx::VisibleArea::bounds ( )
inline

The visible area of the window on the screen.

(screen coordinates)

◆ bounds() [2/2]

const BBox& tbx::VisibleArea::bounds ( ) const
inline

The visible area of the window on the screen.

(screen coordinates)

◆ screen() [1/4]

BBox tbx::VisibleArea::screen ( const BBox work_box) const
inline

Convert bounding box from work area coordinates to screen coordinates.

Parameters
work_boxwork area BBox to convert
Returns
copy of box converted to screen coordinates

◆ screen() [2/4]

BBox& tbx::VisibleArea::screen ( const BBox work_box,
BBox scr_box 
) const
inline

Convert bounding box from work area coordinates to screen coordinates.

Parameters
work_boxWork area BBox to convert
scr_boxScreen BBox to store result
Returns
reference to scr_box

◆ screen() [3/4]

Point tbx::VisibleArea::screen ( const Point work_pt) const
inline

Convert point from work area coordinates to screen coordinates.

Parameters
work_ptwork area point to convert
Returns
point converted to screen coordinates

◆ screen() [4/4]

Point& tbx::VisibleArea::screen ( const Point work_pt,
Point scr_pt 
) const
inline

Convert point from work coordinates to screen area coordinates.

Parameters
work_ptWork area point to convertt
scr_ptScreen point to store resul
Returns
reference to scr_pt

◆ work() [1/4]

BBox tbx::VisibleArea::work ( const BBox scr_box) const
inline

Convert bounding box from screen coordinates to work area coordinates.

Parameters
scr_boxScreen BBox to convert
Returns
copy of box converted to work area coordinates

◆ work() [2/4]

BBox& tbx::VisibleArea::work ( const BBox scr_box,
BBox work_box 
) const
inline

Convert bounding box from screen coordinates to work area coordinates.

Parameters
scr_boxScreen BBox to convert
work_boxWork area BBox to store result
Returns
reference to work_box

◆ work() [3/4]

Point tbx::VisibleArea::work ( const Point scr_pt) const
inline

Convert point from screen coordinates to work area coordinates.

Parameters
scr_ptScreen point to convert
Returns
point converted to work area coordinates

◆ work() [4/4]

Point& tbx::VisibleArea::work ( const Point scr_pt,
Point work_pt 
) const
inline

Convert point from screen coordinates to work area coordinates.

Parameters
scr_ptScreen point to convert
work_ptWork area point to store result
Returns
reference to work_pt

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