Inheritance diagram for XonoticInputBox:

Collaboration diagram for XonoticInputBox:

Public Member Functions
	ATTRIB (InputBox, applyButton, entity)
	ATTRIB (InputBox, clearButton, entity)
	ATTRIB (InputBox, src, string)
	ATTRIB (Label, currentText, string)
	ATTRIB (Label, text, string)
	ATTRIB (Label, textEntity, entity)
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
	ATTRIB (XonoticInputBox, controlledCvar, string)
	ATTRIB (XonoticInputBox, onChange, void(entity, entity))
	ATTRIB (XonoticInputBox, onChangeEntity, entity)
	ATTRIB (XonoticInputBox, onEnter, void(entity, entity))
	ATTRIB (XonoticInputBox, onEnterEntity, entity)
virtual void	configureInputBox ()
virtual void	configureLabel ()
virtual void	configureXonoticInputBox ()
virtual void	destroy ()
virtual void	draw ()
virtual void	enterText ()
virtual void	focusEnter ()
virtual void	focusLeave ()
virtual void	hideNotify ()
virtual void	keyDown ()
virtual void	keyUp ()
virtual void	loadCvars ()
virtual void	mouseDrag ()
virtual void	mouseMove ()
virtual void	mousePress ()
virtual void	mouseRelease ()
virtual void	recalcPositionWithText ()
virtual void	relinquishFocus ()
virtual void	resizeNotify ()
virtual void	saveCvars ()
virtual void	setText ()
virtual void	showNotify ()
virtual void	toString ()

Public Attributes
float	align = 0.5
bool	allowColors = false
bool	allowCut = false
string	allowedCharacters = ""
bool	allowFocusSound = true
bool	allowWrap = false
float	allowWrap_spacing = 0
float	alpha = SKINALPHA_TEXT
vector	cb_color = SKINCOLOR_CLEARBUTTON_N
vector	cb_colorC = SKINCOLOR_CLEARBUTTON_C
vector	cb_colorF = SKINCOLOR_CLEARBUTTON_F
bool	cb_focused = false
float	cb_offset = SKINOFFSET_CLEARBUTTON
bool	cb_pressed = false
string	cb_src = SKINGFX_CLEARBUTTON
float	cb_width = 0
vector	color = SKINCOLOR_INPUTBOX_N
vector	colorF = SKINCOLOR_INPUTBOX_F
vector	colorL = SKINCOLOR_TEXT
float	condenseFactor = 1
float	cursorPos = 0
float	disabled = 0
float	disabledAlpha = 0.3
vector	dragScrollPos = '0 0 0'
float	dragScrollTimer = 0
bool	editColorCodes = true
bool	enableClearButton = true
bool	focusable = true
bool	focused = false
float	fontSize = SKINFONTSIZE_NORMAL
string	forbiddenCharacters = ""
string	image = SKINGFX_INPUTBOX
bool	isBold = false
float	keepspaceLeft = 0
float	keepspaceRight = 0
float	lastChangeTime = 0
float	marginLeft = SKINMARGIN_INPUTBOX_CHARS
float	marginRight = SKINMARGIN_INPUTBOX_CHARS
float	maxLength = 255
vector	origin = '0 0 0'
bool	overrideCondenseFactor = false
vector	overrideRealOrigin = '0 0 0'
float	preferredFocusPriority = 0
bool	pressed = false
vector	realFontSize = '0 0 0'
vector	realOrigin = '0 0 0'
bool	recalcPos = false
bool	saveImmediately = false
float	scrollPos = 0
float	sendCvars = 0
vector	size = '0 0 0'

Detailed Description

Definition at line 4 of file inputbox.qh.

Member Function Documentation

◆ ATTRIB() [1/13]

InputBox::ATTRIB	(	InputBox	,
		applyButton	,
		entity	)

inherited

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

◆ ATTRIB() [2/13]

InputBox::ATTRIB	(	InputBox	,
		clearButton	,
		entity	)

inherited

References ATTRIB(), and entity().

◆ ATTRIB() [3/13]

InputBox::ATTRIB	(	InputBox	,
		src	,
		string	)

inherited

References ATTRIB().

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

◆ ATTRIB() [4/13]

Label::ATTRIB	(	Label	,
		currentText	,
		string	)

inherited

References ATTRIB().

◆ ATTRIB() [5/13]

Label::ATTRIB	(	Label	,
		text	,
		string	)

inherited

References ATTRIB().

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

◆ ATTRIB() [6/13]

Label::ATTRIB	(	Label	,
		textEntity	,
		entity	)

inherited

References ATTRIB(), and entity().

◆ ATTRIB() [7/13]

MenuItem::ATTRIB	(	MenuItem	,
		parent	,
		entity	)

inherited

References entity(), and parent.

◆ ATTRIB() [8/13]

MenuItem::ATTRIB	(	MenuItem	,
		tooltip	,
		string	)

inherited

◆ ATTRIB() [9/13]

