XonoticScrollPanel Class Reference

Inheritance diagram for XonoticScrollPanel:

Collaboration diagram for XonoticScrollPanel:

Public Member Functions
	ATTRIB (ListBox, src, string)
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
virtual void	clickListBoxItem ()
virtual void	configureListBox ()
virtual void	configureXonoticListBox ()
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	setFocus ()
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 = SKINCOLOR_SCROLLBAR_N
vector	color2 = SKINCOLOR_SCROLLBAR_S
vector	colorBG = SKINCOLOR_LISTBOX_BACKGROUND
vector	colorC = SKINCOLOR_SCROLLBAR_C
vector	colorF = SKINCOLOR_SCROLLBAR_F
float	controlBottom = 0
float	controlTop = 0
float	controlWidth = 0
entity	currentPanel = NEW(XonoticTab)
	container for single child panel
vector	dragScrollPos = '0 0 0'
bool	focusable = true
bool	focused = false
int	focusedItem = -1
float	focusedItemAlpha = 0.3
float	fontSize = SKINFONTSIZE_NORMAL
vector	itemAbsSize = '0 0 0'
float	itemHeight = 1
float	lastClickedItem = -1
float	lastClickedTime = 0
float	mouseMoveOffset = -1
float	needScrollToItem = -1
int	nItems = 1
vector	origin = '0 0 0'
float	preferredFocusPriority = 0
float	pressed = 0
float	pressOffset = 0
float	previousValue = 0
float	rowsPerItem = 1
float	scrollbarWidth = SKINWIDTH_SCROLLBAR
float	scrollPos = 0
float	scrollPosTarget = 0
int	selectedItem = 0
bool	selectionDoesntMatter = true
vector	size = '0 0 0'
string	src = SKINGFX_SCROLLBAR
vector	tolerance = '2 0.2 0'
float	viewportHeight = 12
	number of rows to show at once

Detailed Description

Definition at line 5 of file scrollpanel.qh.

Member Function Documentation

ATTRIB() [1/3]

ListBox::ATTRIB ( ListBox , src , string  )

inherited

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 ( )

virtualinherited

Reimplemented in XonoticGametypeList, XonoticMapList, and XonoticTopicList.

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

Referenced by clickListBoxItem().

configureListBox()

virtual void ListBox::configureListBox ( )

virtualinherited

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

Referenced by configureListBox().

configureXonoticListBox()

virtual void XonoticListBox::configureXonoticListBox ( )

virtualinherited

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

Referenced by XonoticEntryList::XonoticEntryList(), XonoticGuideDescription::XonoticGuideDescription(), XonoticRegisteredSettingsList::XonoticRegisteredSettingsList(), XonoticTopicList::XonoticTopicList(), and configureXonoticListBox().

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 ( )

virtualinherited

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 ( )

virtualinherited

Reimplemented from MenuItem.

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

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

Referenced by draw().

drawListBoxItem()

void XonoticScrollPanel::drawListBoxItem ( )

virtual

Reimplemented from ListBox.

Definition at line 3 of file scrollpanel.qc.

{
    XonoticTab p = this.currentPanel;
    p.draw(p);
}

References currentPanel, Container::draw(), drawListBoxItem(), and vector.

Referenced by drawListBoxItem().

focusedItemChangeNotify()

virtual void ListBox::focusedItemChangeNotify ( )

virtualinherited

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 ( )

virtualinherited

Reimplemented from MenuItem.

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

Referenced by focusLeave().

getFirstFullyVisibleItemAtScrollPos()

virtual void ListBox::getFirstFullyVisibleItemAtScrollPos ( )

virtualinherited

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

Referenced by getFirstFullyVisibleItemAtScrollPos().

getItemAtPos()

virtual void XonoticScrollPanel::getItemAtPos ( )

inlinevirtual

Reimplemented from ListBox.

Definition at line 15 of file scrollpanel.qh.

{ return 0; }

References getItemAtPos(), METHOD, and this.

Referenced by getItemAtPos().

getItemHeight()

virtual void XonoticScrollPanel::getItemHeight ( )

inlinevirtual

Reimplemented from ListBox.

Definition at line 16 of file scrollpanel.qh.

{ return this.itemHeight; }

