WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIScrollable

IID:919e792a-6490-40b8-bba5-f9e9ad5640c8
Inherits From:nsISupports

The nsIScrollable is an interface that can be implemented by a control that supports scrolling. This is a generic interface without concern for the type of content that may be inside. It simply deals blindly with scroll position as a composite of the lowest possible scroll position, the highest possible position and the current position lying somewhere between the min and the max.

This interface is implemented by the following components:

Constants

PRInt32 ScrollOrientation_X = 1
PRInt32 ScrollOrientation_Y = 2
PRInt32 Scrollbar_Auto = 1
PRInt32 Scrollbar_Never = 2
PRInt32 Scrollbar_Always = 3

Methods

PRInt32 getCurScrollPos ( PRInt32 scrollOrientation ) PRInt32 getDefaultScrollbarPreferences ( PRInt32 scrollOrientation ) void getScrollbarVisibility ( out PRBool verticalVisible , out PRBool horizontalVisible ) void getScrollRange ( PRInt32 scrollOrientation , out PRInt32 minPos , out PRInt32 maxPos ) void setCurScrollPos ( PRInt32 scrollOrientation , PRInt32 curPos ) void setCurScrollPosEx ( PRInt32 curHorizontalPos , PRInt32 curVerticalPos ) void setDefaultScrollbarPreferences ( PRInt32 scrollOrientation , PRInt32 scrollbarPref ) void setScrollRange ( PRInt32 scrollOrientation , PRInt32 minPos , PRInt32 maxPos ) void setScrollRangeEx ( PRInt32 minHorizontalPos , PRInt32 maxHorizontalPos , PRInt32 minVerticalPos , PRInt32 maxVerticalPos )

PRInt32 getCurScrollPos ( PRInt32 scrollOrientation )

Arguments:
scrollOrientation

PRInt32 getDefaultScrollbarPreferences ( PRInt32 scrollOrientation )

Arguments:
scrollOrientation

void getScrollbarVisibility ( out PRBool verticalVisible , out PRBool horizontalVisible )

Arguments:
verticalVisible
horizontalVisible

void getScrollRange ( PRInt32 scrollOrientation , out PRInt32 minPos , out PRInt32 maxPos )

Arguments:
scrollOrientation
minPos
maxPos

void setCurScrollPos ( PRInt32 scrollOrientation , PRInt32 curPos )

Arguments:
scrollOrientation
curPos

void setCurScrollPosEx ( PRInt32 curHorizontalPos , PRInt32 curVerticalPos )

Arguments:
curHorizontalPos
curVerticalPos

void setDefaultScrollbarPreferences ( PRInt32 scrollOrientation , PRInt32 scrollbarPref )

Arguments:
scrollOrientation
scrollbarPref

void setScrollRange ( PRInt32 scrollOrientation , PRInt32 minPos , PRInt32 maxPos )

Arguments:
scrollOrientation
minPos
maxPos

void setScrollRangeEx ( PRInt32 minHorizontalPos , PRInt32 maxHorizontalPos , PRInt32 minVerticalPos , PRInt32 maxVerticalPos )

Arguments:
minHorizontalPos
maxHorizontalPos
minVerticalPos
maxVerticalPos

Reference documentation is generated from Mozilla's source.