kruler.h

/* -*- c++ -*- */
/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 1998 Jörg Habenicht <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef KRULER_H
#define KRULER_H

#include <kwidgetsaddons_export.h>

#include <QAbstractSlider>

class KWIDGETSADDONS_EXPORT KRuler : public QAbstractSlider
{
    Q_OBJECT
    Q_PROPERTY(bool showTinyMarks READ showTinyMarks WRITE setShowTinyMarks)
    Q_PROPERTY(bool showLittleMarks READ showLittleMarks WRITE setShowLittleMarks)
    Q_PROPERTY(bool showMediumMarks READ showMediumMarks WRITE setShowMediumMarks)
    Q_PROPERTY(bool showBigMarks READ showBigMarks WRITE setShowBigMarks)
    Q_PROPERTY(bool showPointer READ showPointer WRITE setShowPointer)
    Q_PROPERTY(bool showEndLabel READ showEndLabel WRITE setShowEndLabel)
    Q_PROPERTY(int tinyMarkDistance READ tinyMarkDistance WRITE setTinyMarkDistance)
    Q_PROPERTY(int littleMarkDistance READ littleMarkDistance WRITE setLittleMarkDistance)
    Q_PROPERTY(int mediumMarkDistance READ mediumMarkDistance WRITE setBigMarkDistance)
    Q_PROPERTY(int bigMarkDistance READ bigMarkDistance WRITE setBigMarkDistance)
    Q_PROPERTY(double pixelPerMark READ pixelPerMark WRITE setPixelPerMark)
    Q_PROPERTY(bool lengthFixed READ lengthFixed WRITE setLengthFixed)
    Q_PROPERTY(QString endLabel READ endLabel WRITE setEndLabel)
    Q_PROPERTY(int length READ length WRITE setLength)
    Q_PROPERTY(int offset READ offset)
    Q_PROPERTY(int endOffset READ endOffset)

public:
    enum MetricStyle { Custom = 0, Pixel, Inch, Millimetres, Centimetres, Metres };
    Q_ENUM(MetricStyle)

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

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

    ~KRuler();

#if KWIDGETSADDONS_ENABLE_DEPRECATED_SINCE(5, 0)

    KWIDGETSADDONS_DEPRECATED_VERSION(5, 0, "Use KRuler::setMinimum(int)")
    void setMinValue(int);
#endif

#if KWIDGETSADDONS_ENABLE_DEPRECATED_SINCE(5, 0)

    KWIDGETSADDONS_DEPRECATED_VERSION(5, 0, "Use KRuler::minimum()")
    int minValue() const;
#endif

#if KWIDGETSADDONS_ENABLE_DEPRECATED_SINCE(5, 0)

    KWIDGETSADDONS_DEPRECATED_VERSION(5, 0, "Use KRuler::setMaximum(int)")
    void setMaxValue(int);
#endif

#if KWIDGETSADDONS_ENABLE_DEPRECATED_SINCE(5, 0)

    KWIDGETSADDONS_DEPRECATED_VERSION(5, 0, "Use KRuler::maximum()")
    int maxValue() const;
#endif

    void setTinyMarkDistance(int);
    int tinyMarkDistance() const;

    void setLittleMarkDistance(int);

    int littleMarkDistance() const;

    void setMediumMarkDistance(int);
    int mediumMarkDistance() const;

    void setBigMarkDistance(int);
    int bigMarkDistance() const;

    void setShowTinyMarks(bool);
    bool showTinyMarks() const;
    void setShowLittleMarks(bool);
    bool showLittleMarks() const;
    void setShowMediumMarks(bool);
    bool showMediumMarks() const;
    void setShowBigMarks(bool);
    bool showBigMarks() const;
    void setShowEndMarks(bool);
    bool showEndMarks() const;
    void setShowPointer(bool);
    bool showPointer() const;

#if KWIDGETSADDONS_ENABLE_DEPRECATED_SINCE(5, 0)

    KWIDGETSADDONS_DEPRECATED_VERSION(5, 0, "No longer a feature")
    void setFrameStyle(int);
#endif

    void setShowEndLabel(bool);
    bool showEndLabel() const;

    void setEndLabel(const QString &);
    QString endLabel() const;

    void setRulerMetricStyle(KRuler::MetricStyle);

    void setPixelPerMark(double rate);

    double pixelPerMark() const;

    void setLength(int);
    int length() const;

    void setLengthFixed(bool fix);
    bool lengthFixed() const;

    void slideUp(int count = 1);

    void slideDown(int count = 1);

    void setOffset(int offset);

    int offset() const;

    int endOffset() const;

public Q_SLOTS:

    void slotNewValue(int);

    void slotNewOffset(int);

    void slotEndOffset(int);

protected:
    void paintEvent(QPaintEvent *) override;

private:
    void initWidget(Qt::Orientation orientation);

private:
    class KRulerPrivate;
    KRulerPrivate *const d;
};

#endif