Inheritance diagram for Button:

Collaboration diagram for Button:

Public Member Functions
	ATTRIB (Button, applyButton, entity)
	ATTRIB (Button, onClick, void(entity, entity))
	ATTRIB (Button, onClickEntity, entity)
	ATTRIB (Button, src, string)
	ATTRIB (Button, src2, string)
	ATTRIB (Button, srcSuffix, string)
	ATTRIB (Label, currentText, string)
	ATTRIB (Label, text, string)
	ATTRIB (Label, textEntity, entity)
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
virtual void	configureButton ()
virtual void	configureLabel ()
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	playClickSound ()
virtual void	recalcPositionWithText ()
virtual void	relinquishFocus ()
virtual void	resizeNotify ()
virtual void	setText ()
virtual void	showNotify ()
virtual void	toString ()

Public Attributes
float	align = 0.5
bool	allowColors = false
bool	allowCut = false
bool	allowFocusSound = true
bool	allowWrap = false
float	allowWrap_spacing = 0
float	alpha = 0.7
float	alpha2 = 1
float	clickTime = 0
vector	color = '1 1 1'
vector	color2 = '1 1 1'
vector	colorC = '1 1 1'
vector	colorD = '1 1 1'
vector	colorF = '1 1 1'
vector	colorL = SKINCOLOR_TEXT
float	condenseFactor = 1
float	disabled = 0
float	disabledAlpha = 0.3
bool	disableOnClick = false
bool	focusable = true
bool	focused = false
float	fontSize = 8
bool	forcePressed = false
bool	isBold = false
float	keepspaceLeft = 0
float	keepspaceRight = 0
float	marginLeft = 0
float	marginRight = 0
vector	origin = '0 0 0'
bool	overrideCondenseFactor = false
vector	overrideRealOrigin = '0 0 0'
float	preferredFocusPriority = 0
float	pressed = 0
bool	pulse = false
vector	realFontSize = '0 0 0'
vector	realOrigin = '0 0 0'
bool	recalcPos = false
vector	size = '0 0 0'
float	src2scale = 1
float	srcMulti = 1

Detailed Description

Definition at line 6 of file button.qh.

Member Function Documentation

◆ ATTRIB() [1/11]

Button::ATTRIB	(	Button	,
		applyButton	,
		entity	)

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

◆ ATTRIB() [2/11]

Button::ATTRIB	(	Button	,
		onClick	,
		void(entity, entity)	)

References ATTRIB(), and entity().

Referenced by ATTRIB(), ATTRIB(), ATTRIB(), ATTRIB(), ATTRIB(), ATTRIB(), CheckBox::void(), and RadioButton::void().

◆ ATTRIB() [3/11]

Button::ATTRIB	(	Button	,
		onClickEntity	,
		entity	)

References ATTRIB(), and entity().

◆ ATTRIB() [4/11]

Button::ATTRIB	(	Button	,
		src	,
		string	)

References ATTRIB().

◆ ATTRIB() [5/11]

Button::ATTRIB	(	Button	,
		src2	,
		string	)

References ATTRIB().

◆ ATTRIB() [6/11]

Button::ATTRIB	(	Button	,
		srcSuffix	,
		string	)

References ATTRIB().

◆ ATTRIB() [7/11]

Label::ATTRIB	(	Label	,
		currentText	,
		string	)

inherited

References ATTRIB().

◆ ATTRIB() [8/11]

Label::ATTRIB	(	Label	,
		text	,
		string	)

inherited

References ATTRIB().

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

◆ ATTRIB() [9/11]

Label::ATTRIB	(	Label	,
		textEntity	,
		entity	)

inherited

References ATTRIB(), and entity().

◆ ATTRIB() [10/11]

MenuItem::ATTRIB	(	MenuItem	,
		parent	,
		entity	)

inherited

References entity(), and parent.

◆ ATTRIB() [11/11]

MenuItem::ATTRIB	(	MenuItem	,
		tooltip	,
		string	)

inherited

◆ configureButton()

virtual void Button::configureButton ( )

virtual

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

Referenced by configureButton().

◆ configureLabel()

virtual void Label::configureLabel ( )

virtualinherited

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

Referenced by configureLabel().

