Inheritance diagram for Slider:

Collaboration diagram for Slider:

Public Member Functions
	ATTRIB (Label, currentText, string)
	ATTRIB (Label, text, string)
	ATTRIB (Label, textEntity, entity)
	ATTRIB (MenuItem, parent, entity)
	ATTRIB (MenuItem, tooltip, string)
	ATTRIB (Slider, sliderAnim, entity)
	ATTRIB (Slider, src, string)
virtual void	configureLabel ()
virtual void	configureSliderValues ()
virtual void	configureSliderVisuals ()
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	recalcPositionWithText ()
virtual void	relinquishFocus ()
virtual void	resizeNotify ()
virtual void	setSliderValue ()
virtual void	setText ()
virtual void	setValue ()
virtual void	showNotify ()
virtual void	toString ()
virtual void	valueToText ()

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
bool	animated = true
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	controlWidth = 0
float	disabled = 0
float	disabledAlpha = 0.3
bool	focusable = true
bool	focused = false
float	fontSize = 8
string	formatString = ""
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
float	pressOffset = 0
float	previousValue = 0
vector	realFontSize = '0 0 0'
vector	realOrigin = '0 0 0'
bool	recalcPos = false
vector	size = '0 0 0'
float	sliderValue = 0
vector	tolerance = '0 0 0'
float	value = 0
float	valueDigits = 0
float	valueDisplayMultiplier = 1.0
float	valueKeyStep = 0
float	valueMax = 0
float	valueMin = 0
float	valuePageStep = 0
float	valueSpace = 0
float	valueStep = 0

Detailed Description

Definition at line 7 of file slider.qh.

Member Function Documentation

◆ ATTRIB() [1/7]

Label::ATTRIB	(	Label	,
		currentText	,
		string	)

inherited

References ATTRIB().

◆ ATTRIB() [2/7]

Label::ATTRIB	(	Label	,
		text	,
		string	)

inherited

References ATTRIB().

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

◆ ATTRIB() [3/7]

Label::ATTRIB	(	Label	,
		textEntity	,
		entity	)

inherited

References ATTRIB(), and entity().

◆ ATTRIB() [4/7]

MenuItem::ATTRIB	(	MenuItem	,
		parent	,
		entity	)

inherited

References entity(), and parent.

◆ ATTRIB() [5/7]

MenuItem::ATTRIB	(	MenuItem	,
		tooltip	,
		string	)

inherited

◆ ATTRIB() [6/7]

Slider::ATTRIB	(	Slider	,
		sliderAnim	,
		entity	)

References ATTRIB(), and entity().

◆ ATTRIB() [7/7]

Slider::ATTRIB	(	Slider	,
		src	,
		string	)

References ATTRIB().

Referenced by ATTRIB(), and ATTRIB().

◆ configureLabel()

virtual void Label::configureLabel ( )

virtualinherited

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

Referenced by configureLabel().

◆ configureSliderValues()

virtual void Slider::configureSliderValues ( )

virtual

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

Referenced by configureSliderValues().

◆ configureSliderVisuals()

virtual void Slider::configureSliderVisuals ( )

virtual

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

Referenced by configureSliderVisuals().

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

virtual

Reimplemented from Label.

Reimplemented in XonoticPicmipSlider, and XonoticResolutionSlider.

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

virtual

Reimplemented from MenuItem.

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

Referenced by keyDown().

◆ keyUp()

virtual void Slider::keyUp ( )

virtual

Reimplemented from MenuItem.

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

Referenced by keyUp().

◆ mouseDrag()

virtual void Slider::mouseDrag ( )

virtual

Reimplemented from MenuItem.

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

Referenced by mouseDrag().

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

virtual

Reimplemented from MenuItem.

