Xonotic QuakeC
The free, fast arena FPS with crisp movement and a wide array of weapons
InputBox Class Reference
Inheritance diagram for InputBox:
Collaboration diagram for InputBox:

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)
virtual void configureInputBox ()
virtual void configureLabel ()
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 mouseDrag ()
virtual void mouseMove ()
virtual void mousePress ()
virtual void mouseRelease ()
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
string allowedCharacters = ""
bool allowFocusSound = true
bool allowWrap = false
float allowWrap_spacing = 0
float alpha = 0.7
vector cb_color = '1 1 1'
vector cb_colorC = '1 1 1'
vector cb_colorF = '1 1 1'
bool cb_focused = false
bool cb_pressed = false
float cb_width = 0
vector color = '1 1 1'
vector colorF = '1 1 1'
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 = 8
string forbiddenCharacters = ""
bool isBold = false
float keepspaceLeft = 0
float keepspaceRight = 0
float lastChangeTime = 0
float marginLeft = 0
float marginRight = 0
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
float scrollPos = 0
vector size = '0 0 0'

Detailed Description

Definition at line 4 of file inputbox.qh.

Member Function Documentation

◆ ATTRIB() [1/8]

InputBox::ATTRIB ( InputBox ,
applyButton ,
entity  )

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

◆ ATTRIB() [2/8]

InputBox::ATTRIB ( InputBox ,
clearButton ,
entity  )

References ATTRIB(), and entity().

◆ ATTRIB() [3/8]

InputBox::ATTRIB ( InputBox ,
src ,
string  )

References ATTRIB().

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

◆ ATTRIB() [4/8]

Label::ATTRIB ( Label ,
currentText ,
string  )
inherited

References ATTRIB().

◆ ATTRIB() [5/8]

Label::ATTRIB ( Label ,
text ,
string  )
inherited

References ATTRIB().

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

◆ ATTRIB() [6/8]

Label::ATTRIB ( Label ,
textEntity ,
entity  )
inherited

References ATTRIB(), and entity().

◆ ATTRIB() [7/8]

MenuItem::ATTRIB ( MenuItem ,
parent ,
entity  )
inherited

References entity(), and parent.

◆ ATTRIB() [8/8]

MenuItem::ATTRIB ( MenuItem ,
tooltip ,
string  )
inherited

◆ configureInputBox()

virtual void InputBox::configureInputBox ( )
virtual

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

Referenced by configureInputBox().

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

7 {
8 // free memory associated with this
9 }

References destroy().

Referenced by destroy().

◆ draw()

virtual void InputBox::draw ( )
virtual

Reimplemented from Label.

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

Referenced by draw().

◆ enterText()

virtual void InputBox::enterText ( )
virtual

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.

95 {
96 if (this.allowFocusSound) m_play_focus_sound();
97 }
MenuItem::allowFocusSound
bool allowFocusSound
Definition item.qh:26
m_play_focus_sound
void m_play_focus_sound()
Definition menu.qc:1097

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

Reimplemented from MenuItem.

Reimplemented in XonoticInputBox.

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.

68 {
69 return 0; // unhandled
70 }

References keyUp().

Referenced by keyUp().

◆ mouseDrag()

virtual void InputBox::mouseDrag ( )
virtual

Reimplemented from MenuItem.

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

Referenced by mouseDrag().

◆ mouseMove()

virtual void InputBox::mouseMove ( )
virtual

Reimplemented from MenuItem.

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

Referenced by mouseMove().

◆ mousePress()

void InputBox::mousePress ( )
virtual

Reimplemented from MenuItem.

Definition at line 76 of file inputbox.qc.

77 {
78 if (this.enableClearButton)
79 if (over_ClearButton(this, pos))
80 {
81 this.cb_pressed = true;
82 return true;
83 }
84 this.dragScrollTimer = time;
85 this.pressed = 1;
86 return InputBox_mouseDrag(this, pos);
87 }
InputBox::enableClearButton
bool enableClearButton
Definition inputbox.qh:37
InputBox::dragScrollTimer
float dragScrollTimer
Definition inputbox.qh:26
InputBox::pressed
bool pressed
Definition inputbox.qh:28
InputBox::cb_pressed
bool cb_pressed
Definition inputbox.qh:40
time
float time
Definition csprogsdefs.qc:16
InputBox_mouseDrag
float InputBox_mouseDrag(entity me, vector pos)
Definition inputbox.qc:54
over_ClearButton
float over_ClearButton(entity me, vector pos)
Definition inputbox.qc:29

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

Referenced by mousePress(), and mouseRelease().

◆ mouseRelease()

virtual void InputBox::mouseRelease ( )
virtual

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.

12 {
13 entity par = this.parent;
14 if (!par) return;
15 if (par.instanceOfContainer) par.setFocus(par, NULL);
16 }
parent
entity parent
Definition animhost.qc:7
entity
entity() spawn
NULL
#define NULL
Definition post.qh:14

References entity(), NULL, parent, and relinquishFocus().

Referenced by relinquishFocus().

◆ resizeNotify()

virtual void InputBox::resizeNotify ( )
virtual

Reimplemented from Label.

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

Referenced by resizeNotify().

◆ setText()

virtual void InputBox::setText ( )
virtual

Reimplemented from Label.

Reimplemented in XonoticInputBox.

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

Referenced by setText().

◆ showNotify()

virtual void InputBox::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.

◆ allowedCharacters

string InputBox::allowedCharacters = ""

Definition at line 31 of file inputbox.qh.

◆ allowFocusSound

bool InputBox::allowFocusSound = true

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 Label::alpha = 0.7
inherited

Definition at line 24 of file label.qh.

◆ cb_color

vector InputBox::cb_color = '1 1 1'

Definition at line 42 of file inputbox.qh.

◆ cb_colorC

vector InputBox::cb_colorC = '1 1 1'

Definition at line 44 of file inputbox.qh.

◆ cb_colorF

vector InputBox::cb_colorF = '1 1 1'

Definition at line 43 of file inputbox.qh.

◆ cb_focused

bool InputBox::cb_focused = false

Definition at line 41 of file inputbox.qh.

◆ cb_pressed

bool InputBox::cb_pressed = false

Definition at line 40 of file inputbox.qh.

Referenced by mousePress().

◆ cb_width

float InputBox::cb_width = 0

Definition at line 39 of file inputbox.qh.

◆ color

vector InputBox::color = '1 1 1'

Definition at line 32 of file inputbox.qh.

◆ colorF

vector InputBox::colorF = '1 1 1'

Definition at line 33 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

Definition at line 19 of file inputbox.qh.

◆ disabled

float InputBox::disabled = 0

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'

Definition at line 27 of file inputbox.qh.

◆ dragScrollTimer

float InputBox::dragScrollTimer = 0

Definition at line 26 of file inputbox.qh.

Referenced by mousePress().

◆ editColorCodes

bool InputBox::editColorCodes = true

Definition at line 29 of file inputbox.qh.

◆ enableClearButton

bool InputBox::enableClearButton = true

Definition at line 37 of file inputbox.qh.

Referenced by mousePress().

◆ focusable

bool InputBox::focusable = true

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

◆ forbiddenCharacters

string InputBox::forbiddenCharacters = ""

Definition at line 30 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

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

◆ maxLength

float InputBox::maxLength = 255

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

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.

◆ scrollPos

float InputBox::scrollPos = 0

Definition at line 20 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 files: