LLScrollableContainerView Class Reference

#include <llscrollcontainer.h>

Inheritance diagram for LLScrollableContainerView:

[legend]Collaboration diagram for LLScrollableContainerView:


Public Types
	VERTICAL
	HORIZONTAL
	SCROLLBAR_COUNT
enum	SCROLL_ORIENTATION { VERTICAL, HORIZONTAL, SCROLLBAR_COUNT }
Public Member Functions
	LLScrollableContainerView (const LLString &name, const LLRect &rect, LLView *scrolled_view, BOOL is_opaque=FALSE, const LLColor4 &bg_color=LLColor4(0, 0, 0, 0))
	LLScrollableContainerView (const LLString &name, const LLRect &rect, LLUICtrl *scrolled_ctrl, BOOL is_opaque=FALSE, const LLColor4 &bg_color=LLColor4(0, 0, 0, 0))
virtual	~LLScrollableContainerView (void)
void	init ()
void	setScrolledView (LLView *view)
virtual void	setValue (const LLSD &value)
virtual EWidgetType	getWidgetType () const
virtual LLString	getWidgetTag () const
void	calcVisibleSize (S32 visible_width, S32 visible_height, BOOL show_h_scrollbar, BOOL show_v_scrollbar)
void	calcVisibleSize (const LLRect &doc_rect, S32 visible_width, S32 visible_height, BOOL show_h_scrollbar, BOOL show_v_scrollbar)
void	setBorderVisible (BOOL b)
void	scrollToShowRect (const LLRect &rect, const LLCoordGL &desired_offset)
void	setReserveScrollCorner (BOOL b)
const LLRect &	getScrolledViewRect ()
void	pageUp (S32 overlap=0)
void	pageDown (S32 overlap=0)
void	goToTop ()
void	goToBottom ()
S32	getBorderWidth ()
BOOL	needsToScroll (S32 x, S32 y, SCROLL_ORIENTATION axis)
virtual void	reshape (S32 width, S32 height, BOOL called_from_parent)
virtual BOOL	handleKey (KEY key, MASK mask, BOOL called_from_parent)
virtual BOOL	handleScrollWheel (S32 x, S32 y, S32 clicks)
virtual BOOL	handleDragAndDrop (S32 x, S32 y, MASK mask, BOOL drop, EDragAndDropType cargo_type, void cargo_data, EAcceptance accept, LLString &tooltip_msg)
virtual BOOL	handleToolTip (S32 x, S32 y, LLString &msg, LLRect *sticky_rect)
virtual void	draw ()
virtual LLXMLNodePtr	getXML (bool save_children=true) const
Static Public Member Functions
static void	horizontalChange (S32 new_pos, LLScrollbar sb, void user_data)
static void	verticalChange (S32 new_pos, LLScrollbar sb, void user_data)
static LLView *	fromXML (LLXMLNodePtr node, LLView parent, LLUICtrlFactory factory)
Protected Member Functions
virtual void	scrollHorizontal (S32 new_pos)
virtual void	scrollVertical (S32 new_pos)
void	updateScroll ()
Protected Attributes
LLScrollbar *	mScrollbar [SCROLLBAR_COUNT]
LLView *	mScrolledView
S32	mSize
BOOL	mIsOpaque
LLColor4	mBackgroundColor
LLRect	mInnerRect
LLViewBorder *	mBorder
BOOL	mReserveScrollCorner
BOOL	mAutoScrolling
F32	mAutoScrollRate

Detailed Description

Definition at line 58 of file llscrollcontainer.h.

Member Enumeration Documentation

enum LLScrollableContainerView::SCROLL_ORIENTATION

Enumerator:

VERTICAL
HORIZONTAL
SCROLLBAR_COUNT

Definition at line 63 of file llscrollcontainer.h.

Constructor & Destructor Documentation

LLScrollableContainerView::LLScrollableContainerView	(	const LLString &	name,
		const LLRect &	rect,
		LLView *	scrolled_view,
		BOOL	is_opaque = `FALSE`,
		const LLColor4 &	bg_color = `LLColor4(0,0,0,0)`
	)

---------------------------------------------------------------------------- Class LLScrollableContainerView ----------------------------------------------------------------------------

Definition at line 72 of file llscrollcontainer.cpp.

References LLView::addChild(), init(), and mScrolledView.

Referenced by fromXML().

LLScrollableContainerView::LLScrollableContainerView	(	const LLString &	name,
		const LLRect &	rect,
		LLUICtrl *	scrolled_ctrl,
		BOOL	is_opaque = `FALSE`,
		const LLColor4 &	bg_color = `LLColor4(0, 0, 0, 0)`
	)

Definition at line 94 of file llscrollcontainer.cpp.

References LLView::addChild(), and init().

LLScrollableContainerView::~LLScrollableContainerView ( void ) [virtual]

Definition at line 157 of file llscrollcontainer.cpp.

References i, mScrollbar, mScrolledView, NULL, S32, and SCROLLBAR_COUNT.

Member Function Documentation

void LLScrollableContainerView::calcVisibleSize	(	const LLRect &	doc_rect,
		S32 *	visible_width,
		S32 *	visible_height,
		BOOL *	show_h_scrollbar,
		BOOL *	show_v_scrollbar
	)

Definition at line 432 of file llscrollcontainer.cpp.

References FALSE, LLViewBorder::getBorderWidth(), LLRectBase< Type >::getHeight(), LLRectBase< Type >::getWidth(), mBorder, LLView::mRect, S32, SCROLLBAR_SIZE, and TRUE.

void LLScrollableContainerView::calcVisibleSize	(	S32 *	visible_width,
		S32 *	visible_height,
		BOOL *	show_h_scrollbar,
		BOOL *	show_v_scrollbar
	)

Definition at line 426 of file llscrollcontainer.cpp.

References LLView::getRect(), and mScrolledView.

Referenced by LLFolderView::arrange(), draw(), reshape(), LLFolderView::reshape(), scrollToShowRect(), LLFolderView::startRenamingSelectedItem(), and updateScroll().

void LLScrollableContainerView::draw ( ) [virtual]

LLView * LLScrollableContainerView::fromXML	(	LLXMLNodePtr	node,
		LLView *	parent,
		LLUICtrlFactory *	factory
	)			`[static]`

Definition at line 763 of file llscrollcontainer.cpp.

References LLUICtrlFactory::createCtrlWidget(), LLView::createRect(), FALSE, LLUICtrlFactory::getAttributeColor(), llendl, llinfos, LLScrollableContainerView(), mScrolledView, LLPointer< Type >::notNull(), LLRectBase< Type >::null, and NULL.

S32 LLScrollableContainerView::getBorderWidth ( )

Definition at line 730 of file llscrollcontainer.cpp.

References LLViewBorder::getBorderWidth(), and mBorder.

Referenced by LLFolderView::scrollToShowItem().

const LLRect& LLScrollableContainerView::getScrolledViewRect ( ) [inline]

Definition at line 91 of file llscrollcontainer.h.

References LLView::getRect(), and mScrolledView.

virtual LLString LLScrollableContainerView::getWidgetTag ( ) const [inline, virtual]

Implements LLView.

Definition at line 79 of file llscrollcontainer.h.

References LL_SCROLLABLE_CONTAINER_VIEW_TAG.

virtual EWidgetType LLScrollableContainerView::getWidgetType ( ) const [inline, virtual]

Implements LLView.

Definition at line 78 of file llscrollcontainer.h.

References WIDGET_TYPE_SCROLL_CONTAINER.

LLXMLNodePtr LLScrollableContainerView::getXML ( bool save_children = true ) const [virtual]

Reimplemented from LLUICtrl.

Definition at line 741 of file llscrollcontainer.cpp.

References LLView::getXML(), mBackgroundColor, mIsOpaque, mScrolledView, LLColor4::mV, and TRUE.

void LLScrollableContainerView::goToBottom ( )

Definition at line 725 of file llscrollcontainer.cpp.

References mScrollbar, LLScrollbar::setDocPos(), and VERTICAL.

Referenced by LLFolderView::handleKeyHere().

void LLScrollableContainerView::goToTop ( )

Definition at line 720 of file llscrollcontainer.cpp.

References mScrollbar, LLScrollbar::setDocPos(), and VERTICAL.

Referenced by LLFolderView::handleKeyHere().

BOOL LLScrollableContainerView::handleDragAndDrop	(	S32	x,
		S32	y,
		MASK	mask,
		BOOL	drop,
		EDragAndDropType	cargo_type,
		void *	cargo_data,
		EAcceptance *	accept,
		LLString &	tooltip_msg
	)			`[virtual]`