KoRuler Class Reference

#include <KoRuler.h>

Inheritance diagram for KoRuler:

Classes
struct	Tab
	For paragraphs each tab definition is represented by this struct. More...

Public Slots
void	clearHotSpots ()
void	createGuideToolConnection (KoCanvasBase *canvas)
bool	removeHotSpot (int id)
void	setActiveRange (qreal start, qreal end)
void	setEndIndent (qreal indent)
void	setFirstLineIndent (qreal indent)
void	setHotSpot (qreal position, int id=-1)
void	setOffset (int offset)
void	setOverrideActiveRange (qreal start, qreal end)
void	setParagraphIndent (qreal indent)
void	setRelativeTabs (bool relative)
void	setRightToLeft (bool isRightToLeft)
void	setRulerLength (qreal length)
	Sets the length of the ruler to length in points (pt)
void	setShowIndents (bool show)
void	setShowMousePosition (bool show)
void	setShowSelectionBorders (bool show)
void	setShowTabs (bool show)
void	setUnit (const KoUnit &unit)
	Set the unit of the ruler.
void	setUnitPixelMultiple2 (bool enabled)
bool	showMousePosition () const
QList< Tab >	tabs () const
void	updateMouseCoordinate (int coordinate)
void	updateSelectionBorders (qreal first, qreal second)
void	updateTabs (const QList< Tab > &tabs, qreal tabDistance)

Signals
void	aboutToChange ()
	emitted when there the user is about to change a tab or hotspot
void	guideCreationFinished (Qt::Orientation orientation, const QPoint &globalPos)
void	guideCreationInProgress (Qt::Orientation orientation, const QPoint &globalPos)
void	guideLineCreated (Qt::Orientation orientation, qreal viewPosition)
	emitted when the mouse is drag+released outside the ruler
void	hotSpotChanged (int id, qreal newPosition)
void	indentsChanged (bool final)
void	tabChanged (int originalTabIndex, KoRuler::Tab *tab)

Public Member Functions
qreal	endIndent () const
	The end indent of all lines.
qreal	firstLineIndent () const
	The start indent of the first line.
	KoRuler (QWidget *parent, Qt::Orientation orientation, const KoViewConverter *viewConverter)
QSize	minimumSizeHint () const override
	reimplemented
Qt::Orientation	orientation () const
	The orientation of the ruler.
qreal	paragraphIndent () const
	The start indent of the rest of the lines.
QList< QAction * >	popupActionList () const
qreal	rulerLength () const
	The length of the ruler in points (pt)
void	setPopupActionList (const QList< QAction * > &popupActionList)
QSize	sizeHint () const override
	reimplemented
QWidget *	tabChooser ()
KoUnit	unit () const
	The ruler's unit.
	~KoRuler () override

Protected Member Functions
void	mouseMoveEvent (QMouseEvent *ev) override
	reimplemented
void	mousePressEvent (QMouseEvent *ev) override
	reimplemented
void	mouseReleaseEvent (QMouseEvent *ev) override
	reimplemented
void	paintEvent (QPaintEvent *event) override
	reimplemented

Private Attributes
KoRulerPrivate *const	d

Friends
class	KoRulerPrivate

Detailed Description

Decorator widget to draw a single ruler around a canvas.

Definition at line 29 of file KoRuler.h.

Constructor & Destructor Documentation

KoRuler()

KoRuler::KoRuler	(	QWidget *	parent,
		Qt::Orientation	orientation,
		const KoViewConverter *	viewConverter )

Creates a ruler with the orientation orientation

Parameters

parent	parent widget
orientation	the orientation of the ruler
viewConverter	the view converter used to convert from point to pixel

Definition at line 826 of file KoRuler.cpp.

  : QWidget(parent)
  , d( new KoRulerPrivate( this, viewConverter, orientation) )
{
    setMouseTracking( true );
}

~KoRuler()

KoRuler::~KoRuler ( )

override

Definition at line 833 of file KoRuler.cpp.

{
    delete d;
}

References d.

Member Function Documentation

aboutToChange

void KoRuler::aboutToChange ( )

signal

emitted when there the user is about to change a tab or hotspot

clearHotSpots

void KoRuler::clearHotSpots ( )

slot

Clear all previously set hotspots. A hotspot is a position on the ruler that the user can manipulate by dragging.

Definition at line 1320 of file KoRuler.cpp.

{
    if (d->hotspots.isEmpty())
        return;
    d->hotspots.clear();
    update();
}

References d, and KoRulerPrivate::hotspots.

createGuideToolConnection

void KoRuler::createGuideToolConnection ( KoCanvasBase * canvas )