Definition at line 195 of file slider.qc.

    {
        float controlCenter;
        if (this.disabled) return false;
        if (pos.x < 0) return false;
        if (pos.y < 0) return false;
        if (pos.x >= 1 - this.valueSpace) return false;
        if (pos.y >= 1) return false;
        controlCenter = (this.value - this.valueMin) / (this.valueMax - this.valueMin) * (1 - this.valueSpace - this.controlWidth) + 0.5 * this.controlWidth;
        if (fabs(pos.x - controlCenter) <= 0.5 * this.controlWidth)
        {
            this.pressed = 1;
            this.pressOffset = pos.x - controlCenter;
            this.previousValue = this.value;
            // this.mouseDrag(this, pos);
        }
        else
        {
            float clickValue, pageValue, inRange;
            clickValue = median(0, (pos.x - this.pressOffset - 0.5 * this.controlWidth) / (1 - this.valueSpace - this.controlWidth), 1) * (this.valueMax - this.valueMin) + this.valueMin;
            inRange = (almost_in_bounds(this.valueMin, this.value, this.valueMax));
            if (pos.x < controlCenter)
            {
                pageValue = this.value - this.valuePageStep;
                if (this.valueStep) clickValue = floor(clickValue / this.valueStep) * this.valueStep;
                pageValue = max(pageValue, clickValue);
            }
            else
            {
                pageValue = this.value + this.valuePageStep;
                if (this.valueStep) clickValue = ceil(clickValue / this.valueStep) * this.valueStep;
                pageValue = min(pageValue, clickValue);
            }
            if (inRange) this.setValue(this, median(this.valueMin, pageValue, this.valueMax), autocvar_menu_animations > 0);
            else this.setValue(this, this.valueMax, autocvar_menu_animations > 0);
            if(this.applyButton)
                this.applyButton.disabled = false;
            if (pageValue == clickValue)
            {
                controlCenter = (this.value - this.valueMin) / (this.valueMax - this.valueMin) * (1 - this.valueSpace - this.controlWidth) + 0.5 * this.controlWidth;
                this.pressed = 1;
                this.pressOffset = pos.x - controlCenter;
                this.previousValue = this.value;
                // this.mouseDrag(this, pos);
            }
        }
        return true;
    }

References almost_in_bounds(), applyButton, autocvar_menu_animations, ceil(), controlWidth, disabled, fabs(), floor(), max(), median(), min(), mousePress(), pressed, pressOffset, previousValue, setValue(), value, valueMax, valueMin, valuePageStep, valueSpace, valueStep, and vector.

Referenced by keyUp(), and mousePress().

◆ mouseRelease()

virtual void Slider::mouseRelease ( )

virtual

Reimplemented from MenuItem.

References entity(), METHOD, mouseRelease(), 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 Slider::resizeNotify ( )

virtual

Reimplemented from Label.

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

Referenced by resizeNotify().

◆ setSliderValue()

virtual void Slider::setSliderValue ( )

virtual

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

Referenced by setSliderValue().

◆ setText()

virtual void Label::setText ( )

virtualinherited

Reimplemented in InputBox, and XonoticInputBox.

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

Referenced by setText().

◆ setValue()

virtual void Slider::setValue ( )

virtual

Reimplemented in XonoticMixedSlider, XonoticSlider, and XonoticTextSlider.

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

Referenced by mousePress(), and setValue().

◆ showNotify()

virtual void Slider::showNotify ( )

virtual

Reimplemented from MenuItem.

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

Referenced by showNotify().

◆ toString()

virtual void Slider::toString ( )

virtual

Reimplemented from Label.

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

Referenced by toString().

◆ valueToText()

virtual void Slider::valueToText ( )

virtual

Reimplemented in MixedSlider, TextSlider, and XonoticDecibelsSlider.

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

Referenced by valueToText().

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 Slider::allowFocusSound = true

Definition at line 24 of file slider.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.

◆ animated

bool Slider::animated = true

Definition at line 26 of file slider.qh.

◆ color

vector Slider::color = '1 1 1'

Definition at line 44 of file slider.qh.

◆ color2

vector Slider::color2 = '1 1 1'

Definition at line 45 of file slider.qh.

◆ colorC

vector Slider::colorC = '1 1 1'

Definition at line 47 of file slider.qh.

◆ colorD

vector Slider::colorD = '1 1 1'

Definition at line 46 of file slider.qh.

◆ colorF

vector Slider::colorF = '1 1 1'

Definition at line 48 of file slider.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.

◆ controlWidth

float Slider::controlWidth = 0