XonoticInputBox::ATTRIB	(	XonoticInputBox	,
		controlledCvar	,
		string	)

References ATTRIB(), and controlledCvar.

◆ ATTRIB() [10/13]

XonoticInputBox::ATTRIB	(	XonoticInputBox	,
		onChange	,
		void(entity, entity)	)

References ATTRIB(), and entity().

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

◆ ATTRIB() [11/13]

XonoticInputBox::ATTRIB	(	XonoticInputBox	,
		onChangeEntity	,
		entity	)

References ATTRIB(), and entity().

◆ ATTRIB() [12/13]

XonoticInputBox::ATTRIB	(	XonoticInputBox	,
		onEnter	,
		void(entity, entity)	)

References ATTRIB(), and entity().

◆ ATTRIB() [13/13]

XonoticInputBox::ATTRIB	(	XonoticInputBox	,
		onEnterEntity	,
		entity	)

References ATTRIB(), and entity().

◆ configureInputBox()

virtual void InputBox::configureInputBox ( )

virtualinherited

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

Referenced by configureInputBox().

◆ configureLabel()

virtual void Label::configureLabel ( )

virtualinherited

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

Referenced by configureLabel().

◆ configureXonoticInputBox()

virtual void XonoticInputBox::configureXonoticInputBox ( )

virtual

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

Referenced by configureXonoticInputBox().

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

virtualinherited

Reimplemented from Label.

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

Referenced by draw().

◆ enterText()

virtual void InputBox::enterText ( )

virtualinherited

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

Referenced by enterText().

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

virtual

Reimplemented from MenuItem.

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

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 XonoticInputBox::keyDown ( )

virtual

Reimplemented from InputBox.

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

◆ loadCvars()

virtual void XonoticInputBox::loadCvars ( )

virtual

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

Referenced by loadCvars().

◆ mouseDrag()

virtual void InputBox::mouseDrag ( )

virtualinherited

Reimplemented from MenuItem.

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

Referenced by mouseDrag().

◆ mouseMove()

virtual void InputBox::mouseMove ( )

virtualinherited

Reimplemented from MenuItem.

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

Referenced by mouseMove().

◆ mousePress()

void InputBox::mousePress ( )

virtualinherited

Reimplemented from MenuItem.

Definition at line 76 of file inputbox.qc.

    {
        if (this.enableClearButton)
            if (over_ClearButton(this, pos))
            {
                this.cb_pressed = true;
                return true;
            }
        this.dragScrollTimer = time;
        this.pressed = 1;
        return InputBox_mouseDrag(this, pos);
    }

References cb_pressed, dragScrollTimer, enableClearButton, InputBox_mouseDrag(), mousePress(), over_ClearButton(), pressed, time, and vector.

Referenced by mousePress(), and mouseRelease().

◆ mouseRelease()

virtual void InputBox::mouseRelease ( )

virtualinherited

Reimplemented from MenuItem.

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

Referenced by mouseRelease().

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

virtualinherited

Reimplemented from Label.

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

Referenced by resizeNotify().

◆ saveCvars()

virtual void XonoticInputBox::saveCvars ( )

virtual

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

Referenced by saveCvars().

◆ setText()

virtual void XonoticInputBox::setText ( )

virtual

Reimplemented from InputBox.

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

Referenced by setText().

◆ showNotify()

virtual void InputBox::showNotify ( )

virtualinherited

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.

◆ allowedCharacters

string InputBox::allowedCharacters = ""

inherited

Definition at line 31 of file inputbox.qh.

◆ allowFocusSound

bool InputBox::allowFocusSound = true

inherited

Definition at line 23 of file inputbox.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 XonoticInputBox::alpha = SKINALPHA_TEXT

Definition at line 20 of file inputbox.qh.

◆ cb_color

vector XonoticInputBox::cb_color = SKINCOLOR_CLEARBUTTON_N

Definition at line 25 of file inputbox.qh.

◆ cb_colorC

vector XonoticInputBox::cb_colorC = SKINCOLOR_CLEARBUTTON_C

Definition at line 27 of file inputbox.qh.

◆ cb_colorF

vector XonoticInputBox::cb_colorF = SKINCOLOR_CLEARBUTTON_F

Definition at line 26 of file inputbox.qh.

◆ cb_focused

bool InputBox::cb_focused = false

inherited

Definition at line 41 of file inputbox.qh.

◆ cb_offset

float XonoticInputBox::cb_offset = SKINOFFSET_CLEARBUTTON

Definition at line 23 of file inputbox.qh.

◆ cb_pressed

bool InputBox::cb_pressed = false

inherited

Definition at line 40 of file inputbox.qh.

Referenced by mousePress().

◆ cb_src

string XonoticInputBox::cb_src = SKINGFX_CLEARBUTTON

Definition at line 24 of file inputbox.qh.

◆ cb_width

float InputBox::cb_width = 0

inherited

Definition at line 39 of file inputbox.qh.

◆ color

vector XonoticInputBox::color = SKINCOLOR_INPUTBOX_N

