Inheritance diagram for ListBox:

Collaboration diagram for ListBox:

Public Member Functions
	ATTRIB (ListBox, src, string)
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
virtual void	clickListBoxItem ()
virtual void	configureListBox ()
virtual void	destroy ()
virtual void	doubleClickListBoxItem ()
virtual void	draw ()
virtual void	drawListBoxItem ()
virtual void	focusedItemChangeNotify ()
virtual void	focusEnter ()
virtual void	focusLeave ()
virtual void	getFirstFullyVisibleItemAtScrollPos ()
virtual void	getItemAtPos ()
virtual void	getItemHeight ()
virtual void	getItemStart ()
virtual void	getLastFullyVisibleItemAtScrollPos ()
virtual void	getTotalHeight ()
virtual void	hideNotify ()
virtual void	isScrolling ()
virtual void	keyDown ()
virtual void	keyUp ()
virtual void	mouseDrag ()
virtual void	mouseMove ()
virtual void	mousePress ()
virtual void	mouseRelease ()
virtual void	relinquishFocus ()
virtual void	resizeNotify ()
virtual void	scrollToItem ()
virtual void	setFocusedItem ()
virtual void	setSelected ()
virtual void	showNotify ()
virtual void	toString ()
virtual void	updateControlTopBottom ()

Public Attributes
bool	allowFocusSound = true
float	alphaBG = 0
vector	color = '1 1 1'
vector	color2 = '1 1 1'
vector	colorBG = '0 0 0'
vector	colorC = '1 1 1'
vector	colorF = '1 1 1'
float	controlBottom = 0
float	controlTop = 0
float	controlWidth = 0
vector	dragScrollPos = '0 0 0'
bool	focusable = true
bool	focused = false
int	focusedItem = -1
float	focusedItemAlpha = 0.3
vector	itemAbsSize = '0 0 0'
float	itemHeight = 0
float	lastClickedItem = -1
float	lastClickedTime = 0
float	mouseMoveOffset = -1
float	needScrollToItem = -1
int	nItems = 42
vector	origin = '0 0 0'
float	preferredFocusPriority = 0
float	pressed = 0
float	pressOffset = 0
float	previousValue = 0
float	scrollbarWidth = 0
float	scrollPos = 0
float	scrollPosTarget = 0
int	selectedItem = 0
bool	selectionDoesntMatter = false
vector	size = '0 0 0'
vector	tolerance = '0 0 0'

Detailed Description

Definition at line 4 of file listbox.qh.

Member Function Documentation

◆ ATTRIB() [1/3]

ListBox::ATTRIB	(	ListBox	,
		src	,
		string	)

References ATTRIB().

Referenced by ATTRIB().

◆ ATTRIB() [2/3]

MenuItem::ATTRIB	(	MenuItem	,
		parent	,
		entity	)

inherited

References entity(), and parent.

◆ ATTRIB() [3/3]

MenuItem::ATTRIB	(	MenuItem	,
		tooltip	,
		string	)

inherited

◆ clickListBoxItem()

virtual void ListBox::clickListBoxItem ( )

virtual

Reimplemented in XonoticGametypeList, XonoticMapList, and XonoticTopicList.

References clickListBoxItem(), entity(), METHOD, and vector.

Referenced by clickListBoxItem().

◆ configureListBox()

virtual void ListBox::configureListBox ( )

virtual

References configureListBox(), entity(), and METHOD.

Referenced by configureListBox().

◆ destroy()

void MenuItem::destroy ( )

virtualinherited

Reimplemented in XonoticCampaignList, XonoticCreditsList, XonoticCvarList, XonoticDemoList, XonoticGameMenuDialog, XonoticHUDSkinList, XonoticKeyBinder, XonoticLanguageList, XonoticMapList, XonoticPlayerModelSelector, XonoticScreenshotList, XonoticSkinList, XonoticSoundList, XonoticStatsList, XonoticTextBox, and XonoticWelcomeDialog.

Definition at line 6 of file item.qc.

    {
        // free memory associated with this
    }

References destroy().

Referenced by destroy().

◆ doubleClickListBoxItem()