slot

Connect the ruler to a guides tool This allows the user to drag a guide out of the ruler and get in one smooth operation the guide tool to draw and position the guide line.

Parameters

canvas

the canvas that has had the KoToolManager create the tool for previously.

Definition at line 1359 of file KoRuler.cpp.

{
    Q_ASSERT(canvas);
    KoToolBase *tool = KoToolManager::instance()->toolById(canvas, QLatin1String("GuidesTool"));
    if (!tool) return; // It's perfectly fine to have no guides tool, we don't have to warn the user about it
    connect(this, SIGNAL(guideLineCreated(Qt::Orientation,qreal)),
        tool, SLOT(createGuideLine(Qt::Orientation,qreal)));
}

References connect(), guideLineCreated(), KoToolManager::instance(), and KoToolManager::toolById().

endIndent()

qreal KoRuler::endIndent

(

)

const

The end indent of all lines.

Definition at line 986 of file KoRuler.cpp.

{
    return d->endIndent;
}

References d, and KoRulerPrivate::endIndent.

firstLineIndent()

qreal KoRuler::firstLineIndent

(

)

const

The start indent of the first line.

Definition at line 976 of file KoRuler.cpp.

{
    return d->firstLineIndent;
}

References d, and KoRulerPrivate::firstLineIndent.

guideCreationFinished

void KoRuler::guideCreationFinished ( Qt::Orientation orientation, const QPoint & globalPos )

signal

guideCreationInProgress

void KoRuler::guideCreationInProgress ( Qt::Orientation orientation, const QPoint & globalPos )

signal

guideLineCreated

void KoRuler::guideLineCreated ( Qt::Orientation orientation, qreal viewPosition )

signal

emitted when the mouse is drag+released outside the ruler

hotSpotChanged

void KoRuler::hotSpotChanged ( int id, qreal newPosition )

signal

indentsChanged

void KoRuler::indentsChanged ( bool final )

signal

emitted when any of the indents is moved by the user.

Parameters

final

false until the user releases the mouse. So you can implement live update.

minimumSizeHint()

QSize KoRuler::minimumSizeHint ( ) const

override

reimplemented

Definition at line 897 of file KoRuler.cpp.

{
    return d->paintingStrategy->sizeHint();
}

References d, KoRulerPrivate::paintingStrategy, and PaintingStrategy::sizeHint().

mouseMoveEvent()

void KoRuler::mouseMoveEvent ( QMouseEvent * ev )

overrideprotected

reimplemented

Definition at line 1175 of file KoRuler.cpp.

