#include <textpreview.h>

Inheritance diagram for TextPreview:

Public Member Functions
	TextPreview (const Widget2 *const widget, const std::string &text)

	~TextPreview ()

void	setTextColor (const Color *color)

void	setTextColor2 (const Color *color)

void	useTextAlpha (const bool alpha)

void	setTextBGColor (const Color *color)

void	setBGColor (const Color *color)

void	setFont (Font *const font)

void	setShadow (const bool shadow)

void	setOutline (const bool outline)

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	setOpaque (const Opaque opaque)

bool	isOpaque () const

void	adjustSize ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

virtual void	logic ()

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	setFocusHandler (FocusHandler *const focusHandler)

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

virtual Widget *	getWidgetAt (int x, int y)

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual Rect	getChildrenArea ()

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

virtual void	moveToTop (Widget *widget)

virtual void	moveToBottom (Widget *widget)

virtual void	focusNext ()

virtual void	focusPrevious ()

virtual void	showWidgetPart (Widget *const widget, const Rect &area)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Private Attributes
Font *	mFont

std::string	mText

const Color *	mTextColor

const Color *	mTextColor2

const Color *	mBGColor

const Color *	mTextBGColor

int	mPadding

bool	mTextAlpha

Opaque	mOpaque

bool	mShadow

bool	mOutline

Static Private Attributes
static int	instances = 0

static float	mAlpha = 1.0

static Skin *	mSkin = 0

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

Preview widget for particle colors, etc.

Definition at line 36 of file textpreview.h.

Constructor & Destructor Documentation

◆ TextPreview()

TextPreview::TextPreview	(	const Widget2 *const	widget,
		const std::string &	text
	)

Definition at line 41 of file textpreview.cpp.

                                                 :
     Widget(widget),
     mFont(gui->getFont()),
     mText(text),
     mTextColor(&getThemeColor(ThemeColorId::TEXT, 255U)),
     mTextColor2(&getThemeColor(ThemeColorId::TEXT_OUTLINE, 255U)),
     mBGColor(&getThemeColor(ThemeColorId::BACKGROUND, 255U)),
     mTextBGColor(nullptr),
     mPadding(0),
     mTextAlpha(false),
     mOpaque(Opaque_false),
     mShadow(false),
     mOutline(false)
 {
     mAllowLogic = false;
     if (instances == 0)
     {
         if (theme != nullptr)
         {
             mSkin = theme->load("textpreview.xml",
                 "",
                 true,
                 Theme::getThemePath());
         }
     }
  
     instances++;
  
     if (mSkin != nullptr)
         mPadding = mSkin->getOption("padding", 0);
  
     adjustSize();
 }

References adjustSize(), Skin::getOption(), Theme::getThemePath(), instances, Theme::load(), Widget::mAllowLogic, mPadding, mSkin, and theme.

◆ ~TextPreview()

TextPreview::~TextPreview ( )

Definition at line 76 of file textpreview.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
  
     instances--;
  
     if (instances == 0)
     {
         if (theme != nullptr)
             theme->unload(mSkin);
     }
 }

References gui, instances, mSkin, Gui::removeDragged(), theme, and Theme::unload().

Member Function Documentation

◆ adjustSize()

void TextPreview::adjustSize ( )

Definition at line 154 of file textpreview.cpp.

 {
     setHeight(getFont()->getHeight() + 2 * mPadding);
 }

References Widget::getFont(), Widget::getHeight(), mPadding, and Widget::setHeight().

Referenced by setTextColor(), setTextColor2(), and TextPreview().

◆ draw()

void TextPreview::draw ( Graphics *const graphics )

virtual

Widget's draw method. Does the actual job.

Parameters

graphics graphics to draw into

Implements Widget.

