lltextbox.h

Go to the documentation of this file.

#ifndef LL_LLTEXTBOX_H
#define LL_LLTEXTBOX_H

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


class LLTextBox
:       public LLUICtrl
{
public:
        // By default, follows top and left and is mouse-opaque.
        // If no text, text = name.
        // If no font, uses default system font.
        LLTextBox(const LLString& name, const LLRect& rect, const LLString& text,
                          const LLFontGL* font = NULL, BOOL mouse_opaque = TRUE );

        // Construct a textbox which handles word wrapping for us.
        LLTextBox(const LLString& name, const LLString& text, F32 max_width = 200,
                          const LLFontGL* font = NULL, BOOL mouse_opaque = TRUE );

        // "Simple" constructors for text boxes that have the same name and label *TO BE DEPRECATED*
        LLTextBox(const LLString& name_and_label, const LLRect& rect);
        LLTextBox(const LLString& name_and_label);

        virtual ~LLTextBox() {}

        virtual LLXMLNodePtr getXML(bool save_children = true) const;
        static LLView* fromXML(LLXMLNodePtr node, LLView *parent, class LLUICtrlFactory *factory);

        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);

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

        void                    setHoverColor( const LLColor4& c )              { mHoverColor = c; }
        void                    setHoverActive( BOOL active )                   { mHoverActive = active; }

        void                    setText( const LLStringExplicit& text );
        void                    setWrappedText(const LLStringExplicit& text, F32 max_width = -1.0); // -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                    setFontStyle(U8 style)                                  { mFontStyle = style; }
        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( void (*cb)(void *data) ){ mClickedCallback = cb; }          // mouse down and up within button
        void                    setCallbackUserData( void* data )               { mCallbackUserData = data; }

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

        void                    reshapeToFitText();

        const LLString& getText() const                                                 { return mText.getString(); }
        S32                             getTextPixelWidth();
        S32                             getTextPixelHeight();

        virtual void    setValue(const LLSD& value )                    { setText(value.asString()); }
        virtual LLSD    getValue() const                                                { return LLSD(getText()); }
        virtual BOOL    setTextArg( const LLString& key, const LLStringExplicit& text );

private:
        void                    setLineLengths();
        void                    drawText(S32 x, S32 y, const LLColor4& color );

        LLUIString              mText;
        const LLFontGL* mFontGL;
        LLColor4                mTextColor;
        LLColor4                mDisabledColor;
        LLColor4                mBackgroundColor;
        LLColor4                mBorderColor;
        LLColor4                mHoverColor;

        BOOL                    mHoverActive;   
        BOOL                    mHasHover;
        BOOL                    mBackgroundVisible;
        BOOL                    mBorderVisible;
        
        U8                              mFontStyle; // style bit flags for font
        BOOL                    mBorderDropShadowVisible;
        BOOL                    mUseEllipses;

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

        std::vector<S32> mLineLengthList;
        void                    (*mClickedCallback)(void* data );
        void*                   mCallbackUserData;
};

#endif

---