◆ 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 Button::draw ( )

virtual

Reimplemented from Label.

Reimplemented in CheckBox, XonoticColorButton, XonoticLeaveMatchButton, XonoticRadioButton, and XonoticSliderCheckBox.

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

Referenced by draw().

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

void MenuItem::focusLeave ( )

virtualinherited

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

Definition at line 99 of file item.qc.

100 {}

References focusLeave().

Referenced by focusLeave().

◆ hideNotify()

void MenuItem::hideNotify ( )

virtualinherited

Reimplemented in Container, and XonoticCvarList.

Definition at line 59 of file item.qc.

60 {}

References hideNotify().

Referenced by hideNotify().

◆ keyDown()

virtual void Button::keyDown ( )

virtual

Reimplemented from MenuItem.

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

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 Button::mouseDrag ( )

virtual

Reimplemented from MenuItem.

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

Referenced by mouseDrag(), and mousePress().

◆ mouseMove()

void MenuItem::mouseMove ( )

virtualinherited

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 Button::mousePress ( )

virtual

Reimplemented from MenuItem.

Definition at line 39 of file button.qc.

    {
        this.mouseDrag(this, pos);  // verify coordinates
        return true;
    }

References mouseDrag(), mousePress(), and vector.

Referenced by keyDown(), and mousePress().

◆ mouseRelease()

virtual void Button::mouseRelease ( )

virtual

Reimplemented from MenuItem.

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

Referenced by mouseRelease().

◆ playClickSound()

virtual void Button::playClickSound ( )

virtual

Reimplemented in CheckBox.

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

Referenced by playClickSound().

◆ recalcPositionWithText()

virtual void Label::recalcPositionWithText ( )

virtualinherited

Reimplemented in BorderImage.

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

Referenced by recalcPositionWithText().

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

virtual

Reimplemented from Label.

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

Referenced by resizeNotify().

◆ setText()

virtual void Label::setText ( )

virtualinherited

Reimplemented in InputBox, and XonoticInputBox.

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

Referenced by setText().

◆ showNotify()

virtual void Button::showNotify ( )

virtual

Reimplemented from MenuItem.

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

Referenced by showNotify().

◆ toString()

virtual void Label::toString ( )

virtualinherited

Reimplemented from MenuItem.

Reimplemented in CheckBox, and Slider.

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

Referenced by toString().

Member Data Documentation

◆ align

float Label::align = 0.5

inherited

Definition at line 15 of file label.qh.

◆ allowColors

bool Label::allowColors = false

inherited

Definition at line 17 of file label.qh.

◆ allowCut

bool Label::allowCut = false

inherited

Definition at line 16 of file label.qh.

◆ allowFocusSound

bool Button::allowFocusSound = true

Definition at line 24 of file button.qh.

◆ allowWrap

bool Label::allowWrap = false

inherited

Definition at line 32 of file label.qh.

◆ allowWrap_spacing

float Label::allowWrap_spacing = 0

inherited

Definition at line 33 of file label.qh.

◆ alpha

float Label::alpha = 0.7

inherited

Definition at line 24 of file label.qh.

◆ alpha2

float Button::alpha2 = 1

Definition at line 38 of file button.qh.

◆ clickTime

float Button::clickTime = 0

Definition at line 26 of file button.qh.

◆ color

vector Button::color = '1 1 1'

Definition at line 33 of file button.qh.

◆ color2

vector Button::color2 = '1 1 1'

Definition at line 37 of file button.qh.

◆ colorC

vector Button::colorC = '1 1 1'

Definition at line 34 of file button.qh.

◆ colorD

vector Button::colorD = '1 1 1'

Definition at line 36 of file button.qh.

◆ colorF

vector Button::colorF = '1 1 1'

Definition at line 35 of file button.qh.

◆ colorL

vector Label::colorL = SKINCOLOR_TEXT

inherited

Definition at line 25 of file label.qh.

◆ condenseFactor

float Label::condenseFactor = 1

inherited

Definition at line 35 of file label.qh.

◆ disabled

float Button::disabled = 0

Definition at line 29 of file button.qh.

◆ disabledAlpha

float Button::disabledAlpha = 0.3

Definition at line 30 of file button.qh.

