ExtendedListBox Class Reference

#include <extendedlistbox.h>

Inheritance diagram for ExtendedListBox:

Public Member Functions
	ExtendedListBox (const Widget2 *const widget, ListModel *const listModel, const std::string &skin, const unsigned int rowHeight)
	~ExtendedListBox ()
void	draw (Graphics *const graphics)
void	safeDraw (Graphics *const graphics)
void	adjustSize ()
int	getSelectionByMouse (const int y) const
Public Member Functions inherited from ListBox
	ListBox (const Widget2 *const widget, ListModel *const listModel, const std::string &skin)
	~ListBox ()
void	postInit ()
void	draw (Graphics *const graphics)
void	safeDraw (Graphics *const graphics)
void	updateAlpha ()
void	keyPressed (KeyEvent &event)
void	mouseWheelMovedUp (MouseEvent &event)
void	mouseWheelMovedDown (MouseEvent &event)
void	mousePressed (MouseEvent &event)
void	mouseReleased (MouseEvent &event)
void	mouseReleased1 (const MouseEvent &event)
void	mouseDragged (MouseEvent &event)
void	refocus ()
void	setDistributeMousePressed (const bool b)
void	logic ()
void	setCenter (const bool b)
int	getPressedIndex () const
virtual unsigned int	getRowHeight () const
void	setRowHeight (unsigned int n)
int	getSelected () const
void	setSelected (const int selected)
void	setListModel (ListModel *listModel)
ListModel *	getListModel () const
bool	isWrappingEnabled () const
void	setWrappingEnabled (const bool wrappingEnabled)
void	addSelectionListener (SelectionListener *const selectionListener)
void	removeSelectionListener (SelectionListener *const selectionListener)
void	distributeValueChangedEvent ()
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
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 ()
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)
Public Member Functions inherited from MouseListener
virtual	~MouseListener ()
virtual void	mouseEntered (MouseEvent &event)
virtual void	mouseExited (MouseEvent &event)
virtual void	mouseClicked (MouseEvent &event)
virtual void	mouseMoved (MouseEvent &event)
Public Member Functions inherited from KeyListener
virtual	~KeyListener ()
virtual void	keyReleased (KeyEvent &event)

Protected Attributes
int	mImagePadding
int	mSpacing
int	mHeight
std::vector< ExtendedListBoxItem >	mListItems
std::vector< ExtendedListBoxItem >	mSelectedItems
Protected Attributes inherited from ListBox
int	mSelected
ListModel *	mListModel
bool	mWrappingEnabled
SelectionListenerList	mSelectionListeners
Color	mHighlightColor
Color	mForegroundSelectedColor
Color	mForegroundSelectedColor2
int	mOldSelected
int	mPadding
int	mPressedIndex
unsigned int	mRowHeight
int	mItemPadding
Skin *	mSkin
bool	mDistributeMousePressed
bool	mCenterText
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

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 ListBox
typedef std::list< SelectionListener * >	SelectionListenerList
typedef SelectionListenerList::iterator	SelectionListenerIterator
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 Member Functions inherited from MouseListener
	MouseListener ()
Protected Member Functions inherited from KeyListener
	KeyListener ()
Static Protected Attributes inherited from ListBox
static float	mAlpha = 1.0
Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

Definition at line 28 of file extendedlistbox.h.

Constructor & Destructor Documentation

ExtendedListBox()

ExtendedListBox::ExtendedListBox	(	const Widget2 *const	widget,
		ListModel *const	listModel,
		const std::string &	skin,
		const unsigned int	rowHeight
	)

Constructor.

Definition at line 34 of file extendedlistbox.cpp.

                                                               :
    ListBox(widget, listModel, skin),
    mImagePadding(mSkin != nullptr ? mSkin->getOption("imagePadding") : 0),
    mSpacing(mSkin != nullptr ? mSkin->getOption("spacing") : 0),
    mHeight(0),
    mListItems(),
    mSelectedItems()
{
    if (rowHeight != 0U)
        mRowHeight = rowHeight;
}

References ListBox::mRowHeight.

~ExtendedListBox()

ExtendedListBox::~ExtendedListBox

(

)

Definition at line 49 of file extendedlistbox.cpp.

{
}

Member Function Documentation

adjustSize()

void ExtendedListBox::adjustSize ( )

virtual

Reimplemented from ListBox.

Definition at line 226 of file extendedlistbox.cpp.

