phoenix-firestorm/indra/llui/lltextbox.h

/** 
 * @file lltextbox.h
 * @brief A single text item display
 *
 * $LicenseInfo:firstyear=2001&license=viewergpl$
 * 
 * Copyright (c) 2001-2009, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LL_LLTEXTBOX_H
#define LL_LLTEXTBOX_H

#include "lluictrl.h"
#include "v4color.h"
#include "llstring.h"
#include "lluistring.h"
#include "lltextbase.h"

class LLTextBox :
	public LLTextBase,
	public LLUICtrl
{
public:
	
	// *TODO: Add callback to Params
	typedef boost::function<void (void)> callback_t;
	
	struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
	{
		Optional<std::string> text;

		Optional<bool>		border_visible,
							border_drop_shadow_visible,
							bg_visible,
							use_ellipses,
							word_wrap;

		Optional<LLFontGL::ShadowType>	font_shadow;

		Ignored				drop_shadow_visible,
							type,
							length;

		Optional<LLUIColor>	text_color,
							disabled_color,
							background_color;

		Optional<S32>		v_pad,
							h_pad,
							line_spacing;

		Params();
	};

protected:
	LLTextBox(const Params&);
	friend class LLUICtrlFactory;

public:
	virtual ~LLTextBox() {}

	virtual void	draw();
	virtual void	reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

	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	handleRightMouseDown(S32 x, S32 y, MASK mask);
	virtual BOOL	handleToolTip(S32 x, S32 y, std::string& msg, LLRect& sticky_rect_screen);

	void			setColor( const LLColor4& c )			{ mTextColor = c; }
	void			setDisabledColor( const LLColor4& c)	{ mDisabledColor = c; }
	void			setBackgroundColor( const LLColor4& c)	{ mBackgroundColor = c; }	

	void			setText( const LLStringExplicit& text );
	void			setWrappedText(const LLStringExplicit& text, F32 max_width = -1.f); // -1 means use existing control width
	void			setUseEllipses( BOOL use_ellipses )		{ mUseEllipses = use_ellipses; }
	
	void			setBackgroundVisible(BOOL visible)		{ mBackgroundVisible = visible; }
	void			setBorderVisible(BOOL visible)			{ mBorderVisible = visible; }
	void			setBorderDropshadowVisible(BOOL visible){ mBorderDropShadowVisible = visible; }
	void			setHPad(S32 pixels)						{ mHPad = pixels; }
	void			setVPad(S32 pixels)						{ mVPad = pixels; }
	void			setRightAlign()							{ mHAlign = LLFontGL::RIGHT; }
	void			setHAlign( LLFontGL::HAlign align )		{ mHAlign = align; }
	void			setClickedCallback( boost::function<void (void*)> cb, void* userdata = NULL ){ mClickedCallback = boost::bind(cb, userdata); }		// mouse down and up within button

	const LLFontGL* getFont() const							{ return mDefaultFont; }

	void			reshapeToFitText();

	const std::string&	getText() const							{ return mText.getString(); }
	LLWString		getWText() const { return mDisplayText; }
	S32				getTextPixelWidth();
	S32				getTextPixelHeight();
	S32				getLength() const { return mDisplayText.length(); }

	virtual void	setValue(const LLSD& value );		
	virtual LLSD	getValue() const						{ return LLSD(getText()); }
	virtual BOOL	setTextArg( const std::string& key, const LLStringExplicit& text );

protected:
	S32 			getLineCount() const { return mLineLengthList.size(); }
	S32 			getLineStart( S32 line ) const;
	S32             getDocIndexFromLocalCoord( S32 local_x, S32 local_y, BOOL round ) const;
	LLWString       getWrappedText(const LLStringExplicit& in_text, F32 max_width = -1.f);
	void			setLineLengths();
	void			updateDisplayTextAndSegments();
	virtual void	drawText(S32 x, S32 y, const LLWString &text, const LLColor4& color );
	void            onUrlLabelUpdated(const std::string &url, const std::string &label);
	bool            isClickable() const;
	LLWString       wrapText(const LLWString &wtext, S32 &hoffset, S32 &line_num, F32 max_width);
	void            drawTextSegments(S32 x, S32 y, const LLWString &text);

	LLUIString		mText;
	LLWString		mDisplayText;
	LLUIColor		mTextColor;
	LLUIColor		mDisabledColor;
	LLUIColor		mBackgroundColor;
	LLUIColor		mBorderColor;

	BOOL			mBackgroundVisible;
	BOOL			mBorderVisible;
	BOOL            mDidWordWrap;
	
	LLFontGL::ShadowType mShadowType;
	BOOL			mBorderDropShadowVisible;
	BOOL			mUseEllipses;

	S32				mLineSpacing;

	S32				mHPad;
	S32				mVPad;
	LLFontGL::HAlign mHAlign;
	LLFontGL::VAlign mVAlign;

	std::vector<S32> mLineLengthList;
	callback_t		mClickedCallback;
};

#endif