{
    QPoint pos = ev->pos();
 
    if (d->selected == KoRulerPrivate::None && d->guideCreationStarted) {
        Q_EMIT guideCreationInProgress(d->orientation, ev->globalPos());
        ev->accept();
        update();
        return;
    }
 
    qreal activeLength = d->effectiveActiveRangeEnd() - d->effectiveActiveRangeStart();
 
    switch (d->selected) {
    case KoRulerPrivate::FirstLineIndent:
        if (d->rightToLeft)
            d->firstLineIndent = d->effectiveActiveRangeEnd() - d->paragraphIndent -
                d->viewConverter->viewToDocumentX(pos.x() + d->selectOffset - d->offset);
        else
            d->firstLineIndent = d->viewConverter->viewToDocumentX(pos.x() + d->selectOffset
                - d->offset) - d->effectiveActiveRangeStart() - d->paragraphIndent;
        if( ! (ev->modifiers() & Qt::ShiftModifier)) {
            d->firstLineIndent = d->doSnapping(d->firstLineIndent);
            d->paintingStrategy = d->normalPaintingStrategy;
        } else {
            if (d->orientation == Qt::Horizontal)
                d->paintingStrategy = d->distancesPaintingStrategy;
        }
 
        Q_EMIT indentsChanged(false);
        break;
    case KoRulerPrivate::ParagraphIndent:
        if (d->rightToLeft)
            d->paragraphIndent = d->effectiveActiveRangeEnd() -
                d->viewConverter->viewToDocumentX(pos.x() + d->selectOffset - d->offset);
        else
            d->paragraphIndent = d->viewConverter->viewToDocumentX(pos.x() + d->selectOffset
                - d->offset) - d->effectiveActiveRangeStart();
        if( ! (ev->modifiers() & Qt::ShiftModifier)) {
            d->paragraphIndent = d->doSnapping(d->paragraphIndent);
            d->paintingStrategy = d->normalPaintingStrategy;
        } else {
            if (d->orientation == Qt::Horizontal)
                d->paintingStrategy = d->distancesPaintingStrategy;
        }
 
        if (d->paragraphIndent + d->endIndent > activeLength)
            d->paragraphIndent = activeLength - d->endIndent;
        Q_EMIT indentsChanged(false);
        break;
    case KoRulerPrivate::EndIndent:
        if (d->rightToLeft)
            d->endIndent = d->viewConverter->viewToDocumentX(pos.x()
                 + d->selectOffset - d->offset) - d->effectiveActiveRangeStart();
        else
            d->endIndent = d->effectiveActiveRangeEnd() - d->viewConverter->viewToDocumentX(pos.x()
                 + d->selectOffset - d->offset);
        if (!(ev->modifiers() & Qt::ShiftModifier)) {
            d->endIndent = d->doSnapping(d->endIndent);
            d->paintingStrategy = d->normalPaintingStrategy;
        } else {
            if (d->orientation == Qt::Horizontal)
                d->paintingStrategy = d->distancesPaintingStrategy;
        }
 
        if (d->paragraphIndent + d->endIndent > activeLength)
            d->endIndent = activeLength - d->paragraphIndent;
        Q_EMIT indentsChanged(false);
        break;
    case KoRulerPrivate::Tab:
        d->tabMoved = true;
        if (d->currentIndex < 0) { // tab is deleted.
            if (ev->pos().y() < height()) { // reinstate it.
                d->currentIndex = d->tabs.count();
                d->tabs.append(d->deletedTab);
            } else {
                break;
            }
        }
        if (d->rightToLeft)
            d->tabs[d->currentIndex].position = d->effectiveActiveRangeEnd() -
                d->viewConverter->viewToDocumentX(pos.x() + d->selectOffset - d->offset);
        else
            d->tabs[d->currentIndex].position = d->viewConverter->viewToDocumentX(pos.x() + d->selectOffset
                - d->offset) - d->effectiveActiveRangeStart();
        if (!(ev->modifiers() & Qt::ShiftModifier))
            d->tabs[d->currentIndex].position = d->doSnapping(d->tabs[d->currentIndex].position);
        if (d->tabs[d->currentIndex].position < 0)
            d->tabs[d->currentIndex].position = 0;
        if (d->tabs[d->currentIndex].position > activeLength)
            d->tabs[d->currentIndex].position = activeLength;
 
        if (ev->pos().y() > height() + OutsideRulerThreshold ) { // moved out of the ruler, delete it.
            d->deletedTab = d->tabs.takeAt(d->currentIndex);
            d->currentIndex = -1;
            // was that a temporary added tab?
            if ( d->originalIndex == -1 )
                Q_EMIT guideLineCreated(d->orientation,
                        d->orientation == Qt::Horizontal
                        ? d->viewConverter->viewToDocumentY(ev->pos().y())
                        : d->viewConverter->viewToDocumentX(ev->pos().x()));
        }
 
        d->emitTabChanged();
        break;
    case KoRulerPrivate::HotSpot:
        qreal newPos;
        if (d->orientation == Qt::Horizontal)
            newPos= d->viewConverter->viewToDocumentX(pos.x() - d->offset);
        else
            newPos= d->viewConverter->viewToDocumentY(pos.y() - d->offset);
        d->hotspots[d->currentIndex].position = newPos;
        Q_EMIT hotSpotChanged(d->hotspots[d->currentIndex].id, newPos);
        break;
    case KoRulerPrivate::None:
        d->mouseCoordinate = (d->orientation == Qt::Horizontal ?  pos.x() : pos.y()) - d->offset;
        int hotSpotIndex = d->hotSpotIndex(pos);
        if (hotSpotIndex >= 0) {
            setCursor(QCursor( d->orientation == Qt::Horizontal ? Qt::SplitHCursor : Qt::SplitVCursor ));
            break;
        }
        unsetCursor();
 
        KoRulerPrivate::Selection selection = d->selectionAtPosition(pos);
        QString text;
        switch(selection) {
        case KoRulerPrivate::FirstLineIndent: text = i18n("First line indent"); break;
        case KoRulerPrivate::ParagraphIndent: text = i18n("Left indent"); break;
        case KoRulerPrivate::EndIndent: text = i18n("Right indent"); break;
        case KoRulerPrivate::None:
            if (ev->buttons() & Qt::LeftButton) {
                if (d->orientation == Qt::Horizontal && ev->pos().y() > height() + OutsideRulerThreshold)
                    Q_EMIT guideLineCreated(d->orientation, d->viewConverter->viewToDocumentY(ev->pos().y()));
                else if (d->orientation == Qt::Vertical && ev->pos().x() > width() + OutsideRulerThreshold)
                    Q_EMIT guideLineCreated(d->orientation, d->viewConverter->viewToDocumentX(ev->pos().x()));
            }
            break;
        default:
            break;
        }
        setToolTip(text);
    }
    update();
}

