#include <KoRuler_p.h>

Classes
struct	HotSpotData

Public Types
enum	Selection { None , Tab , FirstLineIndent , ParagraphIndent , EndIndent , HotSpot }

Public Member Functions
qreal	doSnapping (const qreal value) const

qreal	effectiveActiveRangeEnd () const

qreal	effectiveActiveRangeStart () const

void	emitTabChanged ()

int	hotSpotIndex (const QPoint &pos)

	KoRulerPrivate (KoRuler parent, const KoViewConverter vc, Qt::Orientation orientation)

qreal	numberStepForUnit () const

Selection	selectionAtPosition (const QPoint &pos, int *selectOffset=0)

	~KoRulerPrivate ()

Public Attributes
qreal	activeOverrideRangeEnd {0.0}

qreal	activeOverrideRangeStart {0.0}

qreal	activeRangeEnd {0.0}

qreal	activeRangeStart {0.0}

int	currentIndex {0}

KoRuler::Tab	deletedTab

PaintingStrategy *	distancesPaintingStrategy {0}

qreal	endIndent {0.0}

qreal	firstLineIndent {0.0}

qreal	firstSelectionBorder {0.0}

bool	guideCreationStarted {false}

QList< HotSpotData >	hotspots

int	mouseCoordinate {0}

PaintingStrategy *	normalPaintingStrategy {0}

int	offset { 0 }

const Qt::Orientation	orientation

int	originalIndex {0}

PaintingStrategy *	paintingStrategy {0}

qreal	paragraphIndent {0.0}

qreal	pixelStep {0.0}

QList< QAction * >	popupActions

bool	relativeTabs {false}

bool	rightToLeft {false}

KoRuler *	ruler {0}

qreal	rulerLength {0.0}

qreal	secondSelectionBorder {0.0}

Selection	selected {None}

int	selectOffset {0}

bool	showIndents {false}

int	showMousePosition {0}

bool	showSelectionBorders {false}

bool	showTabs {false}

RulerTabChooser *	tabChooser {0}

qreal	tabDistance {0.0}

bool	tabMoved {false}

QList< KoRuler::Tab >	tabs

KoUnit	unit

const KoViewConverter *const	viewConverter

Friends
class	HorizontalPaintingStrategy

class	VerticalPaintingStrategy

Detailed Description

Definition at line 112 of file KoRuler_p.h.

Member Enumeration Documentation

◆ Selection

enum KoRulerPrivate::Selection

Enumerator
None
Tab
FirstLineIndent
ParagraphIndent
EndIndent
HotSpot

Definition at line 159 of file KoRuler_p.h.

                   {
        None,
        Tab,
        FirstLineIndent,
        ParagraphIndent,
        EndIndent,
        HotSpot
    };

Constructor & Destructor Documentation

◆ KoRulerPrivate()

KoRulerPrivate::KoRulerPrivate	(	KoRuler *	parent,
		const KoViewConverter *	vc,
		Qt::Orientation	orientation )

Definition at line 666 of file KoRuler.cpp.

    : unit(KoUnit(KoUnit::Point)),
    orientation(o),
    viewConverter(vc),
    offset(0),
    rulerLength(0),
    activeRangeStart(0),
    activeRangeEnd(0),
    activeOverrideRangeStart(0),
    activeOverrideRangeEnd(0),
    mouseCoordinate(-1),
    showMousePosition(0),
    showSelectionBorders(false),
    firstSelectionBorder(0),
    secondSelectionBorder(0),
    showIndents(false),
    firstLineIndent(0),
    paragraphIndent(0),
    endIndent(0),
    showTabs(false),
    relativeTabs(false),
    tabMoved(false),
    originalIndex(-1),
    currentIndex(0),
    rightToLeft(false),
    selected(None),
    selectOffset(0),
    tabChooser(0),
    normalPaintingStrategy(o == Qt::Horizontal ?
            (PaintingStrategy*)new HorizontalPaintingStrategy() : (PaintingStrategy*)new VerticalPaintingStrategy()),
    distancesPaintingStrategy((PaintingStrategy*)new HorizontalDistancesPaintingStrategy()),
    paintingStrategy(normalPaintingStrategy),
    ruler(parent),
    guideCreationStarted(false),
    pixelStep(100.0)
{
}