References getItemHeight(), and itemHeight.

Referenced by getItemHeight().

getItemStart()

virtual void XonoticScrollPanel::getItemStart ( )

inlinevirtual

Reimplemented from ListBox.

Definition at line 17 of file scrollpanel.qh.

{ return 0; }

References getItemStart().

Referenced by getItemStart().

getLastFullyVisibleItemAtScrollPos()

virtual void ListBox::getLastFullyVisibleItemAtScrollPos ( )

virtualinherited

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

Referenced by getLastFullyVisibleItemAtScrollPos().

getTotalHeight()

virtual void XonoticScrollPanel::getTotalHeight ( )

inlinevirtual

Reimplemented from ListBox.

Definition at line 18 of file scrollpanel.qh.

{ return this.itemHeight; }

References getTotalHeight(), and itemHeight.

Referenced by getTotalHeight().

hideNotify()

void MenuItem::hideNotify ( )

virtualinherited

Reimplemented in Container, and XonoticCvarList.

Definition at line 59 of file item.qc.

    {}

References hideNotify().

Referenced by hideNotify().

isScrolling()

virtual void ListBox::isScrolling ( )

virtualinherited

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

Referenced by isScrolling().

keyDown()

virtual void ListBox::keyDown ( )

virtualinherited

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 ( )

virtualinherited

Reimplemented from MenuItem.

Reimplemented in XonoticPlayList, and XonoticWeaponsList.

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

Referenced by mouseDrag().

mouseMove()

virtual void ListBox::mouseMove ( )

virtualinherited

Reimplemented from MenuItem.

Reimplemented in XonoticServerList.

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

Referenced by mouseMove().

mousePress()

void ListBox::mousePress ( )

virtualinherited

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 ( )

virtualinherited

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()

void XonoticScrollPanel::resizeNotify ( )

virtual

Reimplemented from XonoticListBox.

Definition at line 9 of file scrollpanel.qc.

{
    SUPER(XonoticScrollPanel).resizeNotify(this, relOrigin, relSize, absOrigin, absSize);
    this.scrollToItem(this, 0);
    XonoticTab p = this.currentPanel;
    float m = p.firstChild.rows / this.viewportHeight;
    this.itemHeight = m;
    relSize.y *= m;
    absSize.y *= m;
    p.resizeNotify(p, relOrigin, relSize, absOrigin, absSize);
}

References currentPanel, itemHeight, InputContainer::resizeNotify(), resizeNotify(), Tab::rows, ListBox::scrollToItem(), SUPER, vector, and viewportHeight.

Referenced by resizeNotify().

scrollToItem()

virtual void ListBox::scrollToItem ( )

virtualinherited

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

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

setFocus()

virtual void XonoticScrollPanel::setFocus ( )

inlinevirtual

Definition at line 19 of file scrollpanel.qh.

{ Container_setFocus(this, other); }

References Container_setFocus(), entity(), other, and setFocus().

Referenced by setFocus().

setFocusedItem()

virtual void ListBox::setFocusedItem ( )

virtualinherited

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

Referenced by mousePress(), and setFocusedItem().

setSelected()

virtual void XonoticScrollPanel::setSelected ( )

inlinevirtual

Reimplemented from ListBox.

Definition at line 20 of file scrollpanel.qh.

{ }

References setSelected().

Referenced by 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.

    {}

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 ( )

virtualinherited

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

Referenced by mousePress(), and updateControlTopBottom().

Member Data Documentation

allowFocusSound

bool ListBox::allowFocusSound = true

inherited

Definition at line 19 of file listbox.qh.

alphaBG

float XonoticScrollPanel::alphaBG = 0

Definition at line 13 of file scrollpanel.qh.

color

vector XonoticListBox::color = SKINCOLOR_SCROLLBAR_N

inherited

Definition at line 12 of file listbox.qh.

color2

vector XonoticListBox::color2 = SKINCOLOR_SCROLLBAR_S

inherited

Definition at line 14 of file listbox.qh.

colorBG

vector XonoticListBox::colorBG = SKINCOLOR_LISTBOX_BACKGROUND

inherited

Definition at line 16 of file listbox.qh.

colorC

vector XonoticListBox::colorC = SKINCOLOR_SCROLLBAR_C