{
    if (mHeight != 0)
        setHeight(mHeight + 2 * mPadding);
    else
        ListBox::adjustSize();
}

References ListBox::adjustSize(), mHeight, ListBox::mPadding, and Widget::setHeight().

draw()

void ExtendedListBox::draw ( Graphics *const  graphics )

virtual

Draws the list box.

Implements Widget.

Definition at line 53 of file extendedlistbox.cpp.

{
    if (mListModel == nullptr)
        return;
 
    BLOCK_START("ExtendedListBox::draw")
    ExtendedListModel *const model = static_cast<ExtendedListModel *>(
        mListModel);
 
    updateAlpha();
    Font *const font = getFont();
 
    const int height = CAST_S32(mRowHeight);
    const int pad2 = 2 + mPadding;
    const int width = mDimension.width;
    int textPos = (height - font->getHeight()) / 2 + mPadding;
    if (textPos < 0)
        textPos = 0;
 
    const int sz = mListModel->getNumberOfElements();
    mListItems.clear();
    mSelectedItems.clear();
    int y = 0;
    const int insideWidth = width - pad2;
    for (int f = 0; f < sz; f ++)
    {
        int row = f;
        bool useImage = true;
        std::string str = mListModel->getElementAt(f);
        int strWidth = font->getWidth(str) + 8;
 
        const Image *const image = model->getImageAt(row);
        if (image != nullptr)
            strWidth += image->getWidth() + mImagePadding;
 
        STD_VECTOR<ExtendedListBoxItem> &list =
            row == mSelected ? mSelectedItems : mListItems;
 
        if (insideWidth < strWidth)
        {
            const size_t strSize = str.size();
            size_t divPos = strSize / 2;
            if (divPos > 0 && CAST_U8(
                str[divPos - 1]) >= 0xc0)
            {
                divPos --;
            }
            for (size_t d = divPos; d > 10; d --)
            {
                if (str[d] == 32)
                {
                    divPos = d + 1;
                    break;
                }
            }
            list.push_back(ExtendedListBoxItem(row,
                str.substr(0, divPos), useImage, y));
            str = str.substr(divPos);
            y += height;
            useImage = false;
        }
        list.push_back(ExtendedListBoxItem(row, str, useImage, y));
 
        y += height;
    }
    mHeight = y + height;
 
    const size_t itemsSz = mListItems.size();
    const size_t selSz = mSelectedItems.size();
    int minY = -1;
    int maxY = -1;
    for (size_t f = 0; f < selSz; f ++)
    {
        const ExtendedListBoxItem &item = mSelectedItems[f];
        const int y1 = item.y;
        if (minY == -1)
            minY = y1;
        if (maxY < y1)
            maxY = y1;
    }
 
    if (minY != -1)
    {
        mHighlightColor.a = CAST_U32(mAlpha * 255.0F);
        graphics->setColor(mHighlightColor);
        graphics->fillRectangle(Rect(mPadding, minY + mPadding,
            width - pad2, maxY - minY + height));
    }
 
    for (size_t f = 0; f < itemsSz; ++f)
    {
        const ExtendedListBoxItem &item = mListItems[f];
        if (item.image)
        {
            const int row1 = item.row;
            const Image *const image = model->getImageAt(row1);
            if (image != nullptr)
            {
                graphics->drawImage(image,
                    mImagePadding,
                    item.y + (height - image->getHeight()) / 2 + mPadding);
            }
        }
    }
 
    for (size_t f = 0; f < itemsSz; ++f)
    {
        const ExtendedListBoxItem &item = mListItems[f];
        const int row1 = item.row;
        const int y1 = item.y;
        const Image *const image = model->getImageAt(row1);
        if ((image == nullptr) || !item.image)
        {
            font->drawString(graphics,
                mForegroundColor, mForegroundColor2,
                item.text,
                mPadding, y1 + textPos);
        }
        else
        {
            font->drawString(graphics,
                mForegroundColor, mForegroundColor2,
                item.text,
                image->getWidth() + mImagePadding + mSpacing, y1 + textPos);
        }
    }
 
    for (size_t f = 0; f < selSz; ++f)
    {
        const ExtendedListBoxItem &item = mSelectedItems[f];
        const int row1 = item.row;
        const int y1 = item.y;
        const Image *const image = model->getImageAt(row1);
        if ((image == nullptr) || !item.image)
        {
            font->drawString(graphics,
                mForegroundSelectedColor, mForegroundSelectedColor2,
                item.text,
                mPadding, y1 + textPos);
        }
        else
        {
            font->drawString(graphics,
                mForegroundSelectedColor, mForegroundSelectedColor2,
                item.text,
                image->getWidth() + mImagePadding + mSpacing, y1 + textPos);
        }
    }
 
    for (size_t f = 0; f < selSz; ++f)
    {
        const ExtendedListBoxItem &item = mSelectedItems[f];
        if (item.image)
        {
            const int row1 = item.row;
            const Image *const image = model->getImageAt(row1);
            if (image != nullptr)
            {
                graphics->drawImage(image,
                    mImagePadding,
                    item.y + (height - image->getHeight()) / 2 + mPadding);
            }
        }
    }
 
    BLOCK_END("ExtendedListBox::draw")
}

