listbox.qc File Reference

#include "listbox.qh"

Include dependency graph for listbox.qc:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
	AUTOCVAR (menu_scroll_averaging_time, float, 0.16, "smooth scroll averaging time")
	AUTOCVAR (menu_scroll_averaging_time_pressed, float, 0.06, "smooth scroll averaging time when dragging the scrollbar")
void	ListBox_clickListBoxItem (entity me, float i, vector where)
void	ListBox_configureListBox (entity me, float theScrollbarWidth, float theItemHeight)
void	ListBox_doubleClickListBoxItem (entity me, float i, vector where)
void	ListBox_draw (entity me)
void	ListBox_drawListBoxItem (entity me, int i, vector absSize, bool isSelected, bool isFocused)
void	ListBox_focusedItemChangeNotify (entity me)
void	ListBox_focusLeave (entity me)
float	ListBox_getFirstFullyVisibleItemAtScrollPos (entity me, float pos)
float	ListBox_getItemAtPos (entity me, float pos)
float	ListBox_getItemHeight (entity me, float i)
float	ListBox_getItemStart (entity me, float i)
float	ListBox_getLastFullyVisibleItemAtScrollPos (entity me, float pos)
float	ListBox_getTotalHeight (entity me)
bool	ListBox_isScrolling (entity me)
float	ListBox_keyDown (entity me, float key, float ascii, float shift)
float	ListBox_mouseDrag (entity me, vector pos)
float	ListBox_mouseMove (entity me, vector pos)
float	ListBox_mouseRelease (entity me, vector pos)
void	ListBox_resizeNotify (entity me, vector relOrigin, vector relSize, vector absOrigin, vector absSize)
void	ListBox_scrollToItem (entity me, int i)
void	ListBox_setFocusedItem (entity me, int item)
void	ListBox_setSelected (entity me, float i)
void	ListBox_updateControlTopBottom (entity me)

Function Documentation

AUTOCVAR() [1/2]

AUTOCVAR	(	menu_scroll_averaging_time	,
		float	,
		0.	16,
		"smooth scroll averaging time"	)

AUTOCVAR() [2/2]

AUTOCVAR	(	menu_scroll_averaging_time_pressed	,
		float	,
		0.	06,
		"smooth scroll averaging time when dragging the scrollbar"	)

ListBox_clickListBoxItem()

void ListBox_clickListBoxItem	(	entity	me,
		float	i,
		vector	where )

Definition at line 397 of file listbox.qc.

    {
        // template method
    }

References entity(), and vector.

ListBox_configureListBox()

void ListBox_configureListBox	(	entity	me,
		float	theScrollbarWidth,
		float	theItemHeight )

Definition at line 48 of file listbox.qc.

    {
        me.scrollbarWidth = theScrollbarWidth;
        me.itemHeight = theItemHeight;
    }

References entity().

ListBox_doubleClickListBoxItem()

void ListBox_doubleClickListBoxItem	(	entity	me,
		float	i,
		vector	where )

Definition at line 402 of file listbox.qc.

    {
        // template method
    }

References entity(), and vector.

ListBox_draw()

void ListBox_draw

(

entity

me

)

