X11 Work Bench Toolkit  1.0
__WB_SCROLLINFO__ Struct Reference

Structure that defines scroll bar info for both horizontal and vertical scroll bars. More...

#include <window_dressing.h>

Data Fields

int iScrollState
 scroll state flags - see enumeration WBScrollState_ENUM
 
int iVScrollWidth
 calculated width of vertical scroll bar (in pixels); 0 if not known
 
int iHScrollHeight
 calculated height of horizontal scroll bar (in pixels); 0 if not known
 
int iVBarHeight
 calculated height of vertical scroll bar (re-calculate on window size change)
 
int iHBarWidth
 calculated width of horizontal scroll bar (re-calculate on window size change)
 
int iHKnob
 calculated relative X pixel position of horizontal scroll 'knob'
 
int iVKnob
 calculated relative Y pixel position of vertical scroll 'knob'
 
int iHKnobSize
 calculated pixel width of horizontal scroll 'knob'
 
int iVKnobSize
 calculated pixel height of vertical scroll 'knob'
 
int iHMin
 minimum horizontal range (0 if no bar)
 
int iHMax
 maximum horizontal range (0 if no bar)
 
int iVMin
 minimum vertical range (0 if no bar)
 
int iVMax
 maximum vertical range (0 if no bar)
 
int iHPos
 current horozontal scroll position (N/A if outside of min/max range)
 
int iVPos
 current vertical scroll position (N/A if outside of min/max range)
 
WB_GEOM geomHBar
 geometry for the horizontal scroll bar excluding border (empty if not visible)
 
WB_GEOM geomHLeft
 geometry for the horizontal scroll bar 'left' button (empty if not visible)
 
WB_GEOM geomHRight
 geometry for the horizontal scroll bar 'right' button (empty if not visible)
 
WB_GEOM geomHKnob
 geometry for the horizontal scroll bar 'knob' (empty if not visible)
 
WB_GEOM geomVBar
 geometry for the vertical scroll bar excluding border (empty if not visible)
 
WB_GEOM geomVUp
 geometry for the vertical scroll bar 'up' button (empty if not visible)
 
WB_GEOM geomVDown
 geometry for the vertical scroll bar 'down' button (empty if not visible)
 
WB_GEOM geomVKnob
 geometry for the vertical scroll bar 'knob' (empty if not visible)
 

Detailed Description

Structure that defines scroll bar info for both horizontal and vertical scroll bars.

This structure defines the scroll bar information for both vertical and horizontal scroll bars. You can have both a horizontal AND a vertical scroll bar at the same time. This structure is maintained by various API functions, particularly WBUpdateScrollBarGeometry().

typedef struct __WB_SCROLLINFO__
{
int iScrollState; // scroll state flags - see enumeration \ref WBScrollState_ENUM
// fixed dimension sizes - 0 if not known, else based on owner client width/height
int iVScrollWidth; // calculated width of vertical scroll bar (in pixels); 0 if not known
int iHScrollHeight; // calculated height of horizontal scroll bar (in pixels); 0 if not known
int iVBarHeight; // calculated height of vertical scroll bar (re-calculate on window size change)
int iHBarWidth; // calculated width of horizontal scroll bar (re-calculate on window size change)
int iHKnob; // calculated relative X pixel position of horizontal scroll 'knob'
int iVKnob; // calculated relative Y pixel position of vertical scroll 'knob'
int iHKnobSize; // calculated pixel width of horizontal scroll 'knob'
int iVKnobSize; // calculated pixel height of vertical scroll 'knob'
int iHMin; // minimum horizontal range (0 if no bar)
int iHMax; // maximum horizontal range (0 if no bar)
int iVMin; // minimum vertical range (0 if no bar)
int iVMax; // maximum vertical range (0 if no bar)
int iHPos; // current horozontal scroll position (N/A if outside of min/max range)
int iVPos; // current vertical scroll position (N/A if outside of min/max range)
WB_GEOM geomHBar; // geometry for the horizontal scroll bar excluding border (empty if not visible)
WB_GEOM geomHLeft; // geometry for the horizontal scroll bar 'left' button (empty if not visible)
WB_GEOM geomHRight; // geometry for the horizontal scroll bar 'right' button (empty if not visible)
WB_GEOM geomHKnob; // geometry for the horizontal scroll bar 'knob' (empty if not visible)
WB_GEOM geomVBar; // geometry for the vertical scroll bar excluding border (empty if not visible)
WB_GEOM geomVUp; // geometry for the vertical scroll bar 'up' button (empty if not visible)
WB_GEOM geomVDown; // geometry for the vertical scroll bar 'down' button (empty if not visible)
WB_GEOM geomVKnob; // geometry for the vertical scroll bar 'knob' (empty if not visible)
See Also
WBInitScrollInfo(), WBUpdateScrollBarGeometry()

Definition at line 117 of file window_dressing.h.


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