|
|
A ruler widget.
The vertical ruler looks similar to this:
meters inches ------ <--- end mark ---> ------ -- - -- <---little mark---> -- -- - -- --- --- <---medium mark - -- -- -- tiny mark----> - -- ---- -- - ---- <-----big mark -- -- - |>-- <--ruler pointer--> |>--
There are tiny marks, little marks, medium marks, and big marks along the ruler.
To receive mouse clicks or mouse moves, the class has to be overloaded.
For performance reasons, the public methods don't call QWidget::repaint(). (Slots do, see documentation below.) All the changed settings will be painted once after leaving to the main event loop. For performance painting the slot methods should be used, they do a fast QWidget::repaint() call after changing the values. For setting multiple values like minValue(), maxValue(), offset() etc. using the public methods is recommended so the widget will be painted only once when entering the main event loop.
enum |
Direction of the ruler. Has to be defined when constructing the widget.
enum |
The types of units used.
enum |
The style (or look) of the ruler.
|
Constructor, requires the ruler direction.
parent
, name
, f
and allowLines
are passed to QFrame.
The default look is a raised widget
but may be changed with the inherited QFrame methods.
Parameters:
dir | Cirection of the ruler. |
parent | Will be handed over to QFrame. |
name | Will be handed over to QFrame. |
f | Will be handed over to QFrame. |
allowLines | Will be handed over to QFrame. |
|
Constructor, requires the direction of the ruler and an initial width.
The width sets the fixed width of the widget. This is usefullif you
want to draw the ruler bigger or smaller than the default size.
Note: The size of the marks doesn't change.
parent
, name
, f
and allowLines
are passed to QFrame.
Parameters:
dir | Direction of the ruler. |
widgetWidth | Fixed width of the widget. |
parent | Will be handed over to QFrame. |
name | Will be handed over to QFrame. |
f | Will be handed over to QFrame. |
allowLines | Will be handed over to QFrame. |
~ |
Destructor.
void |
Set the minimal value of the ruler pointer (default is 0).
This method calls update() so that the widget is painted after leaving to the main event loop.
inline int |
[const]
Retrieve the minimal value of the ruler pointer.
void |
Set the maximum value of the ruler pointer (default is 100).
This method calls update() so that the widget is painted after leaving to the main event loop.
inline int |
[const]
returns the maximal value of the ruler pointer.
void |
Set minimum and maxmimum values of the ruler pointer.
This method calls update() so that the widget is painted after leaving to the main event loop.
void |
Set the value of the ruler pointer.
The value is indicated by painting the ruler pointer at the corresponding position. This method calls update() so that the widget is painted after leaving to the main event loop.
void |
Set distance between tiny marks.
This is mostly used in the English system (inches) with distance of 1.
inline int |
[const]
Retrieve the distance between tiny marks.
void |
Set the distance between little marks.
The default value is 1 in the metric system and 2 in the English (inches) system.
inline int |
[const]
Retrieve the distance between little marks.
void |
Set the distance between medium marks.
For English (inches) styles it defaults to twice the little mark distance. For metric styles it defaults to five times the little mark distance.
void |
Set distance between big marks.
For English (inches) or metric styles it is twice the medium mark distance.
inline int |
[const]
Retrieve the distance between big marks.
void |
Show/hide tiny marks.
void |
Show/hide little marks.
void |
Show/hide medium marks.
void |
Show/hide big marks.
void |
Show/hide end marks.
void |
Show/hide the pointer.
void |
Sets the value that is shown per little mark.
For metric systems this is 1 per mark. Note: If you set the value for little marks the values for medium and big marks are updated according to the the values set in the setXXMarkDistance(int) methods.
void |
Sets the value that is shown per medium mark.
For metric systems this is 5. Display of little marks is automatically disabled and big marks are updated according to the values set in the setBigMarkDistance() method.
void |
Sets the value that is shown per big mark.
For metric systems this is 1 Display of little and medium marks marks is disabled.
void |
Show/hide number values of the little marks.
Default is false
.
void |
Show/hide number values of the medium marks.
Default is false
.
void |
Show/hide number values of the big marks.
Default is false
.
void |
Show/hide number values of the end marks.
Default is false
.
void |
Set the label this is drawn at the beginning of the visible part of the ruler.
void |
Set up the necessary tasks for the provided styles.
A convenience method.
void |
currently not implemented
inline KRuler::paint_style |
[const]
currently not implemented
void |
currently not implemented
inline KRuler::paint_style |
[const]
currently not implemented
void |
Set the number of pixels between two base marks.
Calling this method stretches or shrinks your ruler.
For pixel display (metric_style) the value is 10.0 marks
per pixel ;-)
For English (inches) it is 9.0, and for centimetres ~2.835 -> 3.0 .
If you want to magnify your part of display, you have to
adjust the mark distance @bf here.
Notice: The double type is only supported to give the possibility
of having some double values.
It should be used with care. Using values below 10.0
shows visible jumps of markpositions (e.g. 2.345).
Using whole numbers is highly recommended.
To use int
values use setPixelPerMark((int)your_int_value);
default: 1 mark per 10 pixels
inline double |
[const]
Retrieve the number of pixels between two base marks.
void |
sets the length of the ruler, i.e. the difference between the begin mark and the end mark of the ruler.
Same as (width() - getOffset())
when the length is not locked, it gets adjusted with the length of the widget.
void |
locks the length of the ruler, i.e. the difference between the two end marks doesn't change when the widget is resized.
Parameters:
fix | fixes the length, if true |
void |
Set the number of pixels by which the ruler may slide up or left. The number of pixels moved is realive to the previous position. The Method makes sense for updating a ruler, which is working with a scrollbar.
This doesn't affect the position of the ruler pointer. Only the visible part of the ruler is moved.
Parameters:
count | Number of pixel moving up or left relative to the previous position |
void |
Set the number of pixels by which the ruler may slide down or right. The number of pixels moved is realive to the previous position. The Method makes sense for updating a ruler, which is working with a scrollbar.
This doesn't affect the position of the ruler pointer. Only the visible part of the ruler is moved.
Parameters:
count | Number of pixel moving up or left relative to the previous position |
void |
Set ruler slide offset.
This is like slideup() or slidedown() with an absolute offset from the start of the ruler.
Parameters:
offset | Number of pixel to move the ruler up or left from the beginning |
inline int |
[const]
Get the current ruler offset.
void |
[slot]
Sets the pointer to a new position.
The offset is NOT updated. QWidget::repaint() is called afterwards.
void |
[slot]
Sets the ruler marks to a new position.
The pointer is NOT updated. QWidget::repaint() is called afterwards.