Definition at line 325 of file listbox.qc.

    {
        vector fillSize = '0 0 0';
 
        // we can't do this in mouseMove as the list can scroll without moving the cursor
        if (me.mouseMoveOffset != -1)
            me.setFocusedItem(me, me.getItemAtPos(me, me.scrollPos + me.mouseMoveOffset));
 
        if (me.needScrollToItem >= 0)
        {
            me.scrollToItem(me, me.needScrollToItem);
            me.needScrollToItem = -1;
        }
        if (me.scrollPos != me.scrollPosTarget)
        {
            float averaging_time = (me.pressed == 1)
                ? autocvar_menu_scroll_averaging_time_pressed
                : autocvar_menu_scroll_averaging_time;
            // this formula works with whatever framerate
            float f = averaging_time ? exp(-frametime / averaging_time) : 0;
            me.scrollPos = me.scrollPos * f + me.scrollPosTarget * (1 - f);
            if (fabs(me.scrollPos - me.scrollPosTarget) < 0.001)
                me.scrollPos = me.scrollPosTarget;
        }
 
        if (me.pressed == 2)
            me.mouseDrag(me, me.dragScrollPos);  // simulate mouseDrag event
        me.updateControlTopBottom(me);
        fillSize.x = (1 - me.controlWidth);
        if (me.alphaBG)
            draw_Fill('0 0 0', '0 1 0' + fillSize, me.colorBG, me.alphaBG);
        if (me.controlWidth)
        {
            draw_VertButtonPicture(eX * (1 - me.controlWidth), strcat(me.src, "_s"), eX * me.controlWidth + eY, me.color2, 1);
            if (me.getTotalHeight(me) > 1)
            {
                vector o, s;
                o = eX * (1 - me.controlWidth) + eY * me.controlTop;
                s = eX * me.controlWidth + eY * (me.controlBottom - me.controlTop);
                if (me.pressed == 1)
                    draw_VertButtonPicture(o, strcat(me.src, "_c"), s, me.colorC, 1);
                else if (me.focused)
                    draw_VertButtonPicture(o, strcat(me.src, "_f"), s, me.colorF, 1);
                else
                    draw_VertButtonPicture(o, strcat(me.src, "_n"), s, me.color, 1);
            }
        }
        draw_SetClip();
        vector oldshift = draw_shift;
        vector oldscale = draw_scale;
 
        int i = me.getItemAtPos(me, me.scrollPos);
        float y = me.getItemStart(me, i) - me.scrollPos;
        for ( ; i < me.nItems && y < 1; ++i)
        {
            draw_shift = boxToGlobal(eY * y, oldshift, oldscale);
            vector relSize = eX * (1 - me.controlWidth) + eY * me.getItemHeight(me, i);
            vector absSize = boxToGlobalSize(relSize, me.size);
            draw_scale = boxToGlobalSize(relSize, oldscale);
            me.drawListBoxItem(me, i, absSize, (me.selectedItem == i), (me.focusedItem == i));
            y += relSize.y;
        }
        draw_ClearClip();
 
        draw_shift = oldshift;
        draw_scale = oldscale;
        SUPER(ListBox).draw(me);
    }

References boxToGlobal(), boxToGlobalSize(), draw_ClearClip(), draw_Fill(), draw_scale, draw_SetClip(), draw_shift, draw_VertButtonPicture(), entity(), eX, exp(), eY, fabs(), frametime, strcat(), SUPER, vector, and y.

ListBox_drawListBoxItem()

void ListBox_drawListBoxItem	(	entity	me,
		int	i,
		vector	absSize,
		bool	isSelected,
		bool	isFocused )

Definition at line 407 of file listbox.qc.

    {
        // should be overridden
        draw_Text('0 0 0', sprintf(_("Item %d"), i), eX * (8 / absSize.x) + eY * (8 / absSize.y), (isSelected ? '0 1 0' : '1 1 1'), 1, 0);
    }

References draw_Text(), entity(), eX, eY, and vector.

ListBox_focusedItemChangeNotify()

void ListBox_focusedItemChangeNotify

(

entity

me

)

Definition at line 394 of file listbox.qc.

    {}

References entity().

ListBox_focusLeave()

void ListBox_focusLeave

(

entity

me

)

Definition at line 281 of file listbox.qc.

    {
        // Reset the var pressed in case listbox loses focus
        // by a mouse click on an item of the list
        // for example showing a dialog on right click
        me.pressed = 0;
        me.setFocusedItem(me, -1);
        me.mouseMoveOffset = -1;
    }

References entity().

ListBox_getFirstFullyVisibleItemAtScrollPos()

float ListBox_getFirstFullyVisibleItemAtScrollPos	(	entity	me,
		float	pos )