◆ disableOnClick

bool Button::disableOnClick = false

Definition at line 28 of file button.qh.

◆ focusable

bool Button::focusable = true

Definition at line 23 of file button.qh.

◆ focused

bool MenuItem::focused = false

inherited

Definition at line 24 of file item.qh.

◆ fontSize

float Label::fontSize = 8

inherited

Definition at line 14 of file label.qh.

◆ forcePressed

bool Button::forcePressed = false

Definition at line 31 of file button.qh.

◆ isBold

bool Label::isBold = false

inherited

Definition at line 11 of file label.qh.

◆ keepspaceLeft

float Label::keepspaceLeft = 0

inherited

Definition at line 18 of file label.qh.

◆ keepspaceRight

float Label::keepspaceRight = 0

inherited

Definition at line 19 of file label.qh.

◆ marginLeft

float Label::marginLeft = 0

inherited

Definition at line 20 of file label.qh.

◆ marginRight

float Label::marginRight = 0

inherited

Definition at line 21 of file label.qh.

◆ origin

vector Button::origin = '0 0 0'

Definition at line 40 of file button.qh.

◆ overrideCondenseFactor

bool Label::overrideCondenseFactor = false

inherited

Definition at line 37 of file label.qh.

◆ overrideRealOrigin

vector Label::overrideRealOrigin = '0 0 0'

inherited

Definition at line 36 of file label.qh.

◆ preferredFocusPriority

float MenuItem::preferredFocusPriority = 0

inherited

Definition at line 28 of file item.qh.

◆ pressed

float Button::pressed = 0

Definition at line 25 of file button.qh.

◆ pulse

bool Button::pulse = false

Definition at line 32 of file button.qh.

◆ realFontSize

vector Label::realFontSize = '0 0 0'

inherited

Definition at line 22 of file label.qh.

◆ realOrigin

vector Label::realOrigin = '0 0 0'

inherited

Definition at line 23 of file label.qh.

◆ recalcPos

bool Label::recalcPos = false

inherited

Definition at line 34 of file label.qh.

◆ size

vector Button::size = '0 0 0'

Definition at line 41 of file button.qh.

◆ src2scale

float Button::src2scale = 1

Definition at line 21 of file button.qh.

◆ srcMulti

float Button::srcMulti = 1

Definition at line 22 of file button.qh.

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

menu/item/button.qh
menu/item/button.qc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ATTRIB() [1/11]

◆ ATTRIB() [2/11]

◆ ATTRIB() [3/11]

◆ ATTRIB() [4/11]

◆ ATTRIB() [5/11]

◆ ATTRIB() [6/11]

◆ ATTRIB() [7/11]

◆ ATTRIB() [8/11]

◆ ATTRIB() [9/11]

◆ ATTRIB() [10/11]

◆ ATTRIB() [11/11]

◆ configureButton()

◆ configureLabel()

◆ destroy()

◆ draw()

◆ focusEnter()

◆ focusLeave()

◆ hideNotify()

◆ keyDown()

◆ keyUp()

◆ mouseDrag()

◆ mouseMove()

◆ mousePress()

◆ mouseRelease()

◆ playClickSound()

◆ recalcPositionWithText()

◆ relinquishFocus()

◆ resizeNotify()

◆ setText()

◆ showNotify()

◆ toString()

Member Data Documentation

◆ align

◆ allowColors

◆ allowCut

◆ allowFocusSound

◆ allowWrap

◆ allowWrap_spacing

◆ alpha

◆ alpha2

◆ clickTime

◆ color

◆ color2

◆ colorC

◆ colorD

◆ colorF

◆ colorL

◆ condenseFactor

◆ disabled

◆ disabledAlpha

◆ disableOnClick

◆ focusable

◆ focused

◆ fontSize

◆ forcePressed

◆ isBold

◆ keepspaceLeft

◆ keepspaceRight

◆ marginLeft

◆ marginRight

◆ origin

◆ overrideCondenseFactor

◆ overrideRealOrigin

◆ preferredFocusPriority

◆ pressed

◆ pulse

◆ realFontSize

◆ realOrigin

◆ recalcPos

◆ size

◆ src2scale

◆ srcMulti