virtual void ListBox::doubleClickListBoxItem ( )

virtual

Reimplemented in XonoticCampaignList, XonoticDemoList, XonoticHUDSkinList, XonoticKeyBinder, XonoticLanguageList, XonoticMapList, XonoticPlayList, XonoticScreenshotList, XonoticServerList, XonoticSkinList, XonoticSoundList, and XonoticStatsList.

References doubleClickListBoxItem(), entity(), METHOD, and vector.

Referenced by doubleClickListBoxItem().

◆ draw()

virtual void ListBox::draw ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticCampaignList, XonoticCreditsList, XonoticGametypeList, XonoticHUDSkinList, XonoticMapList, XonoticPlayList, XonoticScreenshotList, XonoticServerList, and XonoticWeaponsList.

References draw(), entity(), and METHOD.

Referenced by draw().

◆ drawListBoxItem()

virtual void ListBox::drawListBoxItem ( )

virtual

◆ focusedItemChangeNotify()

virtual void ListBox::focusedItemChangeNotify ( )

virtual

Reimplemented in XonoticGametypeList, XonoticLanguageList, XonoticRegisteredSettingsList, and XonoticServerList.

References entity(), focusedItemChangeNotify(), and METHOD.

Referenced by focusedItemChangeNotify().

◆ focusEnter()

void MenuItem::focusEnter ( )

virtualinherited

Reimplemented in Nexposee, XonoticCreditsDialog, XonoticServerList, and XonoticWinnerDialog.

Definition at line 94 of file item.qc.

    {
        if (this.allowFocusSound) m_play_focus_sound();
    }

References allowFocusSound, focusEnter(), and m_play_focus_sound().

Referenced by focusEnter().

◆ focusLeave()

virtual void ListBox::focusLeave ( )

virtual

Reimplemented from MenuItem.

References entity(), focusLeave(), and METHOD.

Referenced by focusLeave().

◆ getFirstFullyVisibleItemAtScrollPos()

virtual void ListBox::getFirstFullyVisibleItemAtScrollPos ( )

virtual

References entity(), getFirstFullyVisibleItemAtScrollPos(), and METHOD.

Referenced by getFirstFullyVisibleItemAtScrollPos().

◆ getItemAtPos()

virtual void ListBox::getItemAtPos ( )

virtual

Reimplemented in XonoticScrollPanel, and XonoticServerList.

References entity(), getItemAtPos(), and METHOD.

Referenced by getItemAtPos(), and mousePress().

◆ getItemHeight()

virtual void ListBox::getItemHeight ( )

virtual

Reimplemented in XonoticScrollPanel, and XonoticServerList.

References ENDCLASS, entity(), getItemHeight(), and METHOD.

Referenced by getItemHeight().

◆ getItemStart()

virtual void ListBox::getItemStart ( )

virtual

Reimplemented in XonoticScrollPanel, and XonoticServerList.

References entity(), getItemStart(), and METHOD.

Referenced by getItemStart().

◆ getLastFullyVisibleItemAtScrollPos()

virtual void ListBox::getLastFullyVisibleItemAtScrollPos ( )

virtual

References entity(), getLastFullyVisibleItemAtScrollPos(), and METHOD.

Referenced by getLastFullyVisibleItemAtScrollPos().

◆ getTotalHeight()

virtual void ListBox::getTotalHeight ( )

virtual

Reimplemented in XonoticScrollPanel, and XonoticServerList.

References entity(), getTotalHeight(), and METHOD.

Referenced by getTotalHeight(), and mousePress().

◆ hideNotify()

void MenuItem::hideNotify ( )

virtualinherited

Reimplemented in Container, and XonoticCvarList.

Definition at line 59 of file item.qc.

60 {}

References hideNotify().

Referenced by hideNotify().

◆ isScrolling()

virtual void ListBox::isScrolling ( )

virtual

References entity(), isScrolling(), and METHOD.

Referenced by isScrolling().

◆ keyDown()

