Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions
nsIScrollableFrame Class Reference

#include <nsIScrollableFrame.h>

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

List of all members.

Public Types

typedef
nsPresContext::ScrollbarStyles 
ScrollbarStyles

Public Member Functions

virtual nsIFrameGetScrolledFrame () const =0
 Get the frame that we are scrolling within the scrollable frame.
virtual ScrollbarStyles GetScrollbarStyles () const =0
virtual nsMargin GetActualScrollbarSizes () const =0
 Return the actual sizes of all possible scrollbars.
virtual nsMargin GetDesiredScrollbarSizes (nsBoxLayoutState *aState)=0
 Return the sizes of all scrollbars assuming that any scrollbars that could be visible due to overflowing content, are.
virtual nsPoint GetScrollPosition () const =0
 Get the position of the scrolled view.
virtual void ScrollTo (nsPoint aScrollPosition, PRUint32 aFlags=NS_VMREFRESH_NO_SYNC)=0
 Scroll the view to the given x,y, update's the scrollbar's thumb positions and the view's offset.
virtual nsIScrollableViewGetScrollableView ()=0
virtual void SetScrollbarVisibility (PRBool aVerticalVisible, PRBool aHorizontalVisible)=0
 Set information about whether the vertical and horizontal scrollbars are currently visible.
virtual nsIBox * GetScrollbarBox (PRBool aVertical)=0
virtual void CurPosAttributeChanged (nsIContent *aChild, PRInt32 aModType)=0
virtual void ScrollToRestoredPosition ()=0
 This tells the scroll frame to try scrolling to the scroll position that was restored from the history.

Detailed Description

Definition at line 55 of file nsIScrollableFrame.h.


Member Typedef Documentation

Definition at line 66 of file nsIScrollableFrame.h.


Member Function Documentation

virtual void nsIScrollableFrame::CurPosAttributeChanged ( nsIContent aChild,
PRInt32  aModType 
) [pure virtual]

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

virtual nsMargin nsIScrollableFrame::GetActualScrollbarSizes ( ) const [pure virtual]

Return the actual sizes of all possible scrollbars.

Returns 0 for scrollbar positions that don't have a scrollbar or where the scrollbar is not visible. Do not call this while this frame's descendants are being reflowed, it won't be accurate.

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

Return the sizes of all scrollbars assuming that any scrollbars that could be visible due to overflowing content, are.

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

Implements nsIScrollableViewProvider.

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

virtual nsIBox* nsIScrollableFrame::GetScrollbarBox ( PRBool  aVertical) [pure virtual]

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

virtual ScrollbarStyles nsIScrollableFrame::GetScrollbarStyles ( ) const [pure virtual]

Implemented in nsXULScrollFrame, nsHTMLScrollFrame, and nsListControlFrame.

Here is the caller graph for this function:

virtual nsIFrame* nsIScrollableFrame::GetScrolledFrame ( ) const [pure virtual]

Get the frame that we are scrolling within the scrollable frame.

Returns:
child frame

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

virtual nsPoint nsIScrollableFrame::GetScrollPosition ( ) const [pure virtual]

Get the position of the scrolled view.

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

virtual void nsIScrollableFrame::ScrollTo ( nsPoint  aScrollPosition,
PRUint32  aFlags = NS_VMREFRESH_NO_SYNC 
) [pure virtual]

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 nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

This tells the scroll frame to try scrolling to the scroll position that was restored from the history.

This must be called at least once after state has been restored. It is called by the scrolled frame itself during reflow, but sometimes state can be restored after reflows are done...

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:

virtual void nsIScrollableFrame::SetScrollbarVisibility ( PRBool  aVerticalVisible,
PRBool  aHorizontalVisible 
) [pure virtual]

Set information about whether the vertical and horizontal scrollbars are currently visible.

Implemented in nsXULScrollFrame, and nsHTMLScrollFrame.

Here is the caller graph for this function:


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