◆ ~KoRulerPrivate()

KoRulerPrivate::~KoRulerPrivate ( )

Definition at line 704 of file KoRuler.cpp.

{
    delete normalPaintingStrategy;
    delete distancesPaintingStrategy;
}

References distancesPaintingStrategy, and normalPaintingStrategy.

Member Function Documentation

◆ doSnapping()

qreal KoRulerPrivate::doSnapping ( const qreal value ) const

Returns: The rounding of value to the nearest multiple of stepValue

Definition at line 727 of file KoRuler.cpp.

{
    qreal numberStep = unit.fromUserValue(numberStepForUnit()/4.0);
    return numberStep * qRound(value / numberStep);
}

References KoUnit::fromUserValue(), numberStepForUnit(), unit, and value().

◆ effectiveActiveRangeEnd()

qreal KoRulerPrivate::effectiveActiveRangeEnd ( ) const

Definition at line 808 of file KoRuler.cpp.

{
    if (activeOverrideRangeStart != activeOverrideRangeEnd) {
        return activeOverrideRangeEnd;
    } else {
        return activeRangeEnd;
    }
}

References activeOverrideRangeEnd, activeOverrideRangeStart, and activeRangeEnd.

◆ effectiveActiveRangeStart()

qreal KoRulerPrivate::effectiveActiveRangeStart ( ) const

Definition at line 799 of file KoRuler.cpp.

{
    if (activeOverrideRangeStart != activeOverrideRangeEnd) {
        return activeOverrideRangeStart;
    } else {
        return activeRangeStart;
    }
}

References activeOverrideRangeEnd, activeOverrideRangeStart, and activeRangeStart.

◆ emitTabChanged()

void KoRulerPrivate::emitTabChanged ( )

Definition at line 817 of file KoRuler.cpp.

{
    KoRuler::Tab tab;
    if (currentIndex >= 0)
        tab = tabs[currentIndex];
    Q_EMIT ruler->tabChanged(originalIndex, currentIndex >= 0 ? &tab : 0);
}

References currentIndex, originalIndex, ruler, KoRuler::tabChanged(), and tabs.

◆ hotSpotIndex()

int KoRulerPrivate::hotSpotIndex ( const QPoint & pos )

Definition at line 784 of file KoRuler.cpp.

{
    for(int counter = 0; counter < hotspots.count(); counter++) {
        bool hit;
        if (orientation == Qt::Horizontal)
            hit = qAbs(viewConverter->documentToViewX(hotspots[counter].position) - pos.x() + offset) < 3;
        else
            hit = qAbs(viewConverter->documentToViewY(hotspots[counter].position) - pos.y() + offset) < 3;
 
        if (hit)
            return counter;
    }
    return -1;
}

References KoViewConverter::documentToViewX(), KoViewConverter::documentToViewY(), hotspots, offset, orientation, and viewConverter.

◆ numberStepForUnit()

qreal KoRulerPrivate::numberStepForUnit ( ) const

Definition at line 710 of file KoRuler.cpp.

{
    switch(unit.type()) {
        case KoUnit::Inch:
        case KoUnit::Centimeter:
        case KoUnit::Decimeter:
        case KoUnit::Millimeter:
            return 1.0;
        case KoUnit::Pica:
        case KoUnit::Cicero:
            return 10.0;
        case KoUnit::Point:
        default:
            return pixelStep;
    }
}

References KoUnit::Centimeter, KoUnit::Cicero, KoUnit::Decimeter, KoUnit::Inch, KoUnit::Millimeter, KoUnit::Pica, pixelStep, KoUnit::Point, KoUnit::type(), and unit.

◆ selectionAtPosition()

KoRulerPrivate::Selection KoRulerPrivate::selectionAtPosition	(	const QPoint &	pos,
		int *	selectOffset = 0 )

Definition at line 733 of file KoRuler.cpp.

