summaryrefslogtreecommitdiff
path: root/indra/llui/llspinctrl.cpp
blob: 7d41d803340ba94bf49bc3468c0a98e83d5fc014 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
/**
 * @file llspinctrl.cpp
 * @brief LLSpinCtrl base class
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include "linden_common.h"

#include "llspinctrl.h"

#include "llgl.h"
#include "llui.h"
#include "lluiconstants.h"

#include "llstring.h"
#include "llfontgl.h"
#include "lllineeditor.h"
#include "llbutton.h"
#include "lltextbox.h"
#include "llkeyboard.h"
#include "llmath.h"
#include "llcontrol.h"
#include "llfocusmgr.h"
#include "llresmgr.h"
#include "lluictrlfactory.h"

const U32 MAX_STRING_LENGTH = 255;

static LLDefaultChildRegistry::Register<LLSpinCtrl> r2("spinner");

LLSpinCtrl::Params::Params()
:   label_width("label_width"),
    decimal_digits("decimal_digits"),
    allow_text_entry("allow_text_entry", true),
    allow_digits_only("allow_digits_only", false),
    label_wrap("label_wrap", false),
    text_enabled_color("text_enabled_color"),
    text_disabled_color("text_disabled_color"),
    up_button("up_button"),
    down_button("down_button")
{}

LLSpinCtrl::LLSpinCtrl(const LLSpinCtrl::Params& p)
:   LLF32UICtrl(p),
    mLabelBox(NULL),
    mbHasBeenSet( false ),
    mPrecision(p.decimal_digits),
    mTextEnabledColor(p.text_enabled_color()),
    mTextDisabledColor(p.text_disabled_color())
{
    static LLUICachedControl<S32> spinctrl_spacing ("UISpinctrlSpacing", 0);
    static LLUICachedControl<S32> spinctrl_btn_width ("UISpinctrlBtnWidth", 0);
    static LLUICachedControl<S32> spinctrl_btn_height ("UISpinctrlBtnHeight", 0);
    S32 centered_top = getRect().getHeight();
    S32 centered_bottom = getRect().getHeight() - 2 * spinctrl_btn_height;
    S32 btn_left = 0;
    // reserve space for spinner
    S32 label_width = llclamp(p.label_width(), 0, llmax(0, getRect().getWidth() - 40));

    // Label
    if( !p.label().empty() )
    {
        LLRect label_rect( 0, centered_top, label_width, centered_bottom );
        LLTextBox::Params params;
        params.wrap(p.label_wrap);
        params.name("SpinCtrl Label");
        params.rect(label_rect);
        params.initial_value(p.label());
        if (p.font.isProvided())
        {
            params.font(p.font);
        }
        mLabelBox = LLUICtrlFactory::create<LLTextBox> (params);
        addChild(mLabelBox);

        btn_left += label_rect.mRight + spinctrl_spacing;
    }

    S32 btn_right = btn_left + spinctrl_btn_width;

    // Spin buttons
    LLButton::Params up_button_params(p.up_button);
    up_button_params.rect = LLRect(btn_left, getRect().getHeight(), btn_right, getRect().getHeight() - spinctrl_btn_height);
    // Click callback starts within the button and ends within the button,
    // but LLSpinCtrl handles the action continuosly so subsribers needs to
    // be informed about click ending even if outside view, use 'up' instead
    up_button_params.mouse_up_callback.function(boost::bind(&LLSpinCtrl::onUpBtn, this, _2));
    up_button_params.mouse_held_callback.function(boost::bind(&LLSpinCtrl::onUpBtn, this, _2));
    up_button_params.commit_on_capture_lost = true;

    mUpBtn = LLUICtrlFactory::create<LLButton>(up_button_params);
    addChild(mUpBtn);

    LLButton::Params down_button_params(p.down_button);
    down_button_params.rect = LLRect(btn_left, getRect().getHeight() - spinctrl_btn_height, btn_right, getRect().getHeight() - 2 * spinctrl_btn_height);
    down_button_params.mouse_up_callback.function(boost::bind(&LLSpinCtrl::onDownBtn, this, _2));
    down_button_params.mouse_held_callback.function(boost::bind(&LLSpinCtrl::onDownBtn, this, _2));
    down_button_params.commit_on_capture_lost = true;
    mDownBtn = LLUICtrlFactory::create<LLButton>(down_button_params);
    addChild(mDownBtn);

    LLRect editor_rect( btn_right + 1, centered_top, getRect().getWidth(), centered_bottom );
    LLLineEditor::Params params;
    params.name("SpinCtrl Editor");
    params.rect(editor_rect);
    if (p.font.isProvided())
    {
        params.font(p.font);
    }
    params.max_length.bytes(MAX_STRING_LENGTH);
    params.commit_callback.function((boost::bind(&LLSpinCtrl::onEditorCommit, this, _2)));

    //*NOTE: allow entering of any chars for LLCalc, proper input will be evaluated on commit

    params.follows.flags(FOLLOWS_LEFT | FOLLOWS_BOTTOM);
    mEditor = LLUICtrlFactory::create<LLLineEditor> (params);
    mEditor->setFocusReceivedCallback( boost::bind(&LLSpinCtrl::onEditorGainFocus, _1, this ));
    mEditor->setFocusLostCallback( boost::bind(&LLSpinCtrl::onEditorLostFocus, _1, this ));
    if (p.allow_digits_only)
    {
        mEditor->setPrevalidateInput(LLTextValidate::validateNonNegativeS32NoSpace);
    }
    //RN: this seems to be a BAD IDEA, as it makes the editor behavior different when it has focus
    // than when it doesn't.  Instead, if you always have to double click to select all the text,
    // it's easier to understand
    //mEditor->setSelectAllonFocusReceived(true);
    mEditor->setSelectAllonCommit(false);
    addChild(mEditor);

    updateEditor();
    setUseBoundingRect( true );
}

F32 clamp_precision(F32 value, S32 decimal_precision)
{
    // pow() isn't perfect

    F64 clamped_value = value;
    for (S32 i = 0; i < decimal_precision; i++)
        clamped_value *= 10.0;

    clamped_value = ll_round(clamped_value);

    for (S32 i = 0; i < decimal_precision; i++)
        clamped_value /= 10.0;

    return (F32)clamped_value;
}


void LLSpinCtrl::onUpBtn( const LLSD& data )
{
    if( getEnabled() )
    {
        std::string text = mEditor->getText();
        if( LLLineEditor::postvalidateFloat( text ) )
        {

            LLLocale locale(LLLocale::USER_LOCALE);
            F32 cur_val = (F32) atof(text.c_str());

            // use getValue()/setValue() to force reload from/to control
            F32 val = cur_val + mIncrement;
            val = clamp_precision(val, mPrecision);
            val = llmin( val, mMaxValue );
            if (val < mMinValue) val = mMinValue;
            if (val > mMaxValue) val = mMaxValue;

            F32 saved_val = (F32)getValue().asReal();
            setValue(val);
            if( mValidateSignal && !(*mValidateSignal)( this, val ) )
            {
                setValue( saved_val );
                reportInvalidData();
                updateEditor();
                return;
            }

        updateEditor();
        onCommit();
        }
    }
}

void LLSpinCtrl::onDownBtn( const LLSD& data )
{
    if( getEnabled() )
    {
        std::string text = mEditor->getText();
        if( LLLineEditor::postvalidateFloat( text ) )
        {

            LLLocale locale(LLLocale::USER_LOCALE);
            F32 cur_val = (F32) atof(text.c_str());

            F32 val = cur_val - mIncrement;
            val = clamp_precision(val, mPrecision);
            val = llmax( val, mMinValue );

            if (val < mMinValue) val = mMinValue;
            if (val > mMaxValue) val = mMaxValue;

            F32 saved_val = (F32)getValue().asReal();
            setValue(val);
            if( mValidateSignal && !(*mValidateSignal)( this, val ) )
            {
                setValue( saved_val );
                reportInvalidData();
                updateEditor();
                return;
            }

            updateEditor();
            onCommit();
        }
    }
}

// static
void LLSpinCtrl::onEditorGainFocus( LLFocusableElement* caller, void *userdata )
{
    LLSpinCtrl* self = (LLSpinCtrl*) userdata;
    llassert( caller == self->mEditor );

    self->onFocusReceived();
}

// static
void LLSpinCtrl::onEditorLostFocus( LLFocusableElement* caller, void *userdata )
{
    LLSpinCtrl* self = (LLSpinCtrl*) userdata;
    llassert( caller == self->mEditor );

    self->onFocusLost();

    std::string text = self->mEditor->getText();

    LLLocale locale(LLLocale::USER_LOCALE);
    F32 val = (F32)atof(text.c_str());

    F32 saved_val = self->getValueF32();
    if (saved_val != val && !self->mEditor->isDirty())
    {
        // Editor was focused when value update arrived, string
        // in editor is different from one in spin control.
        // Since editor is not dirty, it won't commit, so either
        // attempt to commit value from editor or revert to a more
        // recent value from spin control
        self->updateEditor();
    }
}

void LLSpinCtrl::setValue(const LLSD& value )
{
    F32 v = (F32)value.asReal();
    if (getValueF32() != v || !mbHasBeenSet)
    {
        mbHasBeenSet = true;
        LLF32UICtrl::setValue(value);

        if (!mEditor->hasFocus())
        {
            updateEditor();
        }
    }
}

//no matter if Editor has the focus, update the value
void LLSpinCtrl::forceSetValue(const LLSD& value )
{
    F32 v = (F32)value.asReal();
    if (getValueF32() != v || !mbHasBeenSet)
    {
        mbHasBeenSet = true;
        LLF32UICtrl::setValue(value);

        updateEditor();
        mEditor->resetScrollPosition();
    }
}

void LLSpinCtrl::clear()
{
    setValue(mMinValue);
    mEditor->clear();
    mbHasBeenSet = false;
}

void LLSpinCtrl::updateLabelColor()
{
    if( mLabelBox )
    {
        mLabelBox->setColor( getEnabled() ? mTextEnabledColor.get() : mTextDisabledColor.get() );
    }
}

void LLSpinCtrl::updateEditor()
{
    LLLocale locale(LLLocale::USER_LOCALE);

    // Don't display very small negative valu   es as -0.000
    F32 displayed_value = clamp_precision((F32)getValue().asReal(), mPrecision);

//  if( S32( displayed_value * pow( 10, mPrecision ) ) == 0 )
//  {
//      displayed_value = 0.f;
//  }

    std::string format = llformat("%%.%df", mPrecision);
    std::string text = llformat(format.c_str(), displayed_value);
    mEditor->setText( text );
}

void LLSpinCtrl::onEditorCommit( const LLSD& data )
{
    bool success = false;

    if( mEditor->evaluateFloat() )
    {
        std::string text = mEditor->getText();

        LLLocale locale(LLLocale::USER_LOCALE);
        F32 val = (F32) atof(text.c_str());

        if (val < mMinValue) val = mMinValue;
        if (val > mMaxValue) val = mMaxValue;

        F32 saved_val = getValueF32();
        setValue(val);
        if( !mValidateSignal || (*mValidateSignal)( this, val ) )
        {
            success = true;
            onCommit();
        }
        else
        {
            setValue(saved_val);
        }
    }
    updateEditor();

    if( success )
    {
        // We commited and clamped value
        // try to display as much as possible
        mEditor->resetScrollPosition();
    }
    else
    {
        reportInvalidData();
    }
}


void LLSpinCtrl::forceEditorCommit()
{
    onEditorCommit( LLSD() );
}


void LLSpinCtrl::setFocus(bool b)
{
    LLUICtrl::setFocus( b );
    mEditor->setFocus( b );
}

void LLSpinCtrl::setEnabled(bool b)
{
    LLView::setEnabled( b );
    mEditor->setEnabled( b );
    updateLabelColor();
}


void LLSpinCtrl::setTentative(bool b)
{
    mEditor->setTentative(b);
    LLUICtrl::setTentative(b);
}


bool LLSpinCtrl::isMouseHeldDown() const
{
    return
        mDownBtn->hasMouseCapture()
        || mUpBtn->hasMouseCapture();
}

void LLSpinCtrl::onCommit()
{
    setTentative(false);
    setControlValue(getValueF32());
    LLF32UICtrl::onCommit();
}


void LLSpinCtrl::setPrecision(S32 precision)
{
    if (precision < 0 || precision > 10)
    {
        LL_ERRS() << "LLSpinCtrl::setPrecision - precision out of range" << LL_ENDL;
        return;
    }

    mPrecision = precision;
    updateEditor();
}

void LLSpinCtrl::setLabel(const LLStringExplicit& label)
{
    if (mLabelBox)
    {
        mLabelBox->setText(label);
    }
    else
    {
        LL_WARNS() << "Attempting to set label on LLSpinCtrl constructed without one " << getName() << LL_ENDL;
    }
    updateLabelColor();
}

void LLSpinCtrl::setAllowEdit(bool allow_edit)
{
    mEditor->setEnabled(allow_edit);
    mAllowEdit = allow_edit;
}

void LLSpinCtrl::onTabInto()
{
    mEditor->onTabInto();
    LLF32UICtrl::onTabInto();
}


void LLSpinCtrl::reportInvalidData()
{
    make_ui_sound("UISndBadKeystroke");
}

bool LLSpinCtrl::handleScrollWheel(S32 x, S32 y, S32 clicks)
{
    if( clicks > 0 )
    {
        while( clicks-- )
        {
            onDownBtn(getValue());
        }
    }
    else
    while( clicks++ )
    {
        onUpBtn(getValue());
    }

    return true;
}

bool LLSpinCtrl::handleKeyHere(KEY key, MASK mask)
{
    if (mEditor->hasFocus())
    {
        if(key == KEY_ESCAPE)
        {
            // text editors don't support revert normally (due to user confusion)
            // but not allowing revert on a spinner seems dangerous
            updateEditor();
            mEditor->resetScrollPosition();
            mEditor->setFocus(false);
            return true;
        }
        if(key == KEY_UP)
        {
            onUpBtn(getValue());
            return true;
        }
        if(key == KEY_DOWN)
        {
            onDownBtn(getValue());
            return true;
        }
    }
    return false;
}