Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIScrollableView_MOZILLA_1_8_BRANCH Class Reference

#include <nsIScrollableView.h>

Inheritance diagram for nsIScrollableView_MOZILLA_1_8_BRANCH:
Inheritance graph
[legend]
Collaboration diagram for nsIScrollableView_MOZILLA_1_8_BRANCH:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD ScrollByPixels (PRInt32 aNumPixelsX, PRInt32 aNumPixelsY)=0
 Scroll the view left or right by aNumLinesX pixels.
NS_IMETHOD CreateScrollControls (nsNativeWidget aNative=nsnull)=0
 Create the controls used to allow scrolling.
NS_IMETHOD GetContainerSize (nscoord *aWidth, nscoord *aHeight) const =0
 Get the dimensions of the container.
NS_IMETHOD SetScrolledView (nsIView *aScrolledView)=0
 Set the view that we are scrolling within the scrolling view.
NS_IMETHOD GetScrolledView (nsIView *&aScrolledView) const =0
 Get the view that we are scrolling within the scrolling view.
NS_IMETHOD GetScrollPosition (nscoord &aX, nscoord &aY) const =0
 Get the position of the scrolled view.
NS_IMETHOD ScrollTo (nscoord aX, nscoord aY, PRUint32 aUpdateFlags)=0
 Scroll the view to the given x,y, update's the scrollbar's thumb positions and the view's offset.
NS_IMETHOD SetScrollProperties (PRUint32 aProperties)=0
 Set the properties describing how scrolling can be performed in this scrollable.
NS_IMETHOD GetScrollProperties (PRUint32 *aProperties)=0
 Get the properties describing how scrolling can be performed in this scrollable.
NS_IMETHOD SetLineHeight (nscoord aHeight)=0
 Set the height of a line used for line scrolling.
NS_IMETHOD GetLineHeight (nscoord *aHeight)=0
 Get the height of a line used for line scrolling.
NS_IMETHOD ScrollByLines (PRInt32 aNumLinesX, PRInt32 aNumLinexY)=0
 Scroll the view left or right by aNumLinesX columns.
NS_IMETHOD GetPageScrollDistances (nsSize *aDistances)=0
 Get the desired size of a page scroll in each dimension.
NS_IMETHOD ScrollByPages (PRInt32 aNumPagesX, PRInt32 aNumPagesY)=0
 Scroll the view left or right by aNumPagesX pages.
NS_IMETHOD ScrollByWhole (PRBool aTop)=0
 Scroll the view to the top or bottom of the document depending on the value of aTop.
NS_IMETHOD CanScroll (PRBool aHorizontal, PRBool aForward, PRBool &aResult)=0
 Check the view can scroll from current offset.
 NS_IMETHOD_ (nsIView *) View()=0
 Returns the view as an nsIView*.
NS_IMETHOD AddScrollPositionListener (nsIScrollPositionListener *aListener)=0
 Adds a scroll position listener.
NS_IMETHOD RemoveScrollPositionListener (nsIScrollPositionListener *aListener)=0
 Removes a scroll position listener.

Detailed Description

Definition at line 216 of file nsIScrollableView.h.


Member Function Documentation

Adds a scroll position listener.

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::CanScroll ( PRBool  aHorizontal,
PRBool  aForward,
PRBool aResult 
) [pure virtual, inherited]

Check the view can scroll from current offset.

Parameters:
aHorizontalIf checking to Left or to Right, true. Otherwise, false.
aForwardIf checking to Right or Bottom, true. Otherwise, false.
aResultIf the view can scroll, true. Otherwise, false.
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::CreateScrollControls ( nsNativeWidget  aNative = nsnull) [pure virtual, inherited]

Create the controls used to allow scrolling.

Call this method before anything else is done with the scrollable view.

Parameters:
aNativenative widget to use as parent for control widgets
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::GetContainerSize ( nscoord aWidth,
nscoord aHeight 
) const [pure virtual, inherited]

Get the dimensions of the container.