Definition at line 90 of file textpreview.cpp.

 {
     if (mFont == nullptr)
         return;
  
     BLOCK_START("TextPreview::draw")
     if (settings.guiAlpha != mAlpha)
         mAlpha = settings.guiAlpha;
  
     const int intAlpha = CAST_S32(mAlpha * 255.0F);
     const int alpha = mTextAlpha ? intAlpha : 255;
  
     if (mOpaque == Opaque_true)
     {
         graphics->setColor(Color(CAST_S32(mBGColor->r),
                     CAST_S32(mBGColor->g),
                     CAST_S32(mBGColor->b),
                     CAST_S32(mAlpha * 255.0F)));
         graphics->fillRectangle(Rect(0, 0,
             mDimension.width, mDimension.height));
     }
  
     if (mTextBGColor != nullptr)
     {
         const int x = mFont->getWidth(mText) + 1
             + 2 * ((mOutline || mShadow) ? 1 :0);
         const int y = mFont->getHeight() + 1
             + 2 * ((mOutline || mShadow) ? 1 : 0);
         graphics->setColor(Color(CAST_S32(mTextBGColor->r),
             CAST_S32(mTextBGColor->g),
             CAST_S32(mTextBGColor->b),
             intAlpha));
         graphics->fillRectangle(Rect(mPadding, mPadding, x, y));
     }
  
     Color color1(mTextColor->r, mTextColor->g, mTextColor->b, alpha);
  
     if (mOutline && mTextColor != mTextColor2)
     {
         const Color &color2 = getThemeColor(ThemeColorId::OUTLINE, 255U);
         mFont->drawString(graphics,
             color1,
             color2,
             mText,
             mPadding + 1, mPadding + 1);
     }
     else
     {
         Color color2(mTextColor2->r, mTextColor2->g, mTextColor2->b, alpha);
         mFont->drawString(graphics,
             color1,
             color2,
             mText,
             mPadding + 1, mPadding + 1);
     }
  
     BLOCK_END("TextPreview::draw")
 }

References Color::b, BLOCK_END, BLOCK_START, CAST_S32, Font::drawString(), Graphics::fillRectangle(), Color::g, Font::getHeight(), Widget2::getThemeColor(), Font::getWidth(), Settings::guiAlpha, Rect::height, mAlpha, mBGColor, Widget::mDimension, mFont, mOpaque, mOutline, mPadding, mShadow, mText, mTextAlpha, mTextBGColor, mTextColor, mTextColor2, Opaque_true, Color::r, Graphics::setColor(), settings, Rect::width, x, and y.

Referenced by safeDraw().

◆ isOpaque()

bool TextPreview::isOpaque ( ) const

inline

Gets opacity for this widget (whether or not the background color is shown below the widget)

Definition at line 123 of file textpreview.h.

124 { return mOpaque == Opaque_true; }

References mOpaque, and Opaque_true.

◆ safeDraw()

void TextPreview::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 149 of file textpreview.cpp.

 {
     TextPreview::draw(graphics);
 }

References draw().

◆ setBGColor()

void TextPreview::setBGColor ( const Color * color )

inline

Sets the background color of the widget.

Parameters

color the color to set

Definition at line 74 of file textpreview.h.

75 { mBGColor = color; }

References mBGColor.

Referenced by Setup_Colors::valueChanged().

◆ setFont()

void TextPreview::setFont ( Font *const font )

inline

Sets the font to render the text in.

Parameters

font	the font to use.

Definition at line 82 of file textpreview.h.

83 { mFont = font; }

References mFont.

Referenced by Setup_Colors::valueChanged().

◆ setOpaque()

void TextPreview::setOpaque ( const Opaque opaque )

inline

Set opacity for this widget (whether or not to show the background color)

Parameters

opaque Whether the widget should be opaque or not

Definition at line 116 of file textpreview.h.

117 { mOpaque = opaque; }

References mOpaque.

Referenced by Setup_Colors::valueChanged().

◆ setOutline()

void TextPreview::setOutline ( const bool outline )

inline

Sets whether to use an outline while rendering.

Parameters

outline true, if an outline is wanted, false else

Definition at line 98 of file textpreview.h.

99 { mOutline = outline; }

References mOutline.

Referenced by Setup_Colors::valueChanged().

◆ setShadow()

void TextPreview::setShadow ( const bool shadow )

inline

Sets whether to use a shadow while rendering.

Parameters

shadow true, if a shadow is wanted, false else

Definition at line 90 of file textpreview.h.

91 { mShadow = shadow; }

References mShadow.

Referenced by Setup_Colors::valueChanged().

◆ setTextBGColor()

void TextPreview::setTextBGColor ( const Color * color )