virtual void ListBox::keyDown ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticCampaignList, XonoticCreditsList, XonoticCvarList, XonoticDemoList, XonoticEntryList, XonoticGametypeList, XonoticHUDSkinList, XonoticKeyBinder, XonoticLanguageList, XonoticMapList, XonoticPlayList, XonoticScreenshotList, XonoticServerList, XonoticSkinList, XonoticSoundList, XonoticStatsList, XonoticTopicList, and XonoticWeaponsList.

References entity(), keyDown(), and METHOD.

Referenced by keyDown().

◆ keyUp()

void MenuItem::keyUp ( )

virtualinherited

Reimplemented in Container, Nexposee, and Slider.

Definition at line 67 of file item.qc.

    {
        return 0;  // unhandled
    }

References keyUp().

Referenced by keyUp().

◆ mouseDrag()

virtual void ListBox::mouseDrag ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticPlayList, and XonoticWeaponsList.

References entity(), METHOD, mouseDrag(), and vector.

Referenced by mouseDrag().

◆ mouseMove()

virtual void ListBox::mouseMove ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticServerList.

References entity(), METHOD, mouseMove(), mousePress(), this, and vector.

Referenced by mouseMove().

◆ mousePress()

void ListBox::mousePress ( )

virtual

Reimplemented from MenuItem.

Definition at line 212 of file listbox.qc.

    {
        if (pos.x < 0) return false;
        if (pos.y < 0) return false;
        if (pos.x >= 1) return false;
        if (pos.y >= 1) return false;
        this.dragScrollPos = pos;
        this.updateControlTopBottom(this);
        if (pos.x >= 1 - this.controlWidth)
        {
            // if hit, set this.pressed, otherwise scroll by one page
            if (pos.y < this.controlTop)
            {
                // page up
                this.scrollPosTarget = max(this.scrollPosTarget - 1, 0);
            }
            else if (pos.y > this.controlBottom)
            {
                // page down
                this.scrollPosTarget = min(this.scrollPosTarget + 1, this.getTotalHeight(this) - 1);
            }
            else
            {
                this.pressed = 1;
                this.pressOffset = pos.y;
                this.previousValue = this.scrollPos;
            }
        }
        else
        {
            // continue doing that while dragging (even when dragging outside). When releasing, forward the click to the then selected item.
            this.pressed = 2;
            // an item has been clicked. Select it, ...
            int clickeditem = this.getItemAtPos(this, this.scrollPos + pos.y);
            this.setSelected(this, clickeditem);
            this.setFocusedItem(this, clickeditem);
        }
        return true;
    }

References dragScrollPos, getItemAtPos(), getTotalHeight(), max(), min(), mousePress(), pressed, pressOffset, previousValue, scrollPos, scrollPosTarget, setFocusedItem(), setSelected(), updateControlTopBottom(), and vector.

Referenced by mouseMove(), and mousePress().

◆ mouseRelease()

virtual void ListBox::mouseRelease ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticCvarList.

References entity(), METHOD, mouseRelease(), and vector.

Referenced by mouseRelease().

◆ relinquishFocus()

void MenuItem::relinquishFocus ( )

virtualinherited

Definition at line 11 of file item.qc.

    {
        entity par = this.parent;
        if (!par) return;
        if (par.instanceOfContainer) par.setFocus(par, NULL);
    }

References entity(), NULL, parent, and relinquishFocus().

Referenced by relinquishFocus().

◆ resizeNotify()

virtual void ListBox::resizeNotify ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticCampaignList, XonoticCreditsList, XonoticCvarList, XonoticDemoList, XonoticEntryList, XonoticGametypeList, XonoticGuideDescription, XonoticHUDSkinList, XonoticKeyBinder, XonoticLanguageList, XonoticListBox, XonoticMapList, XonoticPlayerList, XonoticPlayList, XonoticRegisteredSettingsList, XonoticScreenshotList, XonoticScrollPanel, XonoticServerList, XonoticSkinList, XonoticSoundList, XonoticStatsList, XonoticTextBox, XonoticTopicList, and XonoticWeaponsList.

References entity(), METHOD, resizeNotify(), and vector.

Referenced by resizeNotify().

◆ scrollToItem()

virtual void ListBox::scrollToItem ( )