Definition at line 75 of file listbox.qc.

    {
        return me.getItemAtPos(me, pos + 0.001) + 1;
    }

References entity().

ListBox_getItemAtPos()

float ListBox_getItemAtPos	(	entity	me,
		float	pos )

Definition at line 58 of file listbox.qc.

    {
        return floor(pos / me.itemHeight);
    }

References entity(), and floor().

ListBox_getItemHeight()

float ListBox_getItemHeight	(	entity	me,
		float	i )

Definition at line 66 of file listbox.qc.

    {
        return me.itemHeight;
    }

References entity().

ListBox_getItemStart()

float ListBox_getItemStart	(	entity	me,
		float	i )

Definition at line 62 of file listbox.qc.

    {
        return me.itemHeight * i;
    }

References entity().

ListBox_getLastFullyVisibleItemAtScrollPos()

float ListBox_getLastFullyVisibleItemAtScrollPos	(	entity	me,
		float	pos )

Definition at line 71 of file listbox.qc.

    {
        return me.getItemAtPos(me, pos + 0.999) - 1;
    }

References entity().

ListBox_getTotalHeight()

float ListBox_getTotalHeight

(

entity

me

)

Definition at line 54 of file listbox.qc.

    {
        return me.nItems * me.itemHeight;
    }

References entity().

ListBox_isScrolling()

bool ListBox_isScrolling

(

entity

me

)

Definition at line 3 of file listbox.qc.

    {
        return me.scrollPos != me.scrollPosTarget;
    }

References entity().

ListBox_keyDown()

float ListBox_keyDown	(	entity	me,
		float	key,
		float	ascii,
		float	shift )

Definition at line 80 of file listbox.qc.

    {
        if (key == K_MWHEELUP)
            me.scrollPosTarget = max(me.scrollPosTarget - 0.5, 0);
        else if (key == K_MWHEELDOWN)
            me.scrollPosTarget = min(me.scrollPosTarget + 0.5, max(0, me.getTotalHeight(me) - 1));
        else if (key == K_PGUP || key == K_KP_PGUP)
        {
            if (me.selectionDoesntMatter)
            {
                me.scrollPosTarget = max(me.scrollPosTarget - 0.5, 0);
                return 1;
            }
 
            int i = me.selectedItem;
            float a = me.getItemHeight(me, i);
            for ( ; ; )
            {
                --i;
                if (i < 0)
                    break;
                a += me.getItemHeight(me, i);
                if (a >= 1)
                    break;
            }
            me.setSelected(me, i + 1);
        }
        else if (key == K_PGDN || key == K_KP_PGDN)
        {
            if (me.selectionDoesntMatter)
            {
                me.scrollPosTarget = min(me.scrollPosTarget + 0.5, me.nItems * me.itemHeight - 1);
                return 1;
            }
 
            int i = me.selectedItem;
            float a = me.getItemHeight(me, i);
            for ( ; ; )
            {
                ++i;
                if (i >= me.nItems)
                    break;
                a += me.getItemHeight(me, i);
                if (a >= 1)
                    break;
            }
            me.setSelected(me, i - 1);
        }
        else if (key == K_UPARROW || key == K_KP_UPARROW)
        {
            if (me.selectionDoesntMatter)
            {
                me.scrollPosTarget = max(me.scrollPosTarget - me.itemHeight, 0);
                return 1;
            }
 
            me.setSelected(me, me.selectedItem - 1);
        }
        else if (key == K_DOWNARROW || key == K_KP_DOWNARROW)
        {
            if (me.selectionDoesntMatter)
            {
                me.scrollPosTarget = min(me.scrollPosTarget + me.itemHeight, me.nItems * me.itemHeight - 1);
                return 1;
            }
 
            me.setSelected(me, me.selectedItem + 1);
        }
        else if (key == K_HOME || key == K_KP_HOME)
            me.setSelected(me, 0);
        else if (key == K_END || key == K_KP_END)
            me.setSelected(me, me.nItems - 1);
        else
            return 0;
        return 1;
    }

