Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: atv2
Fetching contributors…

Cannot retrieve contributors at this time

220 lines (188 sloc) 7.813 kb
\file GUILabel.h
#pragma once
* Copyright (C) 2005-2010 Team XBMC
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, write to
* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
#include "GUITextLayout.h"
#include "GUIInfoTypes.h"
#include "GUIFont.h"
#include "Geometry.h"
class CLabelInfo
font = NULL;
align = XBFONT_LEFT;
offsetX = offsetY = 0;
width = 0;
angle = 0;
scrollSpeed = CScrollInfo::defaultSpeed;
scrollSuffix = " | ";
void UpdateColors()
CGUIInfoColor textColor;
CGUIInfoColor shadowColor;
CGUIInfoColor selectedColor;
CGUIInfoColor disabledColor;
CGUIInfoColor focusedColor;
uint32_t align;
float offsetX;
float offsetY;
float width;
float angle;
CGUIFont *font;
int scrollSpeed;
CStdString scrollSuffix;
\ingroup controls, labels
\brief Class for rendering text labels. Handles alignment and rendering of text within a control.
class CGUILabel
/*! \brief allowed color categories for labels, as defined by the skin
enum COLOR { COLOR_TEXT = 0,
/*! \brief allowed overflow handling techniques for labels, as defined by the skin
CGUILabel(float posX, float posY, float width, float height, const CLabelInfo& labelInfo, OVER_FLOW overflow = OVER_FLOW_TRUNCATE);
virtual ~CGUILabel(void);
/*! \brief Render the label on screen
void Render();
/*! \brief Set the maximal extent of the label
Sets the maximal size and positioning that the label may render in. Note that <textwidth> can override
this, and <textoffsetx> and <textoffsety> may also allow the label to be moved outside this rectangle.
void SetMaxRect(float x, float y, float w, float h);
void SetAlign(uint32_t align);
/*! \brief Set the text to be displayed in the label
Updates the label control and recomputes final position and size
\param text CStdString to set as this labels text
\sa SetTextW
void SetText(const CStdString &label);
/*! \brief Set the text to be displayed in the label
Updates the label control and recomputes final position and size
\param text CStdStringW to set as this labels text
\sa SetText
void SetTextW(const CStdStringW &label);
/*! \brief Set the color to use for the label
Sets the color to be used for this label. Takes effect at the next render
\param color color to be used for the label
void SetColor(COLOR color);
/*! \brief Set the final layout of the current text
Overrides the calculated layout of the current text, forcing a particular size and position
\param rect CRect containing the extents of the current text
\sa GetRenderRect, UpdateRenderRect
void SetRenderRect(const CRect &rect) { m_renderRect = rect; };
/*! \brief Set whether or not this label control should scroll
\param scrolling true if this label should scroll.
void SetScrolling(bool scrolling);
/*! \brief Set this label invalid. Forces an update of the control
void SetInvalid();
/*! \brief Update this labels colors
void UpdateColors();
/*! \brief Returns the precalculated final layout of the current text
\return CRect containing the extents of the current text
\sa SetRenderRect, UpdateRenderRect
const CRect &GetRenderRect() const { return m_renderRect; };
/*! \brief Returns the precalculated full width of the current text, regardless of layout
\return full width of the current text
\sa CalcTextWidth
float GetTextWidth() const { return m_textLayout.GetTextWidth(); };
/*! \brief Returns the maximal width that this label can render into
\return Maximal width that this label can render into. Note that this may differ from the
amount given in SetMaxRect as offsets and text width overrides have been taken into account.
\sa SetMaxRect
float GetMaxWidth() const;
/*! \brief Calculates the width of some text
\param text CStdStringW of text whose width we want
\return width of the given text
\sa GetTextWidth
float CalcTextWidth(const CStdStringW &text) const { return m_textLayout.GetTextWidth(text); };
const CLabelInfo& GetLabelInfo() const { return m_label; };
CLabelInfo &GetLabelInfo() { return m_label; };
/*! \brief Check a left aligned and right aligned label for overlap and cut the labels off so that no overlap occurs
If a left-aligned label occupies some of the same space on screen as a right-aligned label, then we may be able to
correct for this by restricting the width of one or both of them. This routine checks two labels to see whether they
satisfy this assumption and, if so, adjusts the render rect of both labels so that they no longer do so. The order
of the two labels is not important, but we do assume that the left-aligned label is also the left-most on screen, and
that the right-aligned label is the right most on-screen, so that they overlap due to the fact that one or both of
the labels are longer than anticipated. In the following diagram, [R...[R R] refers to the maximal allowed and
actual space occupied by the right label. Similarly, [L L]...L] refers to the maximal and actual space occupied
by the left label. | refers to the central cutting point, i.e. the point that would divide the maximal allowed
overlap perfectly in two. There are 3 scenarios to consider:
[L [R...[R L].|..........L] R] left label ends to the left of the cut -> just crop the left label.
[L [R.....[R | L]..L] R] both left and right labels occupy more than the cut allows, so crop both.
[L [R..........|.[R L]..L] R] right label ends to the right of the cut -> just crop the right label.
\param label1 First label to check
\param label2 Second label to check
static void CheckAndCorrectOverlap(CGUILabel &label1, CGUILabel &label2);
color_t GetColor() const;
/*! \brief Computes the final layout of the text
Uses the maximal position and width of the text, as well as the text length
and alignment to compute the final render rect of the text.
\sa GetRenderRect, SetRenderRect
void UpdateRenderRect();
CLabelInfo m_label;
CGUITextLayout m_textLayout;
bool m_scrolling;
OVER_FLOW m_overflowType;
bool m_selected;
CScrollInfo m_scrollInfo;
CRect m_renderRect; ///< actual sizing of text
CRect m_maxRect; ///< maximum sizing of text
bool m_invalid; ///< if true, the label needs recomputing
COLOR m_color; ///< color to render text \sa SetColor, GetColor
Jump to Line
Something went wrong with that request. Please try again.