inherited

Definition at line 15 of file listbox.qh.

colorF

vector XonoticListBox::colorF = SKINCOLOR_SCROLLBAR_F

inherited

Definition at line 13 of file listbox.qh.

controlBottom

float ListBox::controlBottom = 0

inherited

Definition at line 34 of file listbox.qh.

controlTop

float ListBox::controlTop = 0

inherited

Definition at line 33 of file listbox.qh.

controlWidth

float ListBox::controlWidth = 0

inherited

Definition at line 35 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::resizeNotify().

currentPanel

entity XonoticScrollPanel::currentPanel = NEW(XonoticTab)

container for single child panel

Definition at line 7 of file scrollpanel.qh.

Referenced by drawListBoxItem(), and resizeNotify().

dragScrollPos

vector ListBox::dragScrollPos = '0 0 0'

inherited

Definition at line 36 of file listbox.qh.

Referenced by mousePress().

focusable

bool ListBox::focusable = true

inherited

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

inherited

Definition at line 15 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::focusedItemChangeNotify().

focusedItemAlpha

float ListBox::focusedItemAlpha = 0.3

inherited

Definition at line 16 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::drawListBoxItem().

fontSize

float XonoticListBox::fontSize = SKINFONTSIZE_NORMAL

inherited

Definition at line 6 of file listbox.qh.

Referenced by XonoticRegisteredSettingsList::resizeNotify().

itemAbsSize

vector ListBox::itemAbsSize = '0 0 0'

inherited

Definition at line 48 of file listbox.qh.

itemHeight

float XonoticScrollPanel::itemHeight = 1

Definition at line 10 of file scrollpanel.qh.

Referenced by getItemHeight(), getTotalHeight(), and resizeNotify().

lastClickedItem

float ListBox::lastClickedItem = -1

inherited

Definition at line 52 of file listbox.qh.

lastClickedTime

float ListBox::lastClickedTime = 0

inherited

Definition at line 53 of file listbox.qh.

mouseMoveOffset

float ListBox::mouseMoveOffset = -1

inherited

Definition at line 18 of file listbox.qh.

needScrollToItem

float ListBox::needScrollToItem = -1

inherited

Definition at line 26 of file listbox.qh.

nItems

int XonoticScrollPanel::nItems = 1

Definition at line 8 of file scrollpanel.qh.

origin

vector ListBox::origin = '0 0 0'

inherited

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

inherited

Definition at line 29 of file listbox.qh.

Referenced by mousePress().

pressOffset

float ListBox::pressOffset = 0

inherited

Definition at line 30 of file listbox.qh.

Referenced by mousePress().

previousValue

float ListBox::previousValue = 0

inherited

Definition at line 28 of file listbox.qh.

Referenced by mousePress().

rowsPerItem

float XonoticListBox::rowsPerItem = 1

inherited

Definition at line 10 of file listbox.qh.

scrollbarWidth

float XonoticListBox::scrollbarWidth = SKINWIDTH_SCROLLBAR

inherited

Definition at line 7 of file listbox.qh.

scrollPos

float ListBox::scrollPos = 0

inherited

Definition at line 23 of file listbox.qh.

Referenced by mousePress().

scrollPosTarget

float ListBox::scrollPosTarget = 0

inherited

Definition at line 24 of file listbox.qh.

Referenced by mousePress().

selectedItem

int ListBox::selectedItem = 0

inherited

Definition at line 20 of file listbox.qh.

selectionDoesntMatter

bool XonoticScrollPanel::selectionDoesntMatter = true

Definition at line 9 of file scrollpanel.qh.

size

vector ListBox::size = '0 0 0'

inherited

Definition at line 21 of file listbox.qh.

src

string XonoticListBox::src = SKINGFX_SCROLLBAR

inherited

Definition at line 8 of file listbox.qh.

tolerance

vector XonoticListBox::tolerance = '2 0.2 0'

inherited

Definition at line 9 of file listbox.qh.

viewportHeight

float XonoticScrollPanel::viewportHeight = 12

number of rows to show at once

Definition at line 12 of file scrollpanel.qh.

Referenced by resizeNotify().

---

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

• menu/xonotic/scrollpanel.qh
• menu/xonotic/scrollpanel.qc