Definition at line 38 of file slider.qh.

Referenced by mousePress().

◆ disabled

float Slider::disabled = 0

Definition at line 43 of file slider.qh.

Referenced by mousePress().

◆ disabledAlpha

float Slider::disabledAlpha = 0.3

Definition at line 49 of file slider.qh.

◆ focusable

bool Slider::focusable = true

Definition at line 23 of file slider.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.

◆ formatString

string Slider::formatString = ""

Definition at line 36 of file slider.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 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

float Slider::pressed = 0

Definition at line 39 of file slider.qh.

Referenced by mousePress().

◆ pressOffset

float Slider::pressOffset = 0

Definition at line 40 of file slider.qh.

Referenced by mousePress().

◆ previousValue

float Slider::previousValue = 0

Definition at line 41 of file slider.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.

◆ size

vector MenuItem::size = '0 0 0'

inherited

Definition at line 30 of file item.qh.

Referenced by resizeNotify().

◆ sliderValue

float Slider::sliderValue = 0

Definition at line 27 of file slider.qh.

◆ tolerance

vector Slider::tolerance = '0 0 0'

Definition at line 42 of file slider.qh.

◆ value

float Slider::value = 0

Definition at line 25 of file slider.qh.

Referenced by mousePress().

◆ valueDigits

float Slider::valueDigits = 0

Definition at line 32 of file slider.qh.

◆ valueDisplayMultiplier

float Slider::valueDisplayMultiplier = 1.0

Definition at line 35 of file slider.qh.

◆ valueKeyStep

float Slider::valueKeyStep = 0

Definition at line 33 of file slider.qh.

◆ valueMax

float Slider::valueMax = 0

Definition at line 30 of file slider.qh.

Referenced by mousePress().

◆ valueMin

float Slider::valueMin = 0

Definition at line 29 of file slider.qh.

Referenced by mousePress().

◆ valuePageStep

float Slider::valuePageStep = 0

Definition at line 34 of file slider.qh.

Referenced by mousePress().

◆ valueSpace

float Slider::valueSpace = 0

Definition at line 37 of file slider.qh.

Referenced by mousePress().

◆ valueStep

float Slider::valueStep = 0

Definition at line 31 of file slider.qh.

Referenced by mousePress().

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

menu/item/slider.qh
menu/item/slider.qc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ATTRIB() [1/7]

◆ ATTRIB() [2/7]

◆ ATTRIB() [3/7]

◆ ATTRIB() [4/7]

◆ ATTRIB() [5/7]

◆ ATTRIB() [6/7]

◆ ATTRIB() [7/7]

◆ configureLabel()

◆ configureSliderValues()

◆ configureSliderVisuals()

◆ destroy()

◆ draw()

◆ focusEnter()

◆ focusLeave()

◆ hideNotify()

◆ keyDown()

◆ keyUp()

◆ mouseDrag()

◆ mouseMove()

◆ mousePress()

◆ mouseRelease()

◆ recalcPositionWithText()

◆ relinquishFocus()

◆ resizeNotify()

◆ setSliderValue()

◆ setText()

◆ setValue()

◆ showNotify()

◆ toString()

◆ valueToText()

Member Data Documentation

◆ align

◆ allowColors

◆ allowCut

◆ allowFocusSound

◆ allowWrap

◆ allowWrap_spacing

◆ alpha

◆ animated

◆ color

◆ color2

◆ colorC

◆ colorD

◆ colorF

◆ colorL

◆ condenseFactor

◆ controlWidth

◆ disabled

◆ disabledAlpha

◆ focusable

◆ focused

◆ fontSize

◆ formatString

◆ isBold

◆ keepspaceLeft

◆ keepspaceRight

◆ marginLeft

◆ marginRight

◆ origin

◆ overrideCondenseFactor

◆ overrideRealOrigin

◆ preferredFocusPriority

◆ pressed

◆ pressOffset

◆ previousValue

◆ realFontSize

◆ realOrigin

◆ recalcPos

◆ size

◆ sliderValue

◆ tolerance

◆ value

◆ valueDigits

◆ valueDisplayMultiplier

◆ valueKeyStep

◆ valueMax