References KoRulerPrivate::currentIndex, d, KoRulerPrivate::deletedTab, KoRulerPrivate::distancesPaintingStrategy, KoRulerPrivate::doSnapping(), KoRulerPrivate::effectiveActiveRangeEnd(), KoRulerPrivate::effectiveActiveRangeStart(), KoRulerPrivate::emitTabChanged(), KoRulerPrivate::endIndent, KoRulerPrivate::EndIndent, KoRulerPrivate::firstLineIndent, KoRulerPrivate::FirstLineIndent, guideCreationInProgress(), KoRulerPrivate::guideCreationStarted, guideLineCreated(), KoRulerPrivate::HotSpot, hotSpotChanged(), KoRulerPrivate::hotSpotIndex(), KoRulerPrivate::hotspots, indentsChanged(), KoRulerPrivate::mouseCoordinate, KoRulerPrivate::None, KoRulerPrivate::normalPaintingStrategy, KoRulerPrivate::offset, KoRulerPrivate::orientation, KoRulerPrivate::originalIndex, OutsideRulerThreshold, KoRulerPrivate::paintingStrategy, KoRulerPrivate::paragraphIndent, KoRulerPrivate::ParagraphIndent, KoRulerPrivate::rightToLeft, KoRulerPrivate::selected, KoRulerPrivate::selectionAtPosition(), KoRulerPrivate::selectOffset, KoRulerPrivate::Tab, KoRulerPrivate::tabMoved, KoRulerPrivate::tabs, KoRulerPrivate::viewConverter, KoViewConverter::viewToDocumentX(), and KoViewConverter::viewToDocumentY().

mousePressEvent()

void KoRuler::mousePressEvent ( QMouseEvent * ev )

overrideprotected

reimplemented

HACK ALERT: We don't need all that indentation stuff in Krita. Just ensure the rulers are created correctly.

Definition at line 1064 of file KoRuler.cpp.

{
    d->tabMoved = false;
    d->selected = KoRulerPrivate::None;
    if (ev->button() == Qt::RightButton && !d->popupActions.isEmpty())
        QMenu::exec(d->popupActions, ev->globalPos());
    if (ev->button() != Qt::LeftButton) {
        ev->ignore();
        return;
    }
 
    if (d->selected == KoRulerPrivate::None) {
        d->guideCreationStarted = true;
        return;
    }
 
    QPoint pos = ev->pos();
 
    if (d->showTabs) {
        int i = 0;
        int x;
        foreach (const Tab & t, d->tabs) {
            if (d->rightToLeft) {
                x = d->viewConverter->documentToViewX(d->effectiveActiveRangeEnd()
                        - (d->relativeTabs ? d->paragraphIndent : 0) - t.position) + d->offset;
            } else {
                x = d->viewConverter->documentToViewX(d->effectiveActiveRangeStart()
                        + (d->relativeTabs ? d->paragraphIndent : 0) + t.position) + d->offset;
            }
            if (pos.x() >= x-6 && pos.x() <= x+6) {
                d->selected = KoRulerPrivate::Tab;
                d->selectOffset = x - pos.x();
                d->currentIndex = i;
                break;
            }
            i++;
        }
        d->originalIndex = d->currentIndex;
    }
 
    if (d->selected == KoRulerPrivate::None)
        d->selected = d->selectionAtPosition(ev->pos(), &d->selectOffset);
    if (d->selected == KoRulerPrivate::None) {
        int hotSpotIndex = d->hotSpotIndex(ev->pos());
        if (hotSpotIndex >= 0) {
            d->selected = KoRulerPrivate::HotSpot;
            update();
        }
    }
 
    if (d->showTabs && d->selected == KoRulerPrivate::None) {
        // still haven't found something so let assume the user wants to add a tab
        qreal tabpos;
        if (d->rightToLeft) {
            tabpos = d->viewConverter->viewToDocumentX(pos.x() - d->offset)
                    + d->effectiveActiveRangeEnd() + (d->relativeTabs ? d->paragraphIndent : 0);
        } else {
            tabpos = d->viewConverter->viewToDocumentX(pos.x() - d->offset)
                    - d->effectiveActiveRangeStart() - (d->relativeTabs ? d->paragraphIndent : 0);
        }
        Tab t = {tabpos, d->tabChooser ?  d->tabChooser->type() :
                         d->rightToLeft ? QTextOption::RightTab :
                                          QTextOption::LeftTab};
        d->tabs.append(t);
        d->selectOffset = 0;
        d->selected = KoRulerPrivate::Tab;
        d->currentIndex = d->tabs.count() - 1;
        d->originalIndex = -1; // new!
        update();
    }
    if (d->orientation == Qt::Horizontal && (ev->modifiers() & Qt::ShiftModifier) &&
            (d->selected == KoRulerPrivate::FirstLineIndent ||
             d->selected == KoRulerPrivate::ParagraphIndent ||
             d->selected == KoRulerPrivate::Tab ||
             d->selected == KoRulerPrivate::EndIndent))
        d->paintingStrategy = d->distancesPaintingStrategy;
 
    if (d->selected != KoRulerPrivate::None)
        Q_EMIT aboutToChange();
}