References Color::a, BLOCK_END, BLOCK_START, CAST_S32, CAST_U32, CAST_U8, Graphics::drawImage(), Font::drawString(), Graphics::fillRectangle(), ListModel::getElementAt(), Widget::getFont(), Font::getHeight(), ExtendedListModel::getImageAt(), ListModel::getNumberOfElements(), Font::getWidth(), ExtendedListBoxItem::image, ListBox::mAlpha, Widget::mDimension, Widget::mForegroundColor, Widget2::mForegroundColor2, ListBox::mForegroundSelectedColor, ListBox::mForegroundSelectedColor2, mHeight, ListBox::mHighlightColor, mImagePadding, mListItems, ListBox::mListModel, ListBox::mPadding, ListBox::mRowHeight, ListBox::mSelected, mSelectedItems, mSpacing, ExtendedListBoxItem::row, Graphics::setColor(), ExtendedListBoxItem::text, ListBox::updateAlpha(), Rect::width, ExtendedListBoxItem::y, and y.

Referenced by safeDraw().

getSelectionByMouse()

int ExtendedListBox::getSelectionByMouse ( const int  y ) const

virtual

Reimplemented from ListBox.

Definition at line 234 of file extendedlistbox.cpp.

{
    if (mListItems.empty() && mSelectedItems.empty())
        return ListBox::getSelectionByMouse(y);
 
    const int height = CAST_S32(mRowHeight);
    const size_t itemsSz = mListItems.size();
    for (size_t f = 0; f < itemsSz; f ++)
    {
        const ExtendedListBoxItem &item = mListItems[f];
        const int y2 = item.y + mPadding;
        if (y2 <= y && y2 + height > y)
            return item.row;
    }
 
    const size_t selSz = mSelectedItems.size();
    for (size_t f = 0; f < selSz; f ++)
    {
        const ExtendedListBoxItem &item = mSelectedItems[f];
        const int y2 = item.y + mPadding;
        if (y2 <= y && y2 + height > y)
            return item.row;
    }
    return 0;
}

References CAST_S32, ListBox::getSelectionByMouse(), mListItems, ListBox::mPadding, ListBox::mRowHeight, mSelectedItems, ExtendedListBoxItem::row, ExtendedListBoxItem::y, and y.

safeDraw()

void ExtendedListBox::safeDraw ( Graphics *const  graphics )

virtual

Implements Widget.

Definition at line 221 of file extendedlistbox.cpp.

{
    ExtendedListBox::draw(graphics);
}

References draw().

Field Documentation

mHeight

int ExtendedListBox::mHeight

protected

Definition at line 57 of file extendedlistbox.h.

Referenced by adjustSize(), and draw().

mImagePadding

int ExtendedListBox::mImagePadding

protected

Definition at line 55 of file extendedlistbox.h.

Referenced by draw().

mListItems

std::vector<ExtendedListBoxItem> ExtendedListBox::mListItems

protected

Definition at line 58 of file extendedlistbox.h.

Referenced by draw(), and getSelectionByMouse().

mSelectedItems

std::vector<ExtendedListBoxItem> ExtendedListBox::mSelectedItems

protected

Definition at line 59 of file extendedlistbox.h.

Referenced by draw(), and getSelectionByMouse().

mSpacing

int ExtendedListBox::mSpacing

protected

Definition at line 56 of file extendedlistbox.h.

Referenced by draw().

---

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

• src/gui/widgets/extendedlistbox.h (986a3bf)
• src/gui/widgets/extendedlistbox.cpp (986a3bf)