inline

Sets the color the text background is drawn in. This is only the rectangle directly behind the text, not to full widget.

Parameters

color the color to set

Definition at line 66 of file textpreview.h.

67 { mTextBGColor = color; }

References mTextBGColor.

Referenced by Setup_Colors::valueChanged().

◆ setTextColor()

void TextPreview::setTextColor ( const Color * color )

inline

Definition at line 46 of file textpreview.h.

47 { mTextColor = color; adjustSize(); }

References adjustSize(), and mTextColor.

Referenced by Setup_Colors::valueChanged().

◆ setTextColor2()

void TextPreview::setTextColor2 ( const Color * color )

inline

Definition at line 49 of file textpreview.h.

50 { mTextColor2 = color; adjustSize(); }

References adjustSize(), and mTextColor2.

◆ useTextAlpha()

void TextPreview::useTextAlpha ( const bool alpha )

inline

Sets the text to use the set alpha value.

Parameters

alpha whether to use alpha values for the text or not

Definition at line 57 of file textpreview.h.

58 { mTextAlpha = alpha; }

References mTextAlpha.

Referenced by Setup_Colors::valueChanged().

Field Documentation

◆ instances

int TextPreview::instances = 0

staticprivate

Definition at line 136 of file textpreview.h.

Referenced by TextPreview(), and ~TextPreview().

◆ mAlpha

float TextPreview::mAlpha = 1.0

staticprivate

Definition at line 137 of file textpreview.h.

Referenced by draw().

◆ mBGColor

const Color* TextPreview::mBGColor

private

Definition at line 133 of file textpreview.h.

Referenced by draw(), and setBGColor().

◆ mFont

Font* TextPreview::mFont

private

Definition at line 129 of file textpreview.h.

Referenced by draw(), and setFont().

◆ mOpaque

Opaque TextPreview::mOpaque

private

Definition at line 140 of file textpreview.h.

Referenced by draw(), isOpaque(), and setOpaque().

◆ mOutline

bool TextPreview::mOutline

private

Definition at line 142 of file textpreview.h.

Referenced by draw(), and setOutline().

◆ mPadding

int TextPreview::mPadding

private

Definition at line 135 of file textpreview.h.

Referenced by adjustSize(), draw(), and TextPreview().

◆ mShadow

bool TextPreview::mShadow

private

Definition at line 141 of file textpreview.h.

Referenced by draw(), and setShadow().

◆ mSkin

Skin * TextPreview::mSkin = 0

staticprivate

Definition at line 138 of file textpreview.h.

Referenced by TextPreview(), and ~TextPreview().

◆ mText

std::string TextPreview::mText

private

Definition at line 130 of file textpreview.h.

Referenced by draw().

◆ mTextAlpha

bool TextPreview::mTextAlpha

private

Definition at line 139 of file textpreview.h.

Referenced by draw(), and useTextAlpha().

◆ mTextBGColor

const Color* TextPreview::mTextBGColor

private

Definition at line 134 of file textpreview.h.

Referenced by draw(), and setTextBGColor().

◆ mTextColor

const Color* TextPreview::mTextColor

private

Definition at line 131 of file textpreview.h.

Referenced by draw(), and setTextColor().

◆ mTextColor2

const Color* TextPreview::mTextColor2

private

Definition at line 132 of file textpreview.h.

Referenced by draw(), and setTextColor2().

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

src/gui/widgets/textpreview.h (986a3bf)
src/gui/widgets/textpreview.cpp (986a3bf)

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextPreview()

◆ ~TextPreview()

Member Function Documentation

◆ adjustSize()

◆ draw()

◆ isOpaque()

◆ safeDraw()

◆ setBGColor()

◆ setFont()

◆ setOpaque()

◆ setOutline()

◆ setShadow()

◆ setTextBGColor()

◆ setTextColor()

◆ setTextColor2()

◆ useTextAlpha()

Field Documentation

◆ instances

◆ mAlpha

◆ mBGColor

◆ mFont

◆ mOpaque

◆ mOutline

◆ mPadding

◆ mShadow

◆ mSkin

◆ mText

◆ mTextAlpha

◆ mTextBGColor

◆ mTextColor

◆ mTextColor2