Parameters:
aWidthreturn value for width of container
aHeightreturn value for height of container

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::GetLineHeight ( nscoord aHeight) [pure virtual, inherited]

Get the height of a line used for line scrolling.

Parameters:
aHeightout parameter for line height
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::GetPageScrollDistances ( nsSize aDistances) [pure virtual, inherited]

Get the desired size of a page scroll in each dimension.

ScrollByPages will scroll by independent multiples of these amounts unless it hits the edge of the view.

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::GetScrolledView ( nsIView *&  aScrolledView) const [pure virtual, inherited]

Get the view that we are scrolling within the scrolling view.

Returns:
child view

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::GetScrollPosition ( nscoord aX,
nscoord aY 
) const [pure virtual, inherited]

Get the position of the scrolled view.

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::GetScrollProperties ( PRUint32 aProperties) [pure virtual, inherited]

Get the properties describing how scrolling can be performed in this scrollable.

Parameters:
aPropertiesout parameter for current properties
Returns:
error status

Implemented in nsScrollPortView.

nsIScrollableView::NS_IMETHOD_ ( nsIView ) [pure virtual, inherited]

Returns the view as an nsIView*.

Implemented in nsScrollPortView.

Removes a scroll position listener.

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::ScrollByLines ( PRInt32  aNumLinesX,
PRInt32  aNumLinexY 
) [pure virtual, inherited]

Scroll the view left or right by aNumLinesX columns.

Positive values move right. Scroll the view up or down by aNumLinesY lines. Positive values move down. Prevents scrolling off the end of the view.

Parameters:
aNumLinesXnumber of lines to scroll the view horizontally
aNumLinesYnumber of lines to scroll the view vertically
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::ScrollByPages ( PRInt32  aNumPagesX,
PRInt32  aNumPagesY 
) [pure virtual, inherited]

Scroll the view left or right by aNumPagesX pages.

Positive values move right. Scroll the view up or down by aNumPagesY pages. Positive values move down. A page is considered to be the amount displayed by the clip view. Prevents scrolling off the end of the view.

Parameters:
aNumPagesXnumber of pages to scroll the view horizontally
aNumPagesYnumber of pages to scroll the view vertically
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView_MOZILLA_1_8_BRANCH::ScrollByPixels ( PRInt32  aNumPixelsX,
PRInt32  aNumPixelsY 
) [pure virtual]

Scroll the view left or right by aNumLinesX pixels.

Positive values move right. Scroll the view up or down by aNumLinesY pixels. Positive values move down. Prevents scrolling off the end of the view.

Parameters:
aNumLinesXnumber of lines to scroll the view horizontally
aNumLinesYnumber of lines to scroll the view vertically
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::ScrollByWhole ( PRBool  aTop) [pure virtual, inherited]

Scroll the view to the top or bottom of the document depending on the value of aTop.

Parameters:
aForwardindicates whether to scroll to top or bottom
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::ScrollTo ( nscoord  aX,
nscoord  aY,
PRUint32  aUpdateFlags 
) [pure virtual, inherited]

Scroll the view to the given x,y, update's the scrollbar's thumb positions and the view's offset.

Clamps the values to be legal. Updates the display based on aUpdateFlags.

Parameters:
aXleft edge to scroll to
aYtop edge to scroll to
aUpdateFlagspassed onto nsIViewManager->UpdateView()
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::SetLineHeight ( nscoord  aHeight) [pure virtual, inherited]

Set the height of a line used for line scrolling.

Parameters:
aHeightnew line height in app units. the default height is 12 points.
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::SetScrolledView ( nsIView aScrolledView) [pure virtual, inherited]

Set the view that we are scrolling within the scrolling view.

Implemented in nsScrollPortView.

Here is the caller graph for this function:

NS_IMETHOD nsIScrollableView::SetScrollProperties ( PRUint32  aProperties) [pure virtual, inherited]

Set the properties describing how scrolling can be performed in this scrollable.

Parameters:
aPropertiesnew properties
Returns:
error status

Implemented in nsScrollPortView.

Here is the caller graph for this function:


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