MenuItem Class Reference

Inheritance diagram for MenuItem:

Collaboration diagram for MenuItem:

Public Member Functions
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
virtual void	destroy ()
virtual void	draw ()
virtual void	focusEnter ()
virtual void	focusLeave ()
virtual void	hideNotify ()
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	showNotify ()
virtual void	toString ()

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

Detailed Description

Definition at line 8 of file item.qh.

Member Function Documentation

ATTRIB() [1/2]

MenuItem::ATTRIB	(	MenuItem	,
		parent	,
		entity	)

References entity(), and parent.

ATTRIB() [2/2]

MenuItem::ATTRIB	(	MenuItem	,
		tooltip	,
		string	)

destroy()

void MenuItem::destroy ( )

virtual

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

void MenuItem::draw ( )

virtual

Reimplemented in BorderImage, Button, CheckBox, Container, Image, InputBox, Label, ListBox, MainWindow, ModalController, Nexposee, Slider, XonoticCampaignList, XonoticColorButton, XonoticColorpicker, XonoticColorpickerString, XonoticCreditsList, XonoticCrosshairPreview, XonoticGameMenuDialog, XonoticGametypeList, XonoticHUDSkinList, XonoticLeaveMatchButton, XonoticMapList, XonoticPicker, XonoticPicmipSlider, XonoticPlayerModelSelector, XonoticPlayList, XonoticProfileTab, XonoticRadioButton, XonoticResolutionSlider, XonoticScreenshotImage, XonoticScreenshotList, XonoticServerList, XonoticSliderCheckBox, XonoticTextLabel, XonoticWeaponsList, and XonoticWelcomeDialog.

Definition at line 25 of file item.qc.

    {
        if (!autocvar_menu_showboxes) return;
        vector rgb = '1 0 1';
        float a = fabs(autocvar_menu_showboxes);
 
        // don't draw containers and border images
        if (this.instanceOfContainer || this.instanceOfBorderImage)
        {
            rgb = '0 0 0';
            a = 0;
        }
 
        #if 0
            // hack to detect multi drawing
            float r = random() * 3;
            if (r >= 2) rgb = '1 0 0';
            else if (r >= 1) rgb = '0 1 0';
            else rgb = '0 0 1';
        #endif
        if (autocvar_menu_showboxes < 0)
        {
            draw_Fill('0 0 0', '0.5 0.5 0', rgb, a);
            draw_Fill('0.5 0.5 0', '0.5 0.5 0', rgb, a);
        }
        else if (autocvar_menu_showboxes > 0)
        {
            draw_Fill('0 0 0', '1 1 0', rgb, a);
        }
    }

References autocvar_menu_showboxes, draw(), draw_Fill(), fabs(), random(), and vector.

Referenced by draw().

focusEnter()

void MenuItem::focusEnter ( )

virtual

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

void MenuItem::focusLeave ( )

virtual

Reimplemented in Container, InputContainer, ListBox, XonoticCharmap, XonoticColorpicker, and XonoticInputBox.

Definition at line 99 of file item.qc.

    {}

References focusLeave().

Referenced by focusLeave().

hideNotify()

void MenuItem::hideNotify ( )

virtual

Reimplemented in Container, and XonoticCvarList.

Definition at line 59 of file item.qc.

    {}

References hideNotify().

Referenced by hideNotify().

keyDown()

void MenuItem::keyDown ( )

virtual

Reimplemented in Button, Container, Dialog, InputBox, InputContainer, ListBox, Nexposee, Slider, XonoticCampaignList, XonoticCharmap, XonoticColorpicker, XonoticCreditsList, XonoticCvarList, XonoticDemoList, XonoticEntryList, XonoticGametypeList, XonoticHUDSkinList, XonoticInputBox, XonoticKeyBinder, XonoticLanguageList, XonoticMapList, XonoticPicker, XonoticPlayList, XonoticScreenshotList, XonoticScreenshotViewerDialog, XonoticServerList, XonoticSkinList, XonoticSoundList, XonoticStatsList, XonoticTopicList, XonoticWeaponsList, and XonoticWelcomeDialog.