References aboutToChange(), KoRulerPrivate::currentIndex, d, KoRulerPrivate::distancesPaintingStrategy, KoViewConverter::documentToViewX(), KoRulerPrivate::effectiveActiveRangeEnd(), KoRulerPrivate::effectiveActiveRangeStart(), KoRulerPrivate::EndIndent, KoRulerPrivate::FirstLineIndent, KoRulerPrivate::guideCreationStarted, KoRulerPrivate::HotSpot, KoRulerPrivate::hotSpotIndex(), KoRulerPrivate::None, KoRulerPrivate::offset, KoRulerPrivate::orientation, KoRulerPrivate::originalIndex, KoRulerPrivate::paintingStrategy, KoRulerPrivate::paragraphIndent, KoRulerPrivate::ParagraphIndent, KoRulerPrivate::popupActions, KoRuler::Tab::position, KoRulerPrivate::relativeTabs, KoRulerPrivate::rightToLeft, KoRulerPrivate::selected, KoRulerPrivate::selectionAtPosition(), KoRulerPrivate::selectOffset, KoRulerPrivate::showTabs, KoRulerPrivate::Tab, KoRulerPrivate::tabChooser, KoRulerPrivate::tabMoved, KoRulerPrivate::tabs, RulerTabChooser::type(), KoRulerPrivate::viewConverter, and KoViewConverter::viewToDocumentX().

mouseReleaseEvent()

void KoRuler::mouseReleaseEvent ( QMouseEvent * ev )

overrideprotected

reimplemented

Definition at line 1149 of file KoRuler.cpp.

{
    ev->accept();
    if (d->selected == KoRulerPrivate::None && d->guideCreationStarted) {
        d->guideCreationStarted = false;
        Q_EMIT guideCreationFinished(d->orientation, ev->globalPos());
    } else if (d->selected == KoRulerPrivate::Tab) {
        if (d->originalIndex >= 0 && !d->tabMoved) {
            int type = d->tabs[d->currentIndex].type;
            type++;
            if (type > 3)
                type = 0;
            d->tabs[d->currentIndex].type = static_cast<QTextOption::TabType> (type);
            update();
        }
        d->emitTabChanged();
    }
    else if( d->selected != KoRulerPrivate::None)
        Q_EMIT indentsChanged(true);
    else
        ev->ignore();
 
    d->paintingStrategy = d->normalPaintingStrategy;
    d->selected = KoRulerPrivate::None;
}

References KoRulerPrivate::currentIndex, d, KoRulerPrivate::emitTabChanged(), guideCreationFinished(), KoRulerPrivate::guideCreationStarted, indentsChanged(), KoRulerPrivate::None, KoRulerPrivate::normalPaintingStrategy, KoRulerPrivate::orientation, KoRulerPrivate::originalIndex, KoRulerPrivate::paintingStrategy, KoRulerPrivate::selected, KoRulerPrivate::Tab, KoRulerPrivate::tabMoved, and KoRulerPrivate::tabs.

orientation()

Qt::Orientation KoRuler::orientation

(

)

const

The orientation of the ruler.

Definition at line 854 of file KoRuler.cpp.

{
    return d->orientation;
}

References d, and KoRulerPrivate::orientation.

paintEvent()

void KoRuler::paintEvent ( QPaintEvent * event )

overrideprotected

reimplemented

Definition at line 871 of file KoRuler.cpp.

{
    QPainter painter(this);
 
    painter.setClipRegion(event->region());
 
    painter.save();
    // Add subtle shade to entire widget to separate from neighbors..
    painter.fillRect(rect(), QColor(0, 0, 0, 24));
 
    QRectF rectangle = d->paintingStrategy->drawBackground(d, painter);
    painter.restore();
 
    painter.save();
    d->paintingStrategy->drawMeasurements(d, painter, rectangle);
    painter.restore();
 
    if (d->showIndents) {
        painter.save();
        d->paintingStrategy->drawIndents(d, painter);
        painter.restore();
    }
 
    d->paintingStrategy->drawTabs(d, painter);
}