Definition at line 17 of file inputbox.qh.

◆ colorF

vector XonoticInputBox::colorF = SKINCOLOR_INPUTBOX_F

Definition at line 18 of file inputbox.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.

◆ cursorPos

float InputBox::cursorPos = 0

inherited

Definition at line 19 of file inputbox.qh.

◆ disabled

float InputBox::disabled = 0

inherited

Definition at line 24 of file inputbox.qh.

◆ disabledAlpha

float Label::disabledAlpha = 0.3

inherited

Definition at line 27 of file label.qh.

◆ dragScrollPos

vector InputBox::dragScrollPos = '0 0 0'

inherited

Definition at line 27 of file inputbox.qh.

◆ dragScrollTimer

float InputBox::dragScrollTimer = 0

inherited

Definition at line 26 of file inputbox.qh.

Referenced by mousePress().

◆ editColorCodes

bool InputBox::editColorCodes = true

inherited

Definition at line 29 of file inputbox.qh.

◆ enableClearButton

bool InputBox::enableClearButton = true

inherited

Definition at line 37 of file inputbox.qh.

Referenced by mousePress().

◆ focusable

bool InputBox::focusable = true

inherited

Definition at line 22 of file inputbox.qh.

◆ focused

bool MenuItem::focused = false

inherited

Definition at line 24 of file item.qh.

◆ fontSize

float XonoticInputBox::fontSize = SKINFONTSIZE_NORMAL

Definition at line 9 of file inputbox.qh.

◆ forbiddenCharacters

string InputBox::forbiddenCharacters = ""

inherited

Definition at line 30 of file inputbox.qh.

◆ image

string XonoticInputBox::image = SKINGFX_INPUTBOX

Definition at line 10 of file inputbox.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.

◆ lastChangeTime

float InputBox::lastChangeTime = 0

inherited

Definition at line 25 of file inputbox.qh.

◆ marginLeft

float XonoticInputBox::marginLeft = SKINMARGIN_INPUTBOX_CHARS

Definition at line 15 of file inputbox.qh.

◆ marginRight

float XonoticInputBox::marginRight = SKINMARGIN_INPUTBOX_CHARS

Definition at line 16 of file inputbox.qh.

◆ maxLength

float InputBox::maxLength = 255

inherited

Definition at line 34 of file inputbox.qh.

◆ origin

vector MenuItem::origin = '0 0 0'

inherited

Definition at line 29 of file item.qh.

Referenced by resizeNotify().

◆ 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

bool InputBox::pressed = false

inherited

Definition at line 28 of file inputbox.qh.

Referenced by mousePress().

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

◆ saveImmediately

bool XonoticInputBox::saveImmediately = false

Definition at line 34 of file inputbox.qh.

◆ scrollPos

float InputBox::scrollPos = 0

inherited

Definition at line 20 of file inputbox.qh.

◆ sendCvars

float XonoticInputBox::sendCvars = 0

Definition at line 32 of file inputbox.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 file:

menu/xonotic/inputbox.qh

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ATTRIB() [1/13]

◆ ATTRIB() [2/13]

◆ ATTRIB() [3/13]

◆ ATTRIB() [4/13]

◆ ATTRIB() [5/13]

◆ ATTRIB() [6/13]

◆ ATTRIB() [7/13]

◆ ATTRIB() [8/13]

◆ ATTRIB() [9/13]

◆ ATTRIB() [10/13]

◆ ATTRIB() [11/13]

◆ ATTRIB() [12/13]

◆ ATTRIB() [13/13]

◆ configureInputBox()

◆ configureLabel()

◆ configureXonoticInputBox()

◆ destroy()

◆ draw()

◆ enterText()

◆ focusEnter()

◆ focusLeave()

◆ hideNotify()

◆ keyDown()

◆ keyUp()

◆ loadCvars()

◆ mouseDrag()

◆ mouseMove()

◆ mousePress()

◆ mouseRelease()

◆ recalcPositionWithText()

◆ relinquishFocus()

◆ resizeNotify()

◆ saveCvars()

◆ setText()

◆ showNotify()

◆ toString()

Member Data Documentation

◆ align

◆ allowColors

◆ allowCut

◆ allowedCharacters

◆ allowFocusSound

◆ allowWrap

◆ allowWrap_spacing

◆ alpha

◆ cb_color

◆ cb_colorC

◆ cb_colorF

◆ cb_focused

◆ cb_offset

◆ cb_pressed

◆ cb_src

◆ cb_width

◆ color

◆ colorF

◆ colorL

◆ condenseFactor

◆ cursorPos

◆ disabled

◆ disabledAlpha

◆ dragScrollPos

◆ dragScrollTimer

◆ editColorCodes

◆ enableClearButton

◆ focusable

◆ focused

◆ fontSize

◆ forbiddenCharacters

◆ image

◆ isBold

◆ keepspaceLeft

◆ keepspaceRight

◆ lastChangeTime

◆ marginLeft

◆ marginRight

◆ maxLength