All Frameworks Class Hierarchy This Framework Previous Next Indexes
Dialog Class CATDlgScrollBar
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---System.CATCommand
|
+---Dialog.CATDialog
|
+---Dialog.CATDlgControl
|
+---CATDlgScrollBar
Usage: you must use this class as is. You should never derive it.
public class CATDlgScrollBar
Base class for scale control.
Role:
This class allows the user to scroll a clipped object.
The scroll bar allows to set scrolling facilities to a scrollable dialog object.
A scroll bar consists in a field (a shaft) ended on both sides by a scroll arrow between
which an indicator (a scroll box, or thumb) shows the location of the data displayed with
respect to the whole data. A scroll bar can be horizontal or vertical.
Use scroll bar whenever you display areas that don't fit in the available space.
Constructor and Destructor Index
- o
CATDlgScrollBar(CATDialog*,CATString&,CATDlgStyle)
- Constructs a CATDlgScrollBar.
- o
~CATDlgScrollBar()
-
Method Index
- o
GetScrollBarDragNotification()
- Returns the event notification sent whenever the scroll box is dragged.
- o
GetScrollBarModifyNotification()
- Returns the event notification sent whenever the scroll arrows or the shaft is clicked.
- o
GetScrollBoxSize()
- Returns the scroll box size (number of displayed decimals).
- o
GetScrollPos()
- Returns the scroll box position.
- o
GetScrollRange(int&,int&)
- Retrieves the minimum and maximum values for the scroll bar range.
- o
SetScrollBoxSize(int)
- Sets the scroll box size (number of displayed decimals).
- o
SetScrollPos(int,int)
- Sets the scroll box position.
- o
SetScrollRange(int,int)
- Sets the minimum and maximum values for the scroll bar range.
Constructor and Destructor
o CATDlgScrollBar
-
Constructs a CATDlgScrollBar.
- Parameters:
-
- iParent
- The parent of the scroll bar.
- iObjectName
- The name of the scroll bar.
- iStyle
- The style of the scroll bar.
The style can be :
- NULL
- if no value is passed, for the default scroll bar,
- CATDlgCtrHorizontal
- for a horizontal scroll bar (this is the default),
- CATDlgCtrVertical
- for a vertical scroll bar.
o ~CATDlgScrollBar
public virtual ~CATDlgScrollBar( | ) |
-
Methods
o GetScrollBarDragNotification
-
Returns the event notification sent whenever the scroll box is dragged.
o GetScrollBarModifyNotification
-
Returns the event notification sent whenever the scroll arrows or the shaft is clicked.
o GetScrollBoxSize
public int GetScrollBoxSize( | ) |
-
Returns the scroll box size (number of displayed decimals).
o GetScrollPos
public int GetScrollPos( | ) |
-
Returns the scroll box position.
o GetScrollRange
public void GetScrollRange( | int& | oMin, |
| int& | oMax) |
-
Retrieves the minimum and maximum values for the scroll bar range.
- Parameters:
-
- oMin
- The returned minimum value for the scroll bar range.
- oMax
- The returned maximum value for the scroll bar range.
o SetScrollBoxSize
public void SetScrollBoxSize( | int | iSize) |
-
Sets the scroll box size (number of displayed decimals).
- Parameters:
-
- iSize
- The size to set for the scroll box.
o SetScrollPos
public int SetScrollPos( | int | iPosition, |
| int | iNotify | = 1 ) |
-
Sets the scroll box position.
The scroll box position must be set in the range defined by the minimum and maximum values.
- Parameters:
-
- iPosition
- The position to set for the scroll box.
- iNotify
- Set this parameter to a non null value if you want the corresponding notification to be sent.
Otherwise set it to 0, so no notification will be sent.
o SetScrollRange
public void SetScrollRange( | int | iMin, |
| int | iMax) |
-
Sets the minimum and maximum values for the scroll bar range.
- Parameters:
-
- iMin
- The minimum value to set for the scroll bar range.
- iMax
- The maximum value to set for the scroll bar range.
This object is included in the file: CATDlgScrollBar.h
If needed, your Imakefile.mk should include the module: DI0PANV2