Definition at line 62 of file item.qc.

    {
        return 0;  // unhandled
    }

References keyDown().

Referenced by keyDown().

keyUp()

void MenuItem::keyUp ( )

virtual

Reimplemented in Container, Nexposee, and Slider.

Definition at line 67 of file item.qc.

    {
        return 0;  // unhandled
    }

References keyUp().

Referenced by keyUp().

mouseDrag()

void MenuItem::mouseDrag ( )

virtual

Reimplemented in Button, Container, InputBox, InputContainer, ListBox, Nexposee, Slider, XonoticColorpicker, XonoticColorpickerString, XonoticPicker, XonoticPlayList, XonoticScreenshotImage, and XonoticWeaponsList.

Definition at line 82 of file item.qc.

    {
        return 0;  // unhandled
    }

References mouseDrag(), and vector.

Referenced by mouseDrag().

mouseMove()

void MenuItem::mouseMove ( )

virtual

Reimplemented in Container, InputBox, InputContainer, ListBox, Nexposee, XonoticPicker, XonoticScreenshotImage, and XonoticServerList.

Definition at line 72 of file item.qc.

    {
        return 0;  // unhandled
    }

References mouseMove(), and vector.

Referenced by mouseMove().

mousePress()

void MenuItem::mousePress ( )

virtual

Reimplemented in Button, Container, InputBox, InputContainer, ListBox, Nexposee, Slider, XonoticColorpicker, XonoticColorpickerString, XonoticPicker, and XonoticScreenshotImage.

Definition at line 77 of file item.qc.

    {
        return false;  // unhandled
    }

References mousePress(), and vector.

Referenced by mousePress().

mouseRelease()

void MenuItem::mouseRelease ( )

virtual

Reimplemented in Button, Container, InputBox, InputContainer, ListBox, Nexposee, Slider, XonoticColorpicker, XonoticColorpickerString, XonoticCvarList, XonoticPicker, and XonoticWelcomeDialog.

Definition at line 87 of file item.qc.

    {
        return 0;  // unhandled
    }

References mouseRelease(), and vector.

Referenced by mouseRelease().

relinquishFocus()

void MenuItem::relinquishFocus ( )

virtual

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 MenuItem::resizeNotify ( )

virtual

Reimplemented in BorderImage, Button, Container, Image, InputBox, InputContainer, Label, ListBox, ModalController, Nexposee, Slider, XonoticCampaignList, XonoticCharmap, XonoticCreditsList, XonoticCvarList, XonoticDemoList, XonoticEntryList, XonoticGametypeList, XonoticGuideDescription, XonoticHUDSkinList, XonoticKeyBinder, XonoticLanguageList, XonoticListBox, XonoticMapList, XonoticPlayerList, XonoticPlayerModelSelector, XonoticPlayList, XonoticRegisteredSettingsList, XonoticScreenshotImage, XonoticScreenshotList, XonoticScrollPanel, XonoticServerList, XonoticSkinList, XonoticSoundList, XonoticStatsList, XonoticTextBox, XonoticTopicList, and XonoticWeaponsList.

Definition at line 18 of file item.qc.

    {
        this.origin = absOrigin;
        this.size = absSize;
    }

References origin, resizeNotify(), size, and vector.

Referenced by resizeNotify().

showNotify()

void MenuItem::showNotify ( )

virtual

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

virtual

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

Definition at line 26 of file item.qh.

Referenced by focusEnter().

focusable

bool MenuItem::focusable = false

Definition at line 25 of file item.qh.

focused

bool MenuItem::focused = false

Definition at line 24 of file item.qh.

origin

vector MenuItem::origin = '0 0 0'

Definition at line 29 of file item.qh.

Referenced by resizeNotify().

preferredFocusPriority

float MenuItem::preferredFocusPriority = 0

Definition at line 28 of file item.qh.

size

vector MenuItem::size = '0 0 0'

Definition at line 30 of file item.qh.

Referenced by resizeNotify().

---

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

• menu/item.qh
• menu/item.qc