virtual

References entity(), METHOD, and scrollToItem().

Referenced by XonoticScrollPanel::resizeNotify(), and scrollToItem().

◆ setFocusedItem()

virtual void ListBox::setFocusedItem ( )

virtual

References entity(), METHOD, and setFocusedItem().

Referenced by mousePress(), and setFocusedItem().

◆ setSelected()

virtual void ListBox::setSelected ( )

virtual

Reimplemented in XonoticCampaignList, XonoticCvarList, XonoticEntryList, XonoticGametypeList, XonoticKeyBinder, XonoticLanguageList, XonoticRegisteredSettingsList, XonoticScreenshotList, XonoticScrollPanel, XonoticServerList, and XonoticTopicList.

References entity(), METHOD, and setSelected().

Referenced by mousePress(), and setSelected().

◆ showNotify()

void MenuItem::showNotify ( )

virtualinherited

Reimplemented in Button, Container, InputBox, Slider, XonoticCvarList, XonoticCvarsDialog, XonoticDamageTextSettings, XonoticDemoList, XonoticGameCrosshairSettingsTab, XonoticGameHUDSettingsTab, XonoticGameMessageSettingsTab, XonoticGameModelSettingsTab, XonoticGameViewSettingsTab, XonoticGameWeaponsSettingsTab, XonoticHUDSkinList, XonoticKeyBinder, XonoticMutatorsDialog, XonoticPlayerModelSelector, XonoticRootDialog, XonoticScreenshotList, XonoticSoundList, XonoticStatsList, XonoticTab, and XonoticTeamSelectDialog.

Definition at line 56 of file item.qc.

57 {}

References showNotify().

Referenced by showNotify().

◆ toString()

void MenuItem::toString ( )

virtualinherited

Reimplemented in CheckBox, Image, Label, Slider, and XonoticWeaponsList.

Definition at line 102 of file item.qc.

    {
        return string_null;
    }

References string_null, and toString().

Referenced by toString().

◆ updateControlTopBottom()

virtual void ListBox::updateControlTopBottom ( )

virtual

References entity(), METHOD, and updateControlTopBottom().

Referenced by mousePress(), and updateControlTopBottom().

Member Data Documentation

◆ allowFocusSound

bool ListBox::allowFocusSound = true

Definition at line 19 of file listbox.qh.

◆ alphaBG

float ListBox::alphaBG = 0

Definition at line 50 of file listbox.qh.

◆ color

vector ListBox::color = '1 1 1'

Definition at line 40 of file listbox.qh.

◆ color2

vector ListBox::color2 = '1 1 1'

Definition at line 41 of file listbox.qh.

◆ colorBG

vector ListBox::colorBG = '0 0 0'

Definition at line 49 of file listbox.qh.

◆ colorC

vector ListBox::colorC = '1 1 1'

Definition at line 42 of file listbox.qh.

◆ colorF

vector ListBox::colorF = '1 1 1'

Definition at line 43 of file listbox.qh.

◆ controlBottom

float ListBox::controlBottom = 0

Definition at line 34 of file listbox.qh.

◆ controlTop

float ListBox::controlTop = 0

Definition at line 33 of file listbox.qh.

◆ controlWidth

float ListBox::controlWidth = 0

Definition at line 35 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::resizeNotify().

◆ dragScrollPos

vector ListBox::dragScrollPos = '0 0 0'

Definition at line 36 of file listbox.qh.

Referenced by mousePress().

◆ focusable

bool ListBox::focusable = true

Definition at line 14 of file listbox.qh.

◆ focused

bool MenuItem::focused = false

inherited

Definition at line 24 of file item.qh.

◆ focusedItem

int ListBox::focusedItem = -1

Definition at line 15 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::focusedItemChangeNotify().

◆ focusedItemAlpha

float ListBox::focusedItemAlpha = 0.3

Definition at line 16 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::drawListBoxItem().

◆ itemAbsSize

vector ListBox::itemAbsSize = '0 0 0'

Definition at line 48 of file listbox.qh.

◆ itemHeight

float ListBox::itemHeight = 0

Definition at line 47 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::resizeNotify().

◆ lastClickedItem

float ListBox::lastClickedItem = -1

Definition at line 52 of file listbox.qh.

◆ lastClickedTime

float ListBox::lastClickedTime = 0

Definition at line 53 of file listbox.qh.

◆ mouseMoveOffset

float ListBox::mouseMoveOffset = -1

Definition at line 18 of file listbox.qh.

◆ needScrollToItem

float ListBox::needScrollToItem = -1

Definition at line 26 of file listbox.qh.

◆ nItems

int ListBox::nItems = 42

Definition at line 46 of file listbox.qh.

Referenced by XonoticTopicList::XonoticTopicList(), XonoticEntryList::keyDown(), and XonoticRegisteredSettingsList::refilter().

◆ origin

vector ListBox::origin = '0 0 0'

Definition at line 22 of file listbox.qh.

◆ preferredFocusPriority

float MenuItem::preferredFocusPriority = 0

inherited

Definition at line 28 of file item.qh.

◆ pressed

float ListBox::pressed = 0

Definition at line 29 of file listbox.qh.

Referenced by mousePress().

◆ pressOffset

float ListBox::pressOffset = 0

Definition at line 30 of file listbox.qh.

Referenced by mousePress().

◆ previousValue

float ListBox::previousValue = 0

Definition at line 28 of file listbox.qh.

Referenced by mousePress().

◆ scrollbarWidth

float ListBox::scrollbarWidth = 0

Definition at line 45 of file listbox.qh.

◆ scrollPos

float ListBox::scrollPos = 0

Definition at line 23 of file listbox.qh.

Referenced by mousePress().

◆ scrollPosTarget

float ListBox::scrollPosTarget = 0

Definition at line 24 of file listbox.qh.

Referenced by mousePress().

◆ selectedItem

int ListBox::selectedItem = 0

Definition at line 20 of file listbox.qh.

◆ selectionDoesntMatter

bool ListBox::selectionDoesntMatter = false

Definition at line 37 of file listbox.qh.

◆ size

vector ListBox::size = '0 0 0'

Definition at line 21 of file listbox.qh.

◆ tolerance

vector ListBox::tolerance = '0 0 0'

Definition at line 44 of file listbox.qh.

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

menu/item/listbox.qh
menu/item/listbox.qc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ATTRIB() [1/3]

◆ ATTRIB() [2/3]

◆ ATTRIB() [3/3]

◆ clickListBoxItem()

◆ configureListBox()

◆ destroy()

◆ doubleClickListBoxItem()

◆ draw()

◆ drawListBoxItem()

◆ focusedItemChangeNotify()

◆ focusEnter()

◆ focusLeave()

◆ getFirstFullyVisibleItemAtScrollPos()

◆ getItemAtPos()

◆ getItemHeight()

◆ getItemStart()

◆ getLastFullyVisibleItemAtScrollPos()

◆ getTotalHeight()

◆ hideNotify()

◆ isScrolling()

◆ keyDown()

◆ keyUp()

◆ mouseDrag()

◆ mouseMove()

◆ mousePress()

◆ mouseRelease()

◆ relinquishFocus()

◆ resizeNotify()

◆ scrollToItem()

◆ setFocusedItem()

◆ setSelected()

◆ showNotify()

◆ toString()

◆ updateControlTopBottom()

Member Data Documentation

◆ allowFocusSound

◆ alphaBG

◆ color

◆ color2

◆ colorBG

◆ colorC

◆ colorF

◆ controlBottom

◆ controlTop

◆ controlWidth

◆ dragScrollPos

◆ focusable

◆ focused

◆ focusedItem

◆ focusedItemAlpha

◆ itemAbsSize

◆ itemHeight

◆ lastClickedItem

◆ lastClickedTime

◆ mouseMoveOffset

◆ needScrollToItem

◆ nItems

◆ origin

◆ preferredFocusPriority

◆ pressed

◆ pressOffset

◆ previousValue

◆ scrollbarWidth

◆ scrollPos

◆ scrollPosTarget

◆ selectedItem

◆ selectionDoesntMatter

◆ size

◆ tolerance