Inheritance diagram for Container:

Collaboration diagram for Container:

Public Member Functions
virtual void	addItem ()
virtual void	addItemCentered ()
virtual void	addItemRightCentered ()
	ATTRIB (Container, firstChild, entity)
	ATTRIB (Container, focusedChild, entity)
	ATTRIB (Container, lastChild, entity)
	ATTRIB (Container, savedFocus, entity)
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
virtual void	destroy ()
virtual void	draw ()
virtual void	enterLieSubitem ()
virtual void	enterSubitem ()
virtual void	focusEnter ()
virtual void	focusLeave ()
virtual void	hideNotify ()
virtual void	itemFromPoint ()
virtual void	keyDown ()
virtual void	keyUp ()
virtual void	leaveSubitem ()
virtual void	mouseDrag ()
virtual void	mouseMove ()
virtual void	mousePress ()
virtual void	mouseRelease ()
virtual void	moveItemAfter ()
virtual void	preferredFocusedGrandChild ()
virtual void	relinquishFocus ()
virtual void	removeItem ()
virtual void	resizeNotify ()
virtual void	resizeNotifyLie ()
virtual void	saveFocus ()
virtual void	setAlphaOf ()
virtual void	setFocus ()
virtual void	showNotify ()
virtual void	toString ()

Public Attributes
bool	allowFocusSound = false
bool	focusable = false
bool	focused = false
vector	origin = '0 0 0'
float	preferredFocusPriority = 0
bool	shown = false
vector	size = '0 0 0'

Detailed Description

Definition at line 5 of file container.qh.

Member Function Documentation

◆ addItem()

virtual void Container::addItem ( )

virtual

Reimplemented in ModalController, and Nexposee.

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

Referenced by addItem().

◆ addItemCentered()

virtual void Container::addItemCentered ( )

virtual

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

Referenced by addItemCentered().

◆ addItemRightCentered()

virtual void Container::addItemRightCentered ( )

virtual

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

Referenced by addItemRightCentered().

◆ ATTRIB() [1/6]

Container::ATTRIB	(	Container	,
		firstChild	,
		entity	)

References ATTRIB(), entity(), and firstChild.

Referenced by ATTRIB(), ATTRIB(), ATTRIB(), and ATTRIB().

◆ ATTRIB() [2/6]

Container::ATTRIB	(	Container	,
		focusedChild	,
		entity	)

References ATTRIB(), and entity().

◆ ATTRIB() [3/6]

Container::ATTRIB	(	Container	,
		lastChild	,
		entity	)

References ATTRIB(), and entity().

◆ ATTRIB() [4/6]

Container::ATTRIB	(	Container	,
		savedFocus	,
		entity	)

References ATTRIB(), and entity().

◆ ATTRIB() [5/6]

MenuItem::ATTRIB	(	MenuItem	,
		parent	,
		entity	)

inherited

References entity(), and parent.

◆ ATTRIB() [6/6]

MenuItem::ATTRIB	(	MenuItem	,
		tooltip	,
		string	)

inherited

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

◆ draw()

virtual void Container::draw ( )

virtual

Reimplemented from MenuItem.

Reimplemented in MainWindow, ModalController, Nexposee, XonoticGameMenuDialog, XonoticProfileTab, and XonoticWelcomeDialog.

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

Referenced by draw(), and XonoticScrollPanel::drawListBoxItem().

◆ enterLieSubitem()

virtual void Container::enterLieSubitem ( )

virtual

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

Referenced by enterLieSubitem().

◆ enterSubitem()

virtual void Container::enterSubitem ( )

virtual

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

Referenced by enterSubitem(), and mousePress().

◆ 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 Container::focusLeave ( )

virtual

Reimplemented from MenuItem.

Reimplemented in InputContainer.

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

Referenced by focusLeave().

◆ hideNotify()

virtual void Container::hideNotify ( )

virtual

Reimplemented from MenuItem.

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

Referenced by hideNotify().

◆ itemFromPoint()

virtual void Container::itemFromPoint ( )

virtual

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

Referenced by itemFromPoint().

◆ keyDown()

virtual void Container::keyDown ( )

virtual

Reimplemented from MenuItem.

Reimplemented in Dialog, InputContainer, Nexposee, XonoticScreenshotViewerDialog, and XonoticWelcomeDialog.

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

Referenced by keyDown().

◆ keyUp()

virtual void Container::keyUp ( )

virtual

Reimplemented from MenuItem.

Reimplemented in Nexposee.

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

Referenced by keyUp().

◆ leaveSubitem()

virtual void Container::leaveSubitem ( )

virtual

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

Referenced by leaveSubitem(), and mousePress().

◆ mouseDrag()

virtual void Container::mouseDrag ( )

virtual

Reimplemented from MenuItem.

Reimplemented in InputContainer, and Nexposee.

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

Referenced by mouseDrag().

◆ mouseMove()

virtual void Container::mouseMove ( )

virtual

Reimplemented from MenuItem.

Reimplemented in InputContainer, and Nexposee.

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

Referenced by mouseMove().

◆ mousePress()

void Container::mousePress ( )

virtual

Reimplemented from MenuItem.