{
    const int height = ruler->height();
    if (rightToLeft) {
        int x = int(viewConverter->documentToViewX(effectiveActiveRangeEnd() - firstLineIndent - paragraphIndent) + offset);
        if (pos.x() >= x - 8 && pos.x() <= x +8 && pos.y() < height / 2) {
            if (selectOffset)
                *selectOffset = x - pos.x();
            return KoRulerPrivate::FirstLineIndent;
        }
 
        x = int(viewConverter->documentToViewX(effectiveActiveRangeEnd() - paragraphIndent) + offset);
        if (pos.x() >= x - 8 && pos.x() <= x +8 && pos.y() > height / 2) {
            if (selectOffset)
                *selectOffset = x - pos.x();
            return KoRulerPrivate::ParagraphIndent;
        }
 
        x = int(viewConverter->documentToViewX(effectiveActiveRangeStart() + endIndent) + offset);
        if (pos.x() >= x - 8 && pos.x() <= x + 8) {
            if (selectOffset)
                *selectOffset = x - pos.x();
            return KoRulerPrivate::EndIndent;
        }
    }
    else {
        int x = int(viewConverter->documentToViewX(effectiveActiveRangeStart() + firstLineIndent + paragraphIndent) + offset);
        if (pos.x() >= x -8 && pos.x() <= x + 8 && pos.y() < height / 2) {
            if (selectOffset)
                *selectOffset = x - pos.x();
            return KoRulerPrivate::FirstLineIndent;
        }
 
        x = int(viewConverter->documentToViewX(effectiveActiveRangeStart() + paragraphIndent) + offset);
        if (pos.x() >= x - 8 && pos.x() <= x + 8 && pos.y() > height/2) {
            if (selectOffset)
                *selectOffset = x - pos.x();
            return KoRulerPrivate::ParagraphIndent;
        }
 
        x = int(viewConverter->documentToViewX(effectiveActiveRangeEnd() - endIndent) + offset);
        if (pos.x() >= x - 8 && pos.x() <= x + 8) {
            if (selectOffset)
                *selectOffset = x - pos.x();
            return KoRulerPrivate::EndIndent;
        }
    }
 
    return KoRulerPrivate::None;
}

References KoViewConverter::documentToViewX(), effectiveActiveRangeEnd(), effectiveActiveRangeStart(), endIndent, EndIndent, firstLineIndent, FirstLineIndent, None, offset, paragraphIndent, ParagraphIndent, rightToLeft, ruler, selectOffset, and viewConverter.

Friends And Related Symbol Documentation

◆ HorizontalPaintingStrategy

friend class HorizontalPaintingStrategy

friend

Definition at line 196 of file KoRuler_p.h.

◆ VerticalPaintingStrategy

friend class VerticalPaintingStrategy

friend

Definition at line 195 of file KoRuler_p.h.

Member Data Documentation

◆ activeOverrideRangeEnd

qreal KoRulerPrivate::activeOverrideRangeEnd {0.0}

Definition at line 129 of file KoRuler_p.h.

129{0.0};

◆ activeOverrideRangeStart

qreal KoRulerPrivate::activeOverrideRangeStart {0.0}

Definition at line 128 of file KoRuler_p.h.

128{0.0};

◆ activeRangeEnd

qreal KoRulerPrivate::activeRangeEnd {0.0}

Definition at line 127 of file KoRuler_p.h.

127{0.0};

◆ activeRangeStart

qreal KoRulerPrivate::activeRangeStart {0.0}

Definition at line 126 of file KoRuler_p.h.

126{0.0};

◆ currentIndex

int KoRulerPrivate::currentIndex {0}

Definition at line 148 of file KoRuler_p.h.

148{0}; //index of selected tab or selected HotSpot - only valid when selected indicates tab or hotspot

◆ deletedTab

KoRuler::Tab KoRulerPrivate::deletedTab

Definition at line 149 of file KoRuler_p.h.

◆ distancesPaintingStrategy

PaintingStrategy* KoRulerPrivate::distancesPaintingStrategy {0}

Definition at line 176 of file KoRuler_p.h.

176{0};

◆ endIndent

qreal KoRulerPrivate::endIndent {0.0}

Definition at line 141 of file KoRuler_p.h.

141{0.0};

◆ firstLineIndent

qreal KoRulerPrivate::firstLineIndent {0.0}

Definition at line 139 of file KoRuler_p.h.

139{0.0};

◆ firstSelectionBorder

qreal KoRulerPrivate::firstSelectionBorder {0.0}

Definition at line 135 of file KoRuler_p.h.

135{0.0};

◆ guideCreationStarted