References d, PaintingStrategy::drawBackground(), PaintingStrategy::drawIndents(), PaintingStrategy::drawMeasurements(), PaintingStrategy::drawTabs(), KoRulerPrivate::paintingStrategy, and KoRulerPrivate::showIndents.

paragraphIndent()

qreal KoRuler::paragraphIndent

(

)

const

The start indent of the rest of the lines.

Definition at line 981 of file KoRuler.cpp.

{
    return d->paragraphIndent;
}

References d, and KoRulerPrivate::paragraphIndent.

popupActionList()

QList< QAction * > KoRuler::popupActionList

(

)

const

Return the actions list.

See also

setPopupActionList()

Definition at line 1059 of file KoRuler.cpp.

{
    return d->popupActions;
}

References d, and KoRulerPrivate::popupActions.

removeHotSpot

bool KoRuler::removeHotSpot ( int id )

slot

Remove a previously set hotspot, returning true if one is actually returned.

Parameters

id	the unique id for the hotspot. A hotspot is a position on the ruler that the user can manipulate by dragging.

Definition at line 1346 of file KoRuler.cpp.

{
    QList<KoRulerPrivate::HotSpotData>::Iterator iter = d->hotspots.begin();
    while(iter != d->hotspots.end()) {
        if (iter->id == id) {
            d->hotspots.erase(iter);
            update();
            return true;
        }
    }
    return false;
}

References d, and KoRulerPrivate::hotspots.

rulerLength()

qreal KoRuler::rulerLength

(

)

const

The length of the ruler in points (pt)

Definition at line 849 of file KoRuler.cpp.

{
    return d->rulerLength;
}

References d, and KoRulerPrivate::rulerLength.

setActiveRange

void KoRuler::setActiveRange ( qreal start, qreal end )

slot

Set the active range, ie the part of the ruler that is most likely used. set to 0, 0 when there is no longer any active range

Parameters

start	the start of the range in pt
end	the end of the range in pt

Definition at line 907 of file KoRuler.cpp.

{
    d->activeRangeStart = start;
    d->activeRangeEnd = end;
    update();
}

References KoRulerPrivate::activeRangeEnd, KoRulerPrivate::activeRangeStart, and d.

setEndIndent

void KoRuler::setEndIndent ( qreal indent )

slot

Set the position of the end indent relative to the active range. If Right To left is set the indent is relative to the left side of the active range .

Parameters

indent

the value relative to the active range.

Definition at line 968 of file KoRuler.cpp.

{
    d->endIndent = indent;
    if (d->showIndents) {
        update();
    }
}

References d, KoRulerPrivate::endIndent, and KoRulerPrivate::showIndents.

setFirstLineIndent

void KoRuler::setFirstLineIndent ( qreal indent )

slot

Set the position of the first line start indent relative to the active range. If Right To left is set the indent is relative to the right side of the active range .

Parameters

indent

the value relative to the active range.

Definition at line 952 of file KoRuler.cpp.

{
    d->firstLineIndent = indent;
    if (d->showIndents) {
        update();
    }
}

References d, KoRulerPrivate::firstLineIndent, and KoRulerPrivate::showIndents.

setHotSpot

void KoRuler::setHotSpot ( qreal position, int id = -1 )

slot

Add or set a hotspot. A hotspot is a position on the ruler that the user can manipulate by dragging.

Parameters

position	the new position of the hotspot.
id	the unique id for the hotspot. If the id has not been set before, it will be added.

Definition at line 1328 of file KoRuler.cpp.

{
    uint hotspotCount = d->hotspots.count();
    for( uint i = 0; i < hotspotCount; ++i ) {
        KoRulerPrivate::HotSpotData & hs = d->hotspots[i];
        if (hs.id == id) {
            hs.position = position;
            update();
            return;
        }
    }
    // not there yet, then insert it.
    KoRulerPrivate::HotSpotData hs;
    hs.position = position;
    hs.id = id;
    d->hotspots.append(hs);
}

References d, KoRulerPrivate::hotspots, KoRulerPrivate::HotSpotData::id, and KoRulerPrivate::HotSpotData::position.

setOffset

void KoRuler::setOffset ( int offset )

slot

Set the offset. Use this function to sync the ruler with the canvas' position on screen

Parameters

offset

The offset in pixels

Definition at line 859 of file KoRuler.cpp.