Reimplemented in InputContainer, and Nexposee.

Definition at line 181 of file container.qc.

    {
        entity f = this.focusedChild;
        if (f)
        {
            this.enterSubitem(this, f);
            vector v = globalToBox(pos, f.Container_origin, f.Container_size);
            // If something in this container is focused but somehow the cursor is outside of the container it then
            // remove the focus on mouse press.
            //   This situation can happen after a stand-alone dialog like "Advanced Settings" is opened and then closed
            //   because the focused item of the current window is saved (by saveFocus) and then restored on close,
            //   regardless of mouse position.
            //   If the focus wasn't removed then clicking outside of the current window would do nothing instead of
            //   closing the current window and returning to the main menu.
            if (v.x < 0 || v.x > 1 || v.y < 0 || v.y > 1)
                this.setFocus(this, NULL);
            bool r = f.mousePress(f, v);
            this.leaveSubitem(this);
            return r;
        }
        return false;
    }

References enterSubitem(), entity(), globalToBox(), leaveSubitem(), mousePress(), NULL, setFocus(), and vector.

Referenced by mouseMove(), and mousePress().

◆ mouseRelease()

virtual void Container::mouseRelease ( )

virtual

Reimplemented from MenuItem.

Reimplemented in InputContainer, Nexposee, and XonoticWelcomeDialog.

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

Referenced by mouseRelease().

◆ moveItemAfter()

virtual void Container::moveItemAfter ( )

virtual

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

Referenced by moveItemAfter().

◆ preferredFocusedGrandChild()

virtual void Container::preferredFocusedGrandChild ( )

virtual

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

Referenced by preferredFocusedGrandChild().

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

◆ removeItem()

virtual void Container::removeItem ( )

virtual

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

Referenced by removeItem().

◆ resizeNotify()

virtual void Container::resizeNotify ( )

virtual

Reimplemented from MenuItem.

Reimplemented in InputContainer, ModalController, and Nexposee.

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

Referenced by resizeNotify().

◆ resizeNotifyLie()

virtual void Container::resizeNotifyLie ( )

virtual

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

Referenced by resizeNotifyLie().

◆ saveFocus()

virtual void Container::saveFocus ( )

virtual

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

Referenced by saveFocus().

◆ setAlphaOf()

virtual void Container::setAlphaOf ( )

virtual

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

Referenced by setAlphaOf().

◆ setFocus()

virtual void Container::setFocus ( )

virtual

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

Referenced by mousePress(), and setFocus().

◆ showNotify()

virtual void Container::showNotify ( )

virtual

Reimplemented from MenuItem.

Reimplemented in XonoticCvarsDialog, XonoticDamageTextSettings, XonoticGameCrosshairSettingsTab, XonoticGameHUDSettingsTab, XonoticGameMessageSettingsTab, XonoticGameModelSettingsTab, XonoticGameViewSettingsTab, XonoticGameWeaponsSettingsTab, XonoticMutatorsDialog, XonoticRootDialog, XonoticTab, and XonoticTeamSelectDialog.

References entity(), METHOD, and 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().

Member Data Documentation

◆ allowFocusSound

bool MenuItem::allowFocusSound = false

inherited

Definition at line 26 of file item.qh.

Referenced by focusEnter().

◆ focusable

bool Container::focusable = false

Definition at line 28 of file container.qh.

◆ focused

bool MenuItem::focused = false

inherited

Definition at line 24 of file item.qh.

◆ origin

vector MenuItem::origin = '0 0 0'

inherited

Definition at line 29 of file item.qh.

Referenced by resizeNotify().

◆ preferredFocusPriority

float MenuItem::preferredFocusPriority = 0

inherited

Definition at line 28 of file item.qh.

◆ shown

bool Container::shown = false

Definition at line 33 of file container.qh.

◆ size

vector MenuItem::size = '0 0 0'

inherited

Definition at line 30 of file item.qh.

Referenced by resizeNotify().

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

menu/item/container.qh
menu/item/container.qc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addItem()

◆ addItemCentered()

◆ addItemRightCentered()

◆ ATTRIB() [1/6]

◆ ATTRIB() [2/6]

◆ ATTRIB() [3/6]

◆ ATTRIB() [4/6]

◆ ATTRIB() [5/6]

◆ ATTRIB() [6/6]

◆ destroy()

◆ draw()

◆ enterLieSubitem()

◆ enterSubitem()

◆ focusEnter()

◆ focusLeave()

◆ hideNotify()

◆ itemFromPoint()

◆ keyDown()

◆ keyUp()

◆ leaveSubitem()

◆ mouseDrag()

◆ mouseMove()

◆ mousePress()

◆ mouseRelease()

◆ moveItemAfter()

◆ preferredFocusedGrandChild()

◆ relinquishFocus()

◆ removeItem()

◆ resizeNotify()

◆ resizeNotifyLie()

◆ saveFocus()

◆ setAlphaOf()

◆ setFocus()

◆ showNotify()

◆ toString()

Member Data Documentation

◆ allowFocusSound

◆ focusable

◆ focused

◆ origin

◆ preferredFocusPriority

◆ shown

◆ size