References entity(), K_DOWNARROW, K_END, K_HOME, K_KP_DOWNARROW, K_KP_END, K_KP_HOME, K_KP_PGDN, K_KP_PGUP, K_KP_UPARROW, K_MWHEELDOWN, K_MWHEELUP, K_PGDN, K_PGUP, K_UPARROW, max(), and min().

ListBox_mouseDrag()

float ListBox_mouseDrag	(	entity	me,
		vector	pos )

Definition at line 171 of file listbox.qc.

    {
        me.updateControlTopBottom(me);
        me.dragScrollPos = pos;
        if (me.pressed == 1 && me.getTotalHeight(me) > 1)
        {
            if (pos.x < 1 - me.controlWidth - me.tolerance.x * me.controlWidth
            || pos.y < 0 - me.tolerance.y
            || pos.x >= 1 + me.tolerance.x * me.controlWidth
            || pos.y >= 1 + me.tolerance.y)
                me.scrollPosTarget = me.previousValue;
            else // hit
            {
                // calculate new pos to v
                float d = (pos.y - me.pressOffset) / (1 - (me.controlBottom - me.controlTop)) * (me.getTotalHeight(me) - 1);
                me.scrollPosTarget = me.previousValue + d;
            }
            me.scrollPosTarget = min(me.scrollPosTarget, me.getTotalHeight(me) - 1);
            me.scrollPosTarget = max(me.scrollPosTarget, 0);
        }
        else if (me.pressed == 2)
        {
            int clickeditem = me.getItemAtPos(me, me.scrollPos + pos.y);
            me.setSelected(me, clickeditem);
            me.setFocusedItem(me, clickeditem);
            me.mouseMoveOffset = -1;
        }
        return 1;
    }

References entity(), max(), min(), and vector.

ListBox_mouseMove()

float ListBox_mouseMove	(	entity	me,
		vector	pos )

Definition at line 156 of file listbox.qc.

    {
        me.mouseMoveOffset = -1;
        if (pos.x < 0 || pos.y < 0 || pos.x >= 1 || pos.y >= 1)
            return 0;
 
        if (pos.x < 1 - me.controlWidth)
            me.mouseMoveOffset = pos.y;
        else
        {
            me.setFocusedItem(me, -1);
            me.mouseMoveOffset = -1;
        }
        return 1;
    }

References entity(), and vector.

ListBox_mouseRelease()

float ListBox_mouseRelease	(	entity	me,
		vector	pos )

Definition at line 249 of file listbox.qc.

    {
        if (me.pressed == 1)
        {
            // slider dragging mode
            // in that case, nothing happens on releasing
        }
        else if (me.pressed == 2)
        {
            me.pressed = 3;  // do that here, so setSelected can know the mouse has been released
            // item dragging mode
            // select current one one last time...
            int clickeditem = me.getItemAtPos(me, me.scrollPos + pos.y);
            me.setSelected(me, clickeditem);
            me.setFocusedItem(me, clickeditem);
            // and give it a nice click event
            if (me.nItems > 0)
            {
                vector where = globalToBox(pos, eY * (me.getItemStart(me, me.selectedItem) - me.scrollPos), eX * (1 - me.controlWidth) + eY * me.getItemHeight(me, me.selectedItem));
 
                if ((me.selectedItem == me.lastClickedItem && clickeditem == me.selectedItem) && (time < me.lastClickedTime + 0.3))
                    me.doubleClickListBoxItem(me, me.selectedItem, where);
                else
                    me.clickListBoxItem(me, me.selectedItem, where);
 
                me.lastClickedItem = me.selectedItem;
                me.lastClickedTime = time;
            }
        }
        me.pressed = 0;
        return 1;
    }

References entity(), eX, eY, globalToBox(), time, and vector.

ListBox_resizeNotify()

