KRuler Class

meters                       inches

------   <--- end mark  ---> ------
    --                            -
    --   <---little mark--->     --
    --                            -
    --                          ---
   ---   <---medium mark          -
    --                           --
    --        tiny mark---->      -
    --                         ----
    --                            -
  ----   <-----big mark          --
    --                            -
  |>--   <--ruler pointer-->   |>--

Member Function Documentation

[explicit] KRuler::KRuler(QWidget *parent = nullptr)

Constructs a horizontal ruler.

[explicit] KRuler::KRuler(Qt::Orientation orient, QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags())

Constructs a ruler with orientation orient.

parent and f are passed to QFrame. The default look is a raised widget but may be changed with the inherited QFrame methods.

orient Orientation of the ruler.

parent Will be handed over to QFrame.

f Will be handed over to QFrame.

KRuler::KRuler(Qt::Orientation orient, int widgetWidth, QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags())

Constructs a ruler with orientation orient and initial width widgetWidth.

The width sets the fixed width of the widget. This is useful if you want to draw the ruler bigger or smaller than the default size.

parent and f are passed to QFrame.

orient Orientation of the ruler.

widgetWidth Fixed width of the widget.

parent Will be handed over to QFrame.

f Will be handed over to QFrame.

int KRuler::bigMarkDistance() const

Returns the distance between big marks.

See also setBigMarkDistance().

QString KRuler::endLabel() const

See also setEndLabel().

int KRuler::endOffset() const

int KRuler::length() const

See also setLength().

bool KRuler::lengthFixed() const

See also setLengthFixed().

int KRuler::littleMarkDistance() const

Returns the distance between little marks.

See also setLittleMarkDistance().

int KRuler::mediumMarkDistance() const

See also setMediumMarkDistance().

int KRuler::offset() const

Returns the current ruler offset.

See also setOffset().

double KRuler::pixelPerMark() const

Returns the number of pixels between two base marks.

See also setPixelPerMark().

void KRuler::setBigMarkDistance(int)

Sets distance between big marks.

For English (inches) or metric styles it is twice the medium mark distance.

See also bigMarkDistance().

void KRuler::setEndLabel(const QString &)

Sets the label this is drawn at the beginning of the visible part of the ruler to label

See also endLabel().

void KRuler::setLength(int)

Sets the length of the ruler, i.e. the difference between the begin mark and the end mark of the ruler.

Same as (width() - offset())

when the length is not locked, it gets adjusted with the length of the widget.

See also length().

void KRuler::setLengthFixed(bool fix)

Locks the length of the ruler, i.e. the difference between the two end marks doesn't change when the widget is resized.

fix fixes the length, if true

See also lengthFixed().

void KRuler::setLittleMarkDistance(int)

Sets the distance between little marks.

The default value is 1 in the metric system and 2 in the English (inches) system.

See also littleMarkDistance().

void KRuler::setMediumMarkDistance(int)

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

See also mediumMarkDistance().

void KRuler::setOffset(int offset)

Sets the ruler slide offset.

This is like slideup() or slidedown() with an absolute offset from the start of the ruler.

offset Number of pixel to move the ruler up or left from the beginning

See also offset().

void KRuler::setPixelPerMark(double rate)

Sets the number of pixels between two base marks.

Calling this method stretches or shrinks your ruler.

For pixel display ( MetricStyle) 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 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

See also pixelPerMark().

void KRuler::setRulerMetricStyle(KRuler::MetricStyle)

Sets up the necessary tasks for the provided styles.

A convenience method.

void KRuler::setShowBigMarks(bool)

Shows/hides big marks.

See also showBigMarks().

void KRuler::setShowEndLabel(bool)

Show/hide number values of the end marks.

Default is false.

See also showEndLabel().

void KRuler::setShowEndMarks(bool)

Shows/hides end marks.

See also showEndMarks().

void KRuler::setShowLittleMarks(bool)

Shows/hides little marks.

See also showLittleMarks().

void KRuler::setShowMediumMarks(bool)

Shows/hides medium marks.

See also showMediumMarks().

void KRuler::setShowPointer(bool)

Shows/hides the pointer.

See also showPointer().

void KRuler::setShowTinyMarks(bool)

Shows/hides tiny marks.

See also showTinyMarks().

void KRuler::setTinyMarkDistance(int)

Sets the distance between tiny marks.

This is mostly used in the English system (inches) with distance of 1.

See also tinyMarkDistance().

bool KRuler::showBigMarks() const

See also setShowBigMarks().

bool KRuler::showEndLabel() const

See also setShowEndLabel().

bool KRuler::showEndMarks() const

See also setShowEndMarks().

bool KRuler::showLittleMarks() const

See also setShowLittleMarks().

bool KRuler::showMediumMarks() const

See also setShowMediumMarks().

bool KRuler::showPointer() const

See also setShowPointer().

bool KRuler::showTinyMarks() const

See also setShowTinyMarks().

void KRuler::slideDown(int count = 1)

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

count Number of pixel moving up or left relative to the previous position

void KRuler::slideUp(int count = 1)

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

count Number of pixel moving up or left relative to the previous position

[slot] void KRuler::slotEndOffset(int)

[slot] void KRuler::slotNewOffset(int)

Sets the ruler marks to a new position.

The pointer is NOT updated. QWidget::repaint() is called afterwards.

[slot] void KRuler::slotNewValue(int)

Sets the pointer to a new position.

The offset is NOT updated. QWidget::repaint() is called afterwards.

int KRuler::tinyMarkDistance() const

Returns the distance between tiny marks.

See also setTinyMarkDistance().