{
    d->offset = offset;
    update();
}

References d, and KoRulerPrivate::offset.

setOverrideActiveRange

void KoRuler::setOverrideActiveRange ( qreal start, qreal end )

slot

Set the override active range, ie the part of the ruler that is most likely used. set to 0, 0 when there is no longer any active range The override, means that if set it takes precedence over the normal active range.

Parameters

start	the start of the range in pt
end	the end of the range in pt

Definition at line 914 of file KoRuler.cpp.

{
    d->activeOverrideRangeStart = start;
    d->activeOverrideRangeEnd = end;
    update();
}

References KoRulerPrivate::activeOverrideRangeEnd, KoRulerPrivate::activeOverrideRangeStart, and d.

setParagraphIndent

void KoRuler::setParagraphIndent ( qreal indent )

slot

Set the position of the rest of the lines start indent relative to the active range. If Right To left is set the indent is relative to the right side of the active range .

Parameters

indent

the value relative to the active range.

Definition at line 960 of file KoRuler.cpp.

{
    d->paragraphIndent = indent;
    if (d->showIndents) {
        update();
    }
}

References d, KoRulerPrivate::paragraphIndent, and KoRulerPrivate::showIndents.

setPopupActionList()

void KoRuler::setPopupActionList

(

const QList< QAction * > &

popupActionList

)

set a list of actions that will be shown in a popup should the user right click on this ruler.

Parameters

popupActionList

the list of actions

See also

popupActionList()

Definition at line 1054 of file KoRuler.cpp.

{
    d->popupActions = popupActionList;
}

References d, popupActionList(), and KoRulerPrivate::popupActions.

setRelativeTabs

void KoRuler::setRelativeTabs ( bool relative )

slot

Set whether the tabs is relative to the paragraph indent

Parameters

relative

tabs are relative to paragraph indent if true, default is false.

Definition at line 1029 of file KoRuler.cpp.

{
    d->relativeTabs = relative;
    if (d->showTabs) {
        update();
    }
}

References d, KoRulerPrivate::relativeTabs, and KoRulerPrivate::showTabs.

setRightToLeft

void KoRuler::setRightToLeft ( bool isRightToLeft )

slot

Set the state of the ruler so that it shows everything in right to left mode.

Parameters

isRightToLeft

state of right to left mode. Default is false.

Definition at line 940 of file KoRuler.cpp.

{
    d->rightToLeft = isRightToLeft;
    update();
}

References d, and KoRulerPrivate::rightToLeft.

setRulerLength

void KoRuler::setRulerLength ( qreal length )

slot

Sets the length of the ruler to length in points (pt)

Definition at line 865 of file KoRuler.cpp.

{
    d->rulerLength = length;
    update();
}

References d, length(), and KoRulerPrivate::rulerLength.

setShowIndents

void KoRuler::setShowIndents ( bool show )

slot

Set if the ruler should show indents as used in text editors. Set the indents with setFirstLineIndent(), setParagraphIndent(), setEndIndent() .

Parameters

show	show indents if true. Default is false.

Definition at line 946 of file KoRuler.cpp.

{
    d->showIndents = show;
    update();
}

References d, and KoRulerPrivate::showIndents.

setShowMousePosition

void KoRuler::setShowMousePosition ( bool show )

slot

Set whether the ruler should show the current mouse position. Update the position with updateMouseCoordinate().

Parameters

show	show mouse position if true. Default is false.

Definition at line 929 of file KoRuler.cpp.

{
    d->showMousePosition = show;
    update();
}

References d, and KoRulerPrivate::showMousePosition.

setShowSelectionBorders

void KoRuler::setShowSelectionBorders ( bool show )

slot

Set whether the ruler should show the selection borders

Parameters

show	show selection borders if true, default is false.

Definition at line 1001 of file KoRuler.cpp.

{
    d->showSelectionBorders = show;
    update();
}

References d, and KoRulerPrivate::showSelectionBorders.

setShowTabs

void KoRuler::setShowTabs ( bool show )

slot

Set whether the ruler should show tabs

Parameters

show	show selection borders if true, default is false.

Definition at line 1016 of file KoRuler.cpp.

{
    if (d->showTabs == show) {
        return;
    }
 
    d->showTabs = show;
    if (d->tabChooser) {
        d->tabChooser->setShowTabs(show);
    }
    update();
}

References d, RulerTabChooser::setShowTabs(), KoRulerPrivate::showTabs, and KoRulerPrivate::tabChooser.

setUnit

void KoRuler::setUnit ( const KoUnit & unit )

slot

Set the unit of the ruler.

Definition at line 843 of file KoRuler.cpp.