void ListBox_resizeNotify	(	entity	me,
		vector	relOrigin,
		vector	relSize,
		vector	absOrigin,
		vector	absSize )

Definition at line 43 of file listbox.qc.

    {
        SUPER(ListBox).resizeNotify(me, relOrigin, relSize, absOrigin, absSize);
        me.controlWidth = me.scrollbarWidth / absSize.x;
    }

References entity(), SUPER, and vector.

ListBox_scrollToItem()

void ListBox_scrollToItem	(	entity	me,
		int	i )

Definition at line 8 of file listbox.qc.

    {
        // scroll doesn't work properly until itemHeight is set to the correct value
        // at the first resizeNotify call
        if (me.itemHeight == 1)  // initial temporary value of itemHeight is 1
        {
            me.needScrollToItem = i;
            return;
        }
 
        i = bound(0, i, me.nItems - 1);
 
        // scroll the list to make sure the selected item is visible
        // (even if the selected item doesn't change).
        if (i < me.getFirstFullyVisibleItemAtScrollPos(me, me.scrollPos))
        {
            // above visible area
            me.scrollPosTarget = me.getItemStart(me, i);
        }
        else if (i > me.getLastFullyVisibleItemAtScrollPos(me, me.scrollPos))
        {
            // below visible area
            if (i == me.nItems - 1)
                me.scrollPosTarget = me.getTotalHeight(me) - 1;
            else
                me.scrollPosTarget = me.getItemStart(me, i + 1) - 1;
        }
    }

References bound(), and entity().

ListBox_setFocusedItem()

void ListBox_setFocusedItem	(	entity	me,
		int	item )

Definition at line 238 of file listbox.qc.

    {
        float focusedItem_save = me.focusedItem;
        me.focusedItem = (item >= 0 && item < me.nItems) ? item : -1;
        if (focusedItem_save != me.focusedItem)
        {
            me.focusedItemChangeNotify(me);
            if (me.focusedItem >= 0)
                me.focusedItemAlpha = SKINALPHA_LISTBOX_FOCUSED;
        }
    }

References entity().

ListBox_setSelected()

void ListBox_setSelected	(	entity	me,
		float	i )

Definition at line 37 of file listbox.qc.

    {
        i = bound(0, i, me.nItems - 1);
        me.scrollToItem(me, i);
        me.selectedItem = i;
    }

References bound(), and entity().

ListBox_updateControlTopBottom()

void ListBox_updateControlTopBottom

(

entity

me

)

Definition at line 290 of file listbox.qc.

    {
        // scrollPos is in 0..1 and indicates where the "page" currently shown starts.
        if (me.getTotalHeight(me) <= 1)
        {
            // we don't need no stinkin' scrollbar, we don't need no view control...
            me.controlTop = 0;
            me.controlBottom = 1;
            me.scrollPos = 0;
        }
        else
        {
            // if scroll pos is above beginning or below end of list, fix it
            me.scrollPos = bound(0, me.scrollPos, me.getTotalHeight(me) - 1);
            // now that we know where the list is scrolled to, find out where to draw the control
            me.controlTop = max(0, me.scrollPos / me.getTotalHeight(me));
            me.controlBottom = min((me.scrollPos + 1) / me.getTotalHeight(me), 1);
 
            const float minfactor = 2 * me.controlWidth / me.size.y * me.size.x;
            float f = me.controlBottom - me.controlTop;
            if (f < minfactor)  // FIXME good default?
            {
                // f * X + 1 * (1-X) = minfactor
                // (f - 1) * X + 1 = minfactor
                // (f - 1) * X = minfactor - 1
                // X = (minfactor - 1) / (f - 1)
                f = (minfactor - 1) / (f - 1);
                me.controlTop = me.controlTop * f + 0 * (1 - f);
                me.controlBottom = me.controlBottom * f + 1 * (1 - f);
            }
        }
    }

References bound(), entity(), max(), and min().