KRuler

#include <KRuler>

Inheritance diagram for KRuler:

[legend]

Public Types
enum	MetricStyle { Custom = 0, Pixel, Inch, Millimetres, Centimetres, Metres }

Public Types inherited from QAbstractSlider
enum	SliderAction

enum	SliderChange

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
int	bigMarkDistance

QString	endLabel

int	endOffset

int	length

bool	lengthFixed

int	littleMarkDistance

int	mediumMarkDistance

int	offset

double	pixelPerMark

bool	showBigMarks

bool	showEndLabel

bool	showLittleMarks

bool	showMediumMarks

bool	showPointer

bool	showTinyMarks

int	tinyMarkDistance

Properties inherited from QAbstractSlider
	invertedAppearance

	invertedControls

	maximum

	minimum

	orientation

	pageStep

	singleStep

	sliderDown

	sliderPosition

	tracking

	value

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Public Slots
void	slotEndOffset (int)

void	slotNewOffset (int)

void	slotNewValue (int)

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

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

	KRuler (QWidget *parent=nullptr)

	~KRuler () override

int	bigMarkDistance () const

QString	endLabel () const

int	endOffset () const

int	length () const

bool	lengthFixed () const

int	littleMarkDistance () const

int	maxValue () const

int	mediumMarkDistance () const

int	minValue () const

int	offset () const

double	pixelPerMark () const

void	setBigMarkDistance (int)

void	setEndLabel (const QString &)

void	setFrameStyle (int)

void	setLength (int)

void	setLengthFixed (bool fix)

void	setLittleMarkDistance (int)

void	setMaxValue (int)

void	setMediumMarkDistance (int)

void	setMinValue (int)

void	setOffset (int offset)

void	setPixelPerMark (double rate)

void	setRulerMetricStyle (KRuler::MetricStyle)

void	setShowBigMarks (bool)

void	setShowEndLabel (bool)

void	setShowEndMarks (bool)

void	setShowLittleMarks (bool)

void	setShowMediumMarks (bool)

void	setShowPointer (bool)

void	setShowTinyMarks (bool)

void	setTinyMarkDistance (int)

bool	showBigMarks () const

bool	showEndLabel () const

bool	showEndMarks () const

bool	showLittleMarks () const

bool	showMediumMarks () const

bool	showPointer () const

bool	showTinyMarks () const

void	slideDown (int count=1)

void	slideUp (int count=1)

int	tinyMarkDistance () const

Public Member Functions inherited from QAbstractSlider
	QAbstractSlider (QWidget *parent)

void	actionTriggered (int action)

bool	hasTracking () const const

bool	invertedAppearance () const const

bool	invertedControls () const const

bool	isSliderDown () const const

int	maximum () const const

int	minimum () const const

Qt::Orientation	orientation () const const

int	pageStep () const const

void	rangeChanged (int min, int max)

void	setInvertedAppearance (bool)

void	setInvertedControls (bool)

void	setMaximum (int)

void	setMinimum (int)

void	setOrientation (Qt::Orientation)

void	setPageStep (int)

void	setRange (int min, int max)

void	setSingleStep (int)

void	setSliderDown (bool)

void	setSliderPosition (int)

void	setTracking (bool enable)

void	setValue (int)

int	singleStep () const const

void	sliderMoved (int value)

int	sliderPosition () const const

void	sliderPressed ()

void	sliderReleased ()

void	triggerAction (QAbstractSlider::SliderAction action)

int	value () const const

void	valueChanged (int value)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

void	getContentsMargins (int left, int top, int right, int bottom) const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isEnabledToTLW () const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

virtual QSize	minimumSizeHint () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

int	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Protected Member Functions
void	paintEvent (QPaintEvent *) override

Protected Member Functions inherited from QAbstractSlider
virtual void	changeEvent (QEvent *ev) override

virtual bool	event (QEvent *e) override