{
    d->unit = unit;
    update();
}

References d, unit(), and KoRulerPrivate::unit.

setUnitPixelMultiple2

void KoRuler::setUnitPixelMultiple2 ( bool enabled )

slot

Definition at line 1368 of file KoRuler.cpp.

{
    if (enabled) {
        d->pixelStep = 64.0;
    }
    else {
        d->pixelStep = 100.0;
    }
}

References d, and KoRulerPrivate::pixelStep.

showMousePosition

bool KoRuler::showMousePosition ( ) const

slot

See also

setShowMousePosition

Definition at line 935 of file KoRuler.cpp.

{
    return d->showMousePosition;
}

References d, and KoRulerPrivate::showMousePosition.

sizeHint()

QSize KoRuler::sizeHint ( ) const

override

reimplemented

Definition at line 902 of file KoRuler.cpp.

{
    return d->paintingStrategy->sizeHint();
}

References d, KoRulerPrivate::paintingStrategy, and PaintingStrategy::sizeHint().

tabChanged

void KoRuler::tabChanged ( int originalTabIndex, KoRuler::Tab * tab )

signal

Emitted when any of the tabs are moved, deleted or inserted by the user.

Parameters

originalTabIndex	the index in the list of tabs before the user interaction started, or -1 if this is a new tab
tab	the new tab, or zero when the tab has been removed.

tabChooser()

QWidget * KoRuler::tabChooser

(

)

The tab chooser widget, which you must put into a layout along with the ruler. Returns 0 for vertical rulers,

Definition at line 991 of file KoRuler.cpp.

{
    if ((d->tabChooser == 0) && (d->orientation == Qt::Horizontal)) {
        d->tabChooser = new RulerTabChooser(parentWidget());
        d->tabChooser->setShowTabs(d->showTabs);
    }
 
    return d->tabChooser;
}

References d, KoRulerPrivate::orientation, RulerTabChooser::setShowTabs(), KoRulerPrivate::showTabs, and KoRulerPrivate::tabChooser.

tabs

QList< KoRuler::Tab > KoRuler::tabs ( ) const

slot

Definition at line 1046 of file KoRuler.cpp.

{
    QList<Tab> answer = d->tabs;
    std::sort(answer.begin(), answer.end(), compareTabs);
 
    return answer;
}

References compareTabs, d, and KoRulerPrivate::tabs.

unit()

KoUnit KoRuler::unit

(

)

const

The ruler's unit.

Definition at line 838 of file KoRuler.cpp.

{
    return d->unit;
}

References d, and KoRulerPrivate::unit.

updateMouseCoordinate

void KoRuler::updateMouseCoordinate ( int coordinate )

slot

Update the current position of the mouse pointer, repainting if changed. The ruler offset will be applied before painting.

Parameters

coordinate

Either the x or y coordinate of the mouse depending of the orientation of the ruler.

Definition at line 921 of file KoRuler.cpp.

{
    if(d->mouseCoordinate == coordinate)
        return;
    d->mouseCoordinate = coordinate;
    update();
}

References d, and KoRulerPrivate::mouseCoordinate.

updateSelectionBorders

void KoRuler::updateSelectionBorders ( qreal first, qreal second )

slot

Update the selection borders

Parameters

first	the first selection border in points
second	the other selection border in points

Definition at line 1007 of file KoRuler.cpp.

{
    d->firstSelectionBorder = first;
    d->secondSelectionBorder = second;
 
    if(d->showSelectionBorders)
        update();
}

References d, KoRulerPrivate::firstSelectionBorder, KoRulerPrivate::secondSelectionBorder, and KoRulerPrivate::showSelectionBorders.

updateTabs

void KoRuler::updateTabs ( const QList< Tab > & tabs, qreal tabDistance )

slot

Update the tabs

Parameters

tabs	a list of tabs that is shown on the ruler
tabDistance	the distance between regular interval tabs

Definition at line 1037 of file KoRuler.cpp.

{
    d->tabs = tabs;
    d->tabDistance = tabDistance;
    if (d->showTabs) {
        update();
    }
}

References d, KoRulerPrivate::showTabs, KoRulerPrivate::tabDistance, tabs(), and KoRulerPrivate::tabs.

Friends And Related Symbol Documentation

KoRulerPrivate

friend class KoRulerPrivate

friend

Definition at line 269 of file KoRuler.h.

Member Data Documentation

d

KoRulerPrivate* const KoRuler::d

private

Definition at line 268 of file KoRuler.h.

---

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

• libs/widgets/KoRuler.h
• libs/widgets/KoRuler.cpp