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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
|
/*
* knuminput.h
*
* Copyright (c) 1997 Patrick Dowler <[email protected]>
* Copyright (c) 2000 Dirk A. Mueller <[email protected]>
* Copyright (c) 2002 Marc Mutz <[email protected]>
*
* Requires the Qt widget libraries, available at no cost at
* http://www.troll.no/
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef K_NUMINPUT_H
#define K_NUMINPUT_H
#include <tqwidget.h>
#include <tqspinbox.h>
#include <tdelibs_export.h>
class TQLabel;
class TQSlider;
class TQLineEdit;
class TQLayout;
class TQValidator;
class KIntSpinBox;
/* ------------------------------------------------------------------------ */
/**
* You need to inherit from this class if you want to implement K*NumInput
* for a different variable type
*
*/
class TDEUI_EXPORT KNumInput : public TQWidget
{
TQ_OBJECT
TQ_PROPERTY( TQString label READ label WRITE setLabel )
public:
/**
* Default constructor
* @param parent If parent is 0, the new widget becomes a top-level window. If parent is another widget, this widget becomes a child window inside parent. The new widget is deleted when its parent is deleted.
* @param name The name is sent to the TQObject constructor.
*/
KNumInput(TQWidget* parent=0, const char* name=0);
/**
* @param below A pointer to another KNumInput.
* @param parent parent widget
* @param name name of the widget
*/
KNumInput(KNumInput* below, TQWidget* parent=0, const char* name=0);
~KNumInput();
/**
* Sets the text and alignment of the main description label.
*
* @param label The text of the label.
* Use TQString::null to remove an existing one.
*
* @param a one of @p AlignLeft, @p AlignHCenter, YAlignRight and
* @p AlignTop, @p AlignVCenter, @p AlignBottom.
* default is @p AlignLeft | @p AlignTop.
*
* The vertical alignment flags have special meaning with this
* widget:
*
* @li @p AlignTop The label is placed above the edit/slider
* @li @p AlignVCenter The label is placed left beside the edit
* @li @p AlignBottom The label is placed below the edit/slider
*
*/
virtual void setLabel(const TQString & label, int a = AlignLeft | AlignTop);
/**
* @return the text of the label.
*/
TQString label() const;
/**
* @return if the num input has a slider.
* @since 3.1
*/
bool showSlider() const { return m_slider; }
/**
* Sets the spacing of tickmarks for the slider.
*
* @param minor Minor tickmark separation.
* @param major Major tickmark separation.
*/
void setSteps(int minor, int major);
/**
* Specifies that this widget may stretch horizontally, but is
* fixed vertically (like TQSpinBox itself).
*/
TQSizePolicy sizePolicy() const;
/**
* Returns a size which fits the contents of the control.
*
* @return the preferred size necessary to show the control
*/
virtual TQSize sizeHint() const;
protected:
/**
* Call this function whenever you change something in the geometry
* of your KNumInput child.
*
*/
void layout(bool deep);
/**
* You need to overwrite this method and implement your layout
* calculations there.
*
* See KIntNumInput::doLayout and KDoubleNumInput::doLayout implementation
* for details.
*
*/
virtual void doLayout() = 0;
KNumInput* m_prev, *m_next;
int m_colw1, m_colw2;
TQLabel* m_label;
TQSlider* m_slider;
TQSize m_sizeSlider, m_sizeLabel;
int m_alignment;
private:
void init();
protected:
virtual void virtual_hook( int id, void* data );
private:
class KNumInputPrivate;
KNumInputPrivate *d;
};
/* ------------------------------------------------------------------------ */
/**
* @short An input widget for integer numbers, consisting of a spinbox and a slider.
*
* KIntNumInput combines a TQSpinBox and optionally a QSlider
* with a label to make an easy to use control for setting some integer
* parameter. This is especially nice for configuration dialogs,
* which can have many such combinated controls.
*
* The slider is created only when the user specifies a range
* for the control using the setRange function with the slider
* parameter set to "true".
*
* A special feature of KIntNumInput, designed specifically for
* the situation when there are several KIntNumInputs in a column,
* is that you can specify what portion of the control is taken by the
* TQSpinBox (the remaining portion is used by the slider). This makes
* it very simple to have all the sliders in a column be the same size.
*
* It uses KIntValidator validator class. KIntNumInput enforces the
* value to be in the given range, and can display it in any base
* between 2 and 36.
*
* \image html kintnuminput.png "KDE Int Number Input Spinbox"
*
* @version $Id$
*/
class TDEUI_EXPORT KIntNumInput : public KNumInput
{
TQ_OBJECT
TQ_PROPERTY( int value READ value WRITE setValue )
TQ_PROPERTY( int minValue READ minValue WRITE setMinValue )
TQ_PROPERTY( int maxValue READ maxValue WRITE setMaxValue )
TQ_PROPERTY( int referencePoint READ referencePoint WRITE setReferencePoint )
TQ_PROPERTY( double relativeValue READ relativeValue WRITE setRelativeValue )
TQ_PROPERTY( TQString suffix READ suffix WRITE setSuffix )
TQ_PROPERTY( TQString prefix READ prefix WRITE setPrefix )
TQ_PROPERTY( TQString specialValueText READ specialValueText WRITE setSpecialValueText )
public:
/**
* Constructs an input control for integer values
* with base 10 and initial value 0.
*/
KIntNumInput(TQWidget *parent=0, const char *name=0);
/**
* Constructor
* It constructs a TQSpinBox that allows the input of integer numbers
* in the range of -INT_MAX to +INT_MAX. To set a descriptive label,
* use setLabel(). To enforce the value being in a range and optionally to
* attach a slider to it, use setRange().
*
* @param value initial value for the control
* @param base numeric base used for display
* @param parent parent TQWidget
* @param name internal name for this widget
*/
KIntNumInput(int value, TQWidget* parent=0, int base = 10, const char *name=0);
/**
* Constructor
*
* the difference to the one above is the "below" parameter. It tells
* this instance that it is visually put below some other KNumInput widget.
* Note that these two KNumInput's need not to have the same parent widget
* or be in the same layout group.
* The effect is that it'll adjust it's layout in correspondence
* with the layout of the other KNumInput's (you can build an arbitrary long
* chain).
*
* @param below append KIntNumInput to the KNumInput chain
* @param value initial value for the control
* @param base numeric base used for display
* @param parent parent TQWidget
* @param name internal name for this widget
*/
KIntNumInput(KNumInput* below, int value, TQWidget* parent=0, int base = 10, const char *name=0);
/**
* Destructor
*
*
*/
virtual ~KIntNumInput();
/**
* @return the current value.
*/
int value() const;
/**
* @return the curent value in units of the referencePoint.
* @since 3.1
*/
double relativeValue() const;
/**
* @return the current reference point
* @since 3.1
*/
int referencePoint() const;
/**
* @return the suffix displayed behind the value.
* @see setSuffix()
*/
TQString suffix() const;
/**
* @return the prefix displayed in front of the value.
* @see setPrefix()
*/
TQString prefix() const;
/**
* @return the string displayed for a special value.
* @see setSpecialValueText()
*/
TQString specialValueText() const;
/**
* @param min minimum value
* @param max maximum value
* @param step step size for the QSlider
* @param slider whether the slider is created or not
*/
void setRange(int min, int max, int step=1, bool slider=true);
/**
* Sets the minimum value.
*/
void setMinValue(int min);
/**
* @return the minimum value.
*/
int minValue() const;
/**
* Sets the maximum value.
*/
void setMaxValue(int max);
/**
* @return the maximum value.
*/
int maxValue() const;
/**
* Sets the special value text. If set, the SpinBox will display
* this text instead of the numeric value whenever the current
* value is equal to minVal(). Typically this is used for indicating
* that the choice has a special (default) meaning.
*/
void setSpecialValueText(const TQString& text);
virtual void setLabel(const TQString & label, int a = AlignLeft | AlignTop);
/**
* This method returns the minimum size necessary to display the
* control. The minimum size is enough to show all the labels
* in the current font (font change may invalidate the return value).
*
* @return the minimum size necessary to show the control
*/
virtual TQSize minimumSizeHint() const;
public slots:
/**
* Sets the value of the control.
*/
void setValue(int);
/**
* Sets the value in units of the referencePoint
* @since 3.1
*/
void setRelativeValue(double);
/**
* Sets the reference point for relativeValue.
* @since 3.1
*/
void setReferencePoint(int);
/**
* Sets the suffix to @p suffix.
* Use TQString::null to disable this feature.
* Formatting has to be provided (e.g. a space separator between the
* prepended @p value and the suffix's text has to be provided
* as the first character in the suffix).
*
* @see TQSpinBox::setSuffix(), #setPrefix()
*/
void setSuffix(const TQString &suffix);
/**
* Sets the prefix to @p prefix.
* Use TQString::null to disable this feature.
* Formatting has to be provided (see above).
*
* @see TQSpinBox::setPrefix(), #setSuffix()
*/
void setPrefix(const TQString &prefix);
/**
* sets focus to the edit widget and marks all text in if mark == true
*
*/
void setEditFocus( bool mark = true );
signals:
/**
* Emitted every time the value changes (by calling setValue() or
* by user interaction).
*/
void valueChanged(int);
/**
* Emitted whenever valueChanged is. Contains the change
* relative to the referencePoint.
* @since 3.1
*/
void relativeValueChanged(double);
private slots:
void spinValueChanged(int);
void slotEmitRelativeValueChanged(int);
protected:
virtual void doLayout();
void resizeEvent ( TQResizeEvent * );
KIntSpinBox* m_spin;
TQSize m_sizeSpin;
private:
void init(int value, int _base);
protected:
virtual void virtual_hook( int id, void* data );
private:
class KIntNumInputPrivate;
KIntNumInputPrivate *d;
};
/* ------------------------------------------------------------------------ */
class KDoubleLine;
/**
* @short An input control for real numbers, consisting of a spinbox and a slider.
*
* KDoubleNumInput combines a TQSpinBox and optionally a QSlider
* with a label to make an easy to use control for setting some float
* parameter. This is especially nice for configuration dialogs,
* which can have many such combinated controls.
*
* The slider is created only when the user specifies a range
* for the control using the setRange function with the slider
* parameter set to "true".
*
* A special feature of KDoubleNumInput, designed specifically for
* the situation when there are several instances in a column,
* is that you can specify what portion of the control is taken by the
* TQSpinBox (the remaining portion is used by the slider). This makes
* it very simple to have all the sliders in a column be the same size.
*
* It uses the KDoubleValidator validator class. KDoubleNumInput
* enforces the value to be in the given range, but see the class
* documentation of KDoubleSpinBox for the tricky
* interrelationship of precision and values. All of what is said
* there applies here, too.
*
* @see KIntNumInput, KDoubleSpinBox
*/
class TDEUI_EXPORT KDoubleNumInput : public KNumInput
{
TQ_OBJECT
TQ_PROPERTY( double value READ value WRITE setValue )
TQ_PROPERTY( double minValue READ minValue WRITE setMinValue )
TQ_PROPERTY( double maxValue READ maxValue WRITE setMaxValue )
TQ_PROPERTY( TQString suffix READ suffix WRITE setSuffix )
TQ_PROPERTY( TQString prefix READ prefix WRITE setPrefix )
TQ_PROPERTY( TQString specialValueText READ specialValueText WRITE setSpecialValueText )
TQ_PROPERTY( int precision READ precision WRITE setPrecision )
TQ_PROPERTY( double referencePoint READ referencePoint WRITE setReferencePoint )
TQ_PROPERTY( double relativeValue READ relativeValue WRITE setRelativeValue )
public:
/**
* Constructs an input control for double values
* with initial value 0.00.
*/
KDoubleNumInput(TQWidget *parent=0, const char *name=0);
/**
* @deprecated (value is rounded to a multiple of 1/100)
* Constructor
*
* @param value initial value for the control
* @param parent parent TQWidget
* @param name internal name for this widget
*/
KDoubleNumInput(double value, TQWidget *parent=0, const char *name=0) KDE_DEPRECATED;
/**
* Constructor
*
* @param lower lower boundary value
* @param upper upper boundary value
* @param value initial value for the control
* @param step step size to use for up/down arrow clicks
* @param precision number of digits after the decimal point
* @param parent parent TQWidget
* @param name internal name for this widget
* @since 3.1
*/
KDoubleNumInput(double lower, double upper, double value, double step=0.01,
int precision=2, TQWidget *parent=0, const char *name=0);
/**
* destructor
*/
virtual ~KDoubleNumInput();
/**
* @deprecated (rounds @p value to a multiple of 1/100)
* Constructor
*
* puts it visually below other KNumInput
*
* @param below
* @param value initial value for the control
* @param parent parent TQWidget
* @param name internal name for this widget
**/
KDoubleNumInput(KNumInput* below, double value, TQWidget* parent=0, const char* name=0) KDE_DEPRECATED;
/**
* Constructor
*
* the difference here is the "below" parameter. It tells this
* instance that it is visually put below some other KNumInput
* widget. Note that these two KNumInput's need not to have the
* same parent widget or be in the same layout group. The effect
* is that it'll adjust it's layout in correspondence with the
* layout of the other KNumInput's (you can build an arbitrary long
* chain).
*
* @param below append KDoubleNumInput to the KDoubleNumInput chain
* @param lower lower boundary value
* @param upper upper boundary value
* @param value initial value for the control
* @param step step size to use for up/down arrow clicks
* @param precision number of digits after the decimal point
* @param parent parent TQWidget
* @param name internal name for this widget
* @since 3.1
*/
KDoubleNumInput(KNumInput* below,
double lower, double upper, double value, double step=0.02,
int precision=2, TQWidget *parent=0, const char *name=0);
/**
* @return the current value.
*/
double value() const;
/**
* @return the suffix.
* @see setSuffix()
*/
TQString suffix() const;
/**
* @return the prefix.
* @see setPrefix()
*/
TQString prefix() const;
/**
* @return the precision.
* @see setPrecision()
*/
int precision() const;
/**
* @return the string displayed for a special value.
* @see setSpecialValueText()
*/
TQString specialValueText() const { return m_specialvalue; }
/**
* @param min minimum value
* @param max maximum value
* @param step step size for the QSlider
* @param slider whether the slider is created or not
*/
void setRange(double min, double max, double step=1, bool slider=true);
/**
* Sets the minimum value.
*/
void setMinValue(double min);
/**
* @return the minimum value.
*/
double minValue() const;
/**
* Sets the maximum value.
*/
void setMaxValue(double max);
/**
* @return the maximum value.
*/
double maxValue() const;
/**
* Specifies the number of digits to use.
*/
void setPrecision(int precision);
/**
* @return the reference point for relativeValue calculation
* @since 3.1
*/
double referencePoint() const;
/**
* @return the current value in units of referencePoint.
* @since 3.1
*/
double relativeValue() const;
/**
* Sets the special value text. If set, the spin box will display
* this text instead of the numeric value whenever the current
* value is equal to minVal(). Typically this is used for indicating
* that the choice has a special (default) meaning.
*/
void setSpecialValueText(const TQString& text);
virtual void setLabel(const TQString & label, int a = AlignLeft | AlignTop);
virtual TQSize minimumSizeHint() const;
virtual bool eventFilter(TQObject*, TQEvent*);
public slots:
/**
* Sets the value of the control.
*/
void setValue(double);
/**
* Sets the value in units of referencePoint.
* @since 3.1
*/
void setRelativeValue(double);
/**
* Sets the reference Point to @p ref. It @p ref == 0, emitting of
* relativeValueChanged is blocked and relativeValue
* just returns 0.
* @since 3.1
*/
void setReferencePoint(double ref);
/**
* Sets the suffix to be displayed to @p suffix. Use TQString::null to disable
* this feature. Note that the suffix is attached to the value without any
* spacing. So if you prefer to display a space separator, set suffix
* to something like " cm".
* @see setSuffix()
*/
void setSuffix(const TQString &suffix);
/**
* Sets the prefix to be displayed to @p prefix. Use TQString::null to disable
* this feature. Note that the prefix is attached to the value without any
* spacing.
* @see setPrefix()
*/
void setPrefix(const TQString &prefix);
signals:
/**
* Emitted every time the value changes (by calling setValue() or
* by user interaction).
*/
void valueChanged(double);
/**
* This is an overloaded member function, provided for
* convenience. It essentially behaves like the above function.
*
* Contains the value in units of referencePoint.
* @since 3.1
*/
void relativeValueChanged(double);
private slots:
void sliderMoved(int);
void slotEmitRelativeValueChanged(double);
protected:
virtual void doLayout();
void resizeEvent ( TQResizeEvent * );
virtual void resetEditBox();
// ### no longer used, remove when BIC allowed
KDoubleLine* edit;
bool m_range;
double m_lower, m_upper, m_step;
// ### end no longer used
TQSize m_sizeEdit;
friend class KDoubleLine;
private:
void init(double value, double lower, double upper,
double step, int precision);
double mapSliderToSpin(int) const;
void updateLegacyMembers();
// ### no longer used, remove when BIC allowed:
TQString m_specialvalue, m_prefix, m_suffix;
double m_value;
short m_precision;
// ### end remove when BIC allowed
protected:
virtual void virtual_hook( int id, void* data );
private:
class KDoubleNumInputPrivate;
KDoubleNumInputPrivate *d;
};
/* ------------------------------------------------------------------------ */
/**
* @short A TQSpinBox with support for arbitrary base numbers.
*
* A TQSpinBox with support for arbitrary base numbers
* (e.g. hexadecimal).
*
* The class provides an easy interface to use other
* numeric systems than the decimal.
*/
class TDEUI_EXPORT KIntSpinBox : public TQSpinBox
{
TQ_OBJECT
TQ_PROPERTY( int base READ base WRITE setBase )
public:
/**
* Constructor.
*
* Constructs a widget with an integer inputline with a little scrollbar
* and a slider, with minimal value 0, maximal value 99, step 1, base 10
* and initial value 0.
*/
KIntSpinBox( TQWidget *parent=0, const char *name=0);
/**
* Constructor.
*
* Constructs a widget with an integer inputline with a little scrollbar
* and a slider.
*
* @param lower The lowest valid value.
* @param upper The greatest valid value.
* @param step The step size of the scrollbar.
* @param value The actual value.
* @param base The base of the used number system.
* @param parent The parent of the widget.
* @param name The Name of the widget.
*/
KIntSpinBox(int lower, int upper, int step, int value, int base = 10,
TQWidget* parent = 0, const char* name = 0);
/**
* Destructor.
*/
virtual ~KIntSpinBox();
/**
* Sets the base in which the numbers in the spin box are represented.
*/
void setBase(int base);
/**
* @return the base in which numbers in the spin box are represented.
*/
int base() const;
/**
* sets focus and optionally marks all text
*
*/
void setEditFocus(bool mark);
protected:
/**
* Overloaded the method in QSpinBox
* to make use of the base given in the constructor.
*/
virtual TQString mapValueToText(int);
/**
* Overloaded the method in QSpinBox
* to make use of the base given in the constructor.
*/
virtual int mapTextToValue(bool*);
private:
int val_base;
protected:
virtual void virtual_hook( int id, void* data );
private:
class KIntSpinBoxPrivate;
KIntSpinBoxPrivate *d;
};
/* --------------------------------------------------------------------------- */
/**
@short A spin box for fractional numbers.
This class provides a spin box for fractional numbers.
\image html kdoublespinbox.png "KDE Fractional Number Spinbox"
See below for code examples on how to use this class.
\b Parameters \n
To make successful use of KDoubleSpinBox, you need to understand the
relationship between precision and available range.
@li precision: The number of digits after the decimal point.
@li maxValue/minValue: upper and lower bounds of the valid range
@li lineStep: the size of the step that is made when the user hits
the up or down buttons
Since we work with fixed-point numbers internally, the maximum
precision is a function of the valid range and vice versa. More
precisely, the following relationships hold:
\code
max( abs(minValue()), abs(maxValue() ) <= INT_MAX/10^precision
maxPrecision = floor( log10( INT_MAX/max(abs(minValue()),abs(maxValue())) ) )
\endcode
Since the value, bounds and lineStep are rounded to the current
precision, you may find that the order of setting these
parameters matters. As an example, the following are @em not equivalent (try
it!):
\code
// sets precision,
// then min/max value (rounded to precision and clipped to obtainable range if needed)
// then value and lineStep
KDoubleSpinBox * spin = new KDoubleSpinBox( 0, 9.999, 0.001, 4.321, 3, this );
// sets minValue to 0; maxValue to 10.00(!); value to 4.32(!) and only then
// increases the precision - too late, since e.g. value has already been rounded...
KDoubleSpinBox * spin = new KDoubleSpinBox( this );
spin->setMinValue( 0 );
spin->setMaxValue( 9.999 );
spin->setValue( 4.321 );
spin->setPrecision( 3 );
\endcode
@author Marc Mutz <[email protected]>
@version $Id$
@since 3.1
**/
class TDEUI_EXPORT KDoubleSpinBox : public TQSpinBox {
TQ_OBJECT
TQ_PROPERTY( bool acceptLocalizedNumbers READ acceptLocalizedNumbers WRITE setAcceptLocalizedNumbers )
TQ_OVERRIDE( double maxValue READ maxValue WRITE setMaxValue )
TQ_OVERRIDE( double minValue READ minValue WRITE setMinValue )
TQ_OVERRIDE( double lineStep READ lineStep WRITE setLineStep )
TQ_OVERRIDE( double value READ value WRITE setValue )
TQ_PROPERTY( int precision READ precision WRITE setPrecision )
public:
/** Constructs a KDoubleSpinBox with parent @p parent and
default values for range and value (whatever QRangeControl
uses) and precision (2). */
KDoubleSpinBox( TQWidget * parent=0, const char * name=0 );
/** Constructs a KDoubleSpinBox with parent @p parent, range
[ @p lower, @p upper ], lineStep @p step, precision @p
precision and initial value @p value. */
KDoubleSpinBox( double lower, double upper, double step, double value,
int precision=2, TQWidget * parent=0, const char * name=0 );
virtual ~KDoubleSpinBox();
/** @return whether the spinbox uses localized numbers */
bool acceptLocalizedNumbers() const;
/** Sets whether to use and accept localized numbers as returned by
TDELocale::formatNumber() */
virtual void setAcceptLocalizedNumbers( bool accept );
/** Sets a new range for the spin box values. Note that @p lower, @p
upper and @p step are rounded to @p precision decimal points
first. */
void setRange( double lower, double upper, double step=0.01, int precision=2 );
/** @return the current number of digits displayed to the right of the
decimal point. */
int precision() const;
/** Equivalent to setPrecision( @p precision, @p false ); Needed
since Qt's moc doesn't ignore trailing parameters with default
args when searching for a property setter method. */
void setPrecision( int precision );
/** Sets the precision (number of digits to the right of the decimal point). Note
that there is a tradeoff between the precision used and the available range of
values. See the class documentation above for more information on this.
@param precision the new precision to use
@param force if true, disables checking of bounds violations that can
arise if you increase the precision so much that the
minimum and maximum values can't be represented
anymore. Disabling is useful if you were going to disable range
control in any case.
**/
virtual void setPrecision( int precision, bool force );
/** @return the current value */
double value() const;
/** @return the current lower bound */
double minValue() const;
/** Sets the lower bound of the range to @p value, subject to the
contraints that @p value is first rounded to the current
precision and then clipped to the maximum range interval that can
be handled at that precision.
@see maxValue, minValue, setMaxValue, setRange
*/
void setMinValue( double value );
/** @return the current upper bound */
double maxValue() const;
/** Sets the upper bound of the range to @p value, subject to the
contraints that @p value is first rounded to the current
precision and then clipped to the maximum range interval
that can be handled at that precision.
@see minValue, maxValue, setMinValue, setRange
*/
void setMaxValue( double value );
/** @return the current step size */
double lineStep() const;
/** Sets the step size for clicking the up/down buttons to @p step,
subject to the constraints that @p step is first rounded to the
current precision and then clipped to the meaningful interval
[ 1, @p maxValue() - @p minValue() ]. */
void setLineStep( double step );
/** Overridden to ignore any setValidator() calls. */
void setValidator( const TQValidator * );
signals:
/** Emitted whenever TQSpinBox::valueChanged( int ) is emitted. */
void valueChanged( double value );
public slots:
/** Sets the current value to @p value, subject to the constraints
that @p value is first rounded to the current precision and then
clipped to the interval [ @p minValue() , @p maxValue() ]. */
virtual void setValue( double value );
protected:
virtual TQString mapValueToText(int);
virtual int mapTextToValue(bool*);
protected slots:
void slotValueChanged( int value );
protected:
virtual void virtual_hook( int id, void* data );
private:
typedef TQSpinBox base;
void updateValidator();
int maxPrecision() const;
class Private;
Private * d;
};
#endif // K_NUMINPUT_H
|