bool KoRulerPrivate::guideCreationStarted {false}

Definition at line 183 of file KoRuler_p.h.

183{false};

◆ hotspots

QList<HotSpotData> KoRulerPrivate::hotspots

Definition at line 156 of file KoRuler_p.h.

◆ mouseCoordinate

int KoRulerPrivate::mouseCoordinate {0}

Definition at line 131 of file KoRuler_p.h.

131{0};

◆ normalPaintingStrategy

PaintingStrategy* KoRulerPrivate::normalPaintingStrategy {0}

Definition at line 175 of file KoRuler_p.h.

175{0};

◆ offset

int KoRulerPrivate::offset { 0 }

Definition at line 124 of file KoRuler_p.h.

124{ 0 };

◆ orientation

const Qt::Orientation KoRulerPrivate::orientation

Definition at line 121 of file KoRuler_p.h.

◆ originalIndex

int KoRulerPrivate::originalIndex {0}

Definition at line 147 of file KoRuler_p.h.

147{0}; //index of selected tab before we started dragging it.

◆ paintingStrategy

PaintingStrategy* KoRulerPrivate::paintingStrategy {0}

Definition at line 179 of file KoRuler_p.h.

179{0};

◆ paragraphIndent

qreal KoRulerPrivate::paragraphIndent {0.0}

Definition at line 140 of file KoRuler_p.h.

140{0.0};

◆ pixelStep

qreal KoRulerPrivate::pixelStep {0.0}

Definition at line 185 of file KoRuler_p.h.

185{0.0};

◆ popupActions

QList<QAction*> KoRulerPrivate::popupActions

Definition at line 170 of file KoRuler_p.h.

◆ relativeTabs

bool KoRulerPrivate::relativeTabs {false}

Definition at line 144 of file KoRuler_p.h.

144{false};

◆ rightToLeft

bool KoRulerPrivate::rightToLeft {false}

Definition at line 158 of file KoRuler_p.h.

158{false};

◆ ruler

KoRuler* KoRulerPrivate::ruler {0}

Definition at line 181 of file KoRuler_p.h.

181{0};

◆ rulerLength

qreal KoRulerPrivate::rulerLength {0.0}

Definition at line 125 of file KoRuler_p.h.

125{0.0};

◆ secondSelectionBorder

qreal KoRulerPrivate::secondSelectionBorder {0.0}

Definition at line 136 of file KoRuler_p.h.

136{0.0};

◆ selected

Selection KoRulerPrivate::selected {None}

Definition at line 167 of file KoRuler_p.h.

167{None};

◆ selectOffset

int KoRulerPrivate::selectOffset {0}

Definition at line 168 of file KoRuler_p.h.

168{0};

◆ showIndents

bool KoRulerPrivate::showIndents {false}

Definition at line 138 of file KoRuler_p.h.

138{false};

◆ showMousePosition

int KoRulerPrivate::showMousePosition {0}

Definition at line 132 of file KoRuler_p.h.

132{0};

◆ showSelectionBorders

bool KoRulerPrivate::showSelectionBorders {false}

Definition at line 134 of file KoRuler_p.h.

134{false};

◆ showTabs

bool KoRulerPrivate::showTabs {false}

Definition at line 143 of file KoRuler_p.h.

143{false};

◆ tabChooser

RulerTabChooser* KoRulerPrivate::tabChooser {0}

Definition at line 172 of file KoRuler_p.h.

172{0};

◆ tabDistance

qreal KoRulerPrivate::tabDistance {0.0}

Definition at line 150 of file KoRuler_p.h.

150{0.0};

◆ tabMoved

bool KoRulerPrivate::tabMoved {false}

Definition at line 145 of file KoRuler_p.h.

145{false}; // set to true on first move of a selected tab

◆ tabs

QList<KoRuler::Tab> KoRulerPrivate::tabs

Definition at line 146 of file KoRuler_p.h.

◆ unit

KoUnit KoRulerPrivate::unit

Definition at line 120 of file KoRuler_p.h.

◆ viewConverter

const KoViewConverter* const KoRulerPrivate::viewConverter

Definition at line 122 of file KoRuler_p.h.

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

libs/widgets/KoRuler_p.h
libs/widgets/KoRuler.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Friends