LLScrollbar Class Reference

#include <llscrollbar.h>

Inheritance diagram for LLScrollbar:

[legend]Collaboration diagram for LLScrollbar:


Public Types
	HORIZONTAL
	VERTICAL
enum	ORIENTATION { HORIZONTAL, VERTICAL }
Public Member Functions
	LLScrollbar (const LLString &name, LLRect rect, ORIENTATION orientation, S32 doc_size, S32 doc_pos, S32 page_size, void(change_callback)(S32 new_pos, LLScrollbar self, void userdata), void callback_user_data=NULL, S32 step_size=1)
virtual	~LLScrollbar ()
virtual void	setValue (const LLSD &value)
virtual EWidgetType	getWidgetType () const
virtual LLString	getWidgetTag () const
virtual BOOL	handleKeyHere (KEY key, MASK mask, BOOL called_from_parent)
virtual BOOL	handleMouseDown (S32 x, S32 y, MASK mask)
virtual BOOL	handleMouseUp (S32 x, S32 y, MASK mask)
virtual BOOL	handleHover (S32 x, S32 y, MASK mask)
virtual BOOL	handleScrollWheel (S32 x, S32 y, S32 clicks)
virtual BOOL	handleDragAndDrop (S32 x, S32 y, MASK mask, BOOL drop, EDragAndDropType cargo_type, void carge_data, EAcceptance accept, LLString &tooltip_msg)
virtual void	reshape (S32 width, S32 height, BOOL called_from_parent=TRUE)
virtual void	draw ()
void	setDocParams (S32 size, S32 pos)
void	setDocSize (S32 size)
S32	getDocSize ()
void	setDocPos (S32 pos)
S32	getDocPos ()
void	setPageSize (S32 page_size)
S32	getPageSize ()
S32	getDocPosMax ()
void	pageUp (S32 overlap)
void	pageDown (S32 overlap)
void	setTrackColor (const LLColor4 &color)
void	setThumbColor (const LLColor4 &color)
void	setHighlightColor (const LLColor4 &color)
void	setShadowColor (const LLColor4 &color)
void	setOnScrollEndCallback (void(callback)(void ), void *userdata)
Static Public Member Functions
static void	onLineUpBtnPressed (void *userdata)
static void	onLineDownBtnPressed (void *userdata)
Protected Member Functions
void	updateThumbRect ()
void	changeLine (S32 delta, BOOL update_thumb)
Protected Attributes
void(*	mChangeCallback )(S32 new_pos, LLScrollbar self, void userdata)
void *	mCallbackUserData
ORIENTATION	mOrientation
S32	mDocSize
S32	mDocPos
S32	mPageSize
S32	mStepSize
BOOL	mDocChanged
LLRect	mThumbRect
S32	mDragStartX
S32	mDragStartY
F32	mHoverGlowStrength
F32	mCurGlowStrength
LLRect	mOrigRect
S32	mLastDelta
LLColor4	mTrackColor
LLColor4	mThumbColor
LLColor4	mFocusColor
LLColor4	mHighlightColor
LLColor4	mShadowColor
void(*	mOnScrollEndCallback )(void *)
void *	mOnScrollEndData

Detailed Description

Definition at line 48 of file llscrollbar.h.

Member Enumeration Documentation

enum LLScrollbar::ORIENTATION

Enumerator:

HORIZONTAL
VERTICAL

Definition at line 52 of file llscrollbar.h.

Constructor & Destructor Documentation

LLScrollbar::LLScrollbar	(	const LLString &	name,
		LLRect	rect,
		ORIENTATION	orientation,
		S32	doc_size,
		S32	doc_pos,
		S32	page_size,
		void()(S32 new_pos, LLScrollbar self, void *userdata)	change_callback,
		void *	callback_user_data = `NULL`,
		S32	step_size = `1`
	)

LLScrollbar::~LLScrollbar ( ) [virtual]

Definition at line 146 of file llscrollbar.cpp.

Member Function Documentation

void LLScrollbar::changeLine	(	S32	delta,
		BOOL	update_thumb
	)			`[protected]`

Definition at line 538 of file llscrollbar.cpp.

References getDocPosMax(), llclamp(), mCallbackUserData, mChangeCallback, mDocPos, S32, and updateThumbRect().

Referenced by handleHover(), handleKeyHere(), handleScrollWheel(), pageDown(), and pageUp().

void LLScrollbar::draw ( ) [virtual]

Reimplemented from LLView.

Definition at line 455 of file llscrollbar.cpp.

References LLWindow::convertCoords(), LLView::draw(), f, LLWindow::getCursorPosition(), getDocPos(), getDocPosMax(), LLFocusMgr::getFocusColor(), LLRectBase< Type >::getHeight(), LLCriticalDamp::getInterpolant(), LLFocusMgr::getKeyboardFocus(), LLFocusMgr::getMouseCapture(), LLImageProviderInterface::getUIImageByID(), LLView::getVisible(), LLRectBase< Type >::getWidth(), LLView::getWindow(), gFocusMgr, gl_draw_scaled_image_with_border(), gl_rect_2d(), glBlendFunc, LLView::hasMouseCapture(), HORIZONTAL, lerp(), LLRectBase< Type >::mBottom, mCurGlowStrength, LLView::mEnabled, mHoverGlowStrength, LLRectBase< Type >::mLeft, mOnScrollEndCallback, mOnScrollEndData, mOrientation, LLView::mRect, mThumbColor, mThumbRect, mTrackColor, LLCoord::mX, LLCoord::mY, LLRectBase< Type >::pointInRect(), S32, LLUI::sAssetsGroup, LLView::screenPointToLocal(), SCROLLBAR_SIZE, LLUUID::set(), LLUI::sImageProvider, LLRectBase< Type >::stretch(), TRUE, and VERTICAL.

S32 LLScrollbar::getDocPos ( ) [inline]

S32 LLScrollbar::getDocPosMax ( ) [inline]

S32 LLScrollbar::getDocSize ( ) [inline]

Definition at line 84 of file llscrollbar.h.

References mDocSize.

Referenced by LLScrollListCtrl::setEnabled(), LLTextEditor::setHideScrollbarForShortDocs(), and LLTextEditor::updateLineStartList().

S32 LLScrollbar::getPageSize ( ) [inline]

Definition at line 93 of file llscrollbar.h.

References mPageSize.

Referenced by LLTextEditor::changePage(), LLScrollListCtrl::handleKeyHere(), LLScrollListCtrl::setEnabled(), LLTextEditor::setHideScrollbarForShortDocs(), LLTextEditor::updateLineStartList(), and LLTextEditor::updateScrollFromCursor().

LLString LLScrollbar::getWidgetTag ( ) const [virtual]

Implements LLView.

Definition at line 567 of file llscrollbar.cpp.

References LL_SCROLLBAR_TAG.

EWidgetType LLScrollbar::getWidgetType ( ) const [virtual]

Implements LLView.

Definition at line 562 of file llscrollbar.cpp.

References WIDGET_TYPE_SCROLLBAR.

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