virtual void	keyPressEvent (QKeyEvent *ev) override

QAbstractSlider::SliderAction	repeatAction () const const

void	setRepeatAction (QAbstractSlider::SliderAction action, int thresholdTime, int repeatTime)

virtual void	sliderChange (QAbstractSlider::SliderChange change)

virtual void	timerEvent (QTimerEvent *e) override

virtual void	wheelEvent (QWheelEvent *e) override

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (QPaintDevice::PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QAbstractSlider
	SliderMove

	SliderNoAction

	SliderOrientationChange

	SliderPageStepAdd

	SliderPageStepSub

	SliderRangeChange

	SliderSingleStepAdd

	SliderSingleStepSub

	SliderStepsChange

	SliderToMaximum

	SliderToMinimum

	SliderValueChange

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Detailed Description

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.

KRuler Widget

Author: Jörg Habenicht

Definition at line 53 of file kruler.h.

Member Enumeration Documentation

◆ MetricStyle

enum KRuler::MetricStyle

The types of units used.

Definition at line 77 of file kruler.h.

Constructor & Destructor Documentation

◆ KRuler() [1/3]

KRuler::KRuler ( QWidget * parent = nullptr )

explicit

Constructs a horizontal ruler.

Definition at line 98 of file kruler.cpp.

◆ KRuler() [2/3]

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

explicit

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.

Parameters

orient	Orientation of the ruler.
parent	Will be handed over to QFrame.
f	Will be handed over to QFrame.

Definition at line 109 of file kruler.cpp.

◆ KRuler() [3/3]

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.

Note: The size of the marks doesn't change. parent and f are passed to QFrame.

Parameters

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.

Definition at line 125 of file kruler.cpp.

◆ ~KRuler()

KRuler::~KRuler ( )

overridedefault

Destructor.

Member Function Documentation

◆ bigMarkDistance()

int KRuler::bigMarkDistance ( ) const

Returns the distance between big marks.

◆ littleMarkDistance()

int KRuler::littleMarkDistance ( ) const

Returns the distance between little marks.

◆ maxValue()

int KRuler::maxValue ( ) const

Returns the maximal value of the ruler pointer.

Deprecated:: Since 5.0, use maximum().

Definition at line 186 of file kruler.cpp.

◆ minValue()

int KRuler::minValue ( ) const

Returns the minimal value of the ruler pointer.

Deprecated:: Since 5.0, use minimum().

Definition at line 172 of file kruler.cpp.

◆ offset()

int KRuler::offset ( ) const

Returns the current ruler offset.

◆ pixelPerMark()

double KRuler::pixelPerMark ( ) const

Returns the number of pixels between two base marks.

◆ setBigMarkDistance()

void KRuler::setBigMarkDistance ( int dist )

Sets distance between big marks.

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

Definition at line 231 of file kruler.cpp.

◆ setEndLabel()

void KRuler::setEndLabel ( const QString & label )

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

Definition at line 341 of file kruler.cpp.

◆ setFrameStyle()

void KRuler::setFrameStyle ( int )

Is a no-op.

Deprecated:: Since 5.0.

Definition at line 323 of file kruler.cpp.

◆ setLength()

void KRuler::setLength ( int length )

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.

Definition at line 448 of file kruler.cpp.

◆ setLengthFixed()

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.

Parameters

fix	fixes the length, if true

Definition at line 470 of file kruler.cpp.

◆ setLittleMarkDistance()

void KRuler::setLittleMarkDistance ( int dist )

Sets the distance between little marks.

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

Definition at line 205 of file kruler.cpp.

◆ setMaxValue()

void KRuler::setMaxValue ( int value )

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

Deprecated:: Since 5.0, use setMaximum().

Definition at line 179 of file kruler.cpp.

◆ setMediumMarkDistance()

void KRuler::setMediumMarkDistance ( int dist )

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.

Definition at line 218 of file kruler.cpp.

◆ setMinValue()

void KRuler::setMinValue ( int value )

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

Deprecated:: Since 5.0, use setMinimum(int).

Definition at line 165 of file kruler.cpp.

◆ setOffset()

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.

Parameters

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

Definition at line 480 of file kruler.cpp.

◆ setPixelPerMark()

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

Definition at line 436 of file kruler.cpp.

◆ setRulerMetricStyle()

void KRuler::setRulerMetricStyle ( KRuler::MetricStyle style )

Sets up the necessary tasks for the provided styles.

A convenience method.

Definition at line 360 of file kruler.cpp.

◆ setShowBigMarks()

void KRuler::setShowBigMarks ( bool show )

Shows/hides big marks.

Definition at line 283 of file kruler.cpp.

◆ setShowEndLabel()

void KRuler::setShowEndLabel ( bool show )

Show/hide number values of the end marks.

Default is false.

Definition at line 328 of file kruler.cpp.

◆ setShowEndMarks()

void KRuler::setShowEndMarks ( bool show )

Shows/hides end marks.

Definition at line 296 of file kruler.cpp.

◆ setShowLittleMarks()

void KRuler::setShowLittleMarks ( bool show )

Shows/hides little marks.

Definition at line 257 of file kruler.cpp.

◆ setShowMediumMarks()

void KRuler::setShowMediumMarks ( bool show )

Shows/hides medium marks.

Definition at line 270 of file kruler.cpp.

◆ setShowPointer()

void KRuler::setShowPointer ( bool show )

Shows/hides the pointer.

Definition at line 309 of file kruler.cpp.

◆ setShowTinyMarks()

void KRuler::setShowTinyMarks ( bool show )

Shows/hides tiny marks.

Definition at line 244 of file kruler.cpp.

◆ setTinyMarkDistance()

void KRuler::setTinyMarkDistance ( int dist )

Sets the distance between tiny marks.

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

Definition at line 192 of file kruler.cpp.

◆ slideDown()

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.

Parameters

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

Definition at line 510 of file kruler.cpp.

◆ slideUp()

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.

Parameters

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

Definition at line 502 of file kruler.cpp.

◆ slotNewOffset

void KRuler::slotNewOffset ( int _offset )

slot

Sets the ruler marks to a new position.

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

Definition at line 542 of file kruler.cpp.

◆ slotNewValue

void KRuler::slotNewValue ( int _value )

slot

Sets the pointer to a new position.

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

Definition at line 518 of file kruler.cpp.

◆ tinyMarkDistance()

int KRuler::tinyMarkDistance ( ) const

Returns the distance between tiny marks.

The documentation for this class was generated from the following files:

KStandardShortcut::end

const QList< QKeySequence > & end()

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KRuler

Public Types

Properties

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MetricStyle

Constructor & Destructor Documentation

◆ KRuler() [1/3]

◆ KRuler() [2/3]

◆ KRuler() [3/3]

◆ ~KRuler()

Member Function Documentation

◆ bigMarkDistance()

◆ littleMarkDistance()

◆ maxValue()

◆ minValue()

◆ offset()

◆ pixelPerMark()

◆ setBigMarkDistance()

◆ setEndLabel()

◆ setFrameStyle()

◆ setLength()

◆ setLengthFixed()

◆ setLittleMarkDistance()

◆ setMaxValue()

◆ setMediumMarkDistance()

◆ setMinValue()

◆ setOffset()

◆ setPixelPerMark()

◆ setRulerMetricStyle()

◆ setShowBigMarks()

◆ setShowEndLabel()

◆ setShowEndMarks()

◆ setShowLittleMarks()

◆ setShowMediumMarks()

◆ setShowPointer()

◆ setShowTinyMarks()

◆ setTinyMarkDistance()

◆ slideDown()

◆ slideUp()

◆ slotNewOffset

◆ slotNewValue

◆ tinyMarkDistance()