KisGuidesManager::Private Struct Reference

Public Types
typedef QPair< Qt::Orientation, int >	GuideHandle

Public Member Functions
QPointF	alignToPixels (const QPointF docPoint)
QAction *	createShortenedAction (const QString &text, const QString &parentId, QObject *parent)
void	createUndoCommandIfNeeded ()
void	deleteGuide (const GuideHandle &h)
GuideHandle	findGuide (const QPointF &docPos)
Qt::MouseButton	getButtonFromEvent (QEvent *event)
QPointF	getDocPointFromEvent (QEvent *event)
qreal	guideValue (const GuideHandle &h)
void	initDragStart (const GuideHandle &guide, const QPointF &dragStart, qreal guideValue, bool snapToStart)
bool	isGuideValid (const GuideHandle &h)
bool	mouseMoveHandler (const QPointF &docPos, Qt::KeyboardModifiers modifiers)
bool	mouseReleaseHandler (const QPointF &docPos)
bool	needsUndoCommand ()
	Private (KisGuidesManager *_q)
void	setGuideValue (const GuideHandle &h, qreal value)
void	syncAction (const QString &actionName, bool value)
bool	updateCursor (const QPointF &docPos, bool forceDisableCursor=false)
void	updateSnappingStatus (const KisGuidesConfig &value)

Public Attributes
GuideHandle	currentGuide
bool	cursorSwitched
KisGuidesDecoration *	decoration
QPointF	dragPointerOffset
QPointF	dragStartDoc
qreal	dragStartGuidePos
KisGuidesConfig	guidesConfig
const GuideHandle	invalidGuide
QCursor	oldCursor
KisGuidesConfig	oldGuidesConfig
KisGuidesManager *	q
bool	shouldSetModified
KisSnapConfig	snapConfig
QPointer< KisView >	view
KisSignalAutoConnectionsStore	viewConnections

Detailed Description

Definition at line 32 of file kis_guides_manager.cpp.

Member Typedef Documentation

GuideHandle

typedef QPair<Qt::Orientation, int> KisGuidesManager::Private::GuideHandle

Definition at line 51 of file kis_guides_manager.cpp.

Constructor & Destructor Documentation

Private()

KisGuidesManager::Private::Private ( KisGuidesManager * _q )

inline

Definition at line 34 of file kis_guides_manager.cpp.

        : q(_q),
          decoration(0),
          invalidGuide(Qt::Horizontal, -1),
          currentGuide(invalidGuide),
          cursorSwitched(false),
          dragStartGuidePos(0),
          shouldSetModified(false) {}

Member Function Documentation

alignToPixels()

QPointF KisGuidesManager::Private::alignToPixels

(

const QPointF

docPoint

)

Definition at line 519 of file kis_guides_manager.cpp.

{
    KisCanvas2 *canvas = view->canvasBase();
    const KisCoordinatesConverter *converter = canvas->coordinatesConverter();
    QPoint imagePoint = converter->documentToImage(docPoint).toPoint();
    return converter->imageToDocument(imagePoint);
}

References KisCanvas2::coordinatesConverter, KisCoordinatesConverter::documentToImage(), and KisCoordinatesConverter::imageToDocument().

createShortenedAction()

QAction * KisGuidesManager::Private::createShortenedAction	(	const QString &	text,
		const QString &	parentId,
		QObject *	parent )

Definition at line 755 of file kis_guides_manager.cpp.

{
    KisActionManager *actionManager = view->viewManager()->actionManager();
    QAction *action = 0;
    KisAction *parentAction = 0;
 
    action = new QAction(text, parent);
    action->setCheckable(true);
    parentAction = actionManager->actionByName(parentId);
    action->setChecked(parentAction->isChecked());
    connect(action, SIGNAL(toggled(bool)), parentAction, SLOT(setChecked(bool)));
 
    return action;
}

References KisActionManager::actionByName(), KisViewManager::actionManager(), connect(), and KisActionManager::viewManager.

createUndoCommandIfNeeded()

void KisGuidesManager::Private::createUndoCommandIfNeeded

(

)

Definition at line 190 of file kis_guides_manager.cpp.

{
    KisDocument *doc = view ? view->document() : 0;
    if (doc && needsUndoCommand()) {
        KUndo2Command *cmd = new KisChangeGuidesCommand(doc, oldGuidesConfig, guidesConfig);
        view->canvasBase()->addCommand(cmd);
    }
}

deleteGuide()

void KisGuidesManager::Private::deleteGuide

(

const GuideHandle &

h

)

Definition at line 457 of file kis_guides_manager.cpp.

{
    if (h.first == Qt::Horizontal) {
        QList<qreal> guides = guidesConfig.horizontalGuideLines();
        guides.removeAt(h.second);
        guidesConfig.setHorizontalGuideLines(guides);
    } else {
        QList<qreal> guides = guidesConfig.verticalGuideLines();
        guides.removeAt(h.second);
        guidesConfig.setVerticalGuideLines(guides);
    }
}

findGuide()

KisGuidesManager::Private::GuideHandle KisGuidesManager::Private::findGuide

(

const QPointF &

docPos

)

Definition at line 399 of file kis_guides_manager.cpp.

{
    const int snapRadius = 16;
    const KoViewConverter *converter = view->canvasBase()->viewConverter();
    const QPointF docPosView = converter->documentToView(docPos);
 
    GuideHandle nearestGuide = invalidGuide;
    qreal nearestRadius = std::numeric_limits<int>::max();
 
 
    for (int i = 0; i < guidesConfig.horizontalGuideLines().size(); i++) {
        const QPointF guideCoord = {0, guidesConfig.horizontalGuideLines()[i]};
        const qreal guide = converter->documentToView(guideCoord).y();
        const qreal radius = qAbs(docPosView.y() - guide);
        if (radius < snapRadius && radius < nearestRadius) {
            nearestGuide = GuideHandle(Qt::Horizontal, i);
            nearestRadius = radius;
        }
    }
 
    for (int i = 0; i < guidesConfig.verticalGuideLines().size(); i++) {
        const QPointF guideCoord = {guidesConfig.verticalGuideLines()[i], 0};
        const qreal guide = converter->documentToView(guideCoord).x();
        const qreal radius = qAbs(docPosView.x() - guide);
        if (radius < snapRadius && radius < nearestRadius) {
            nearestGuide = GuideHandle(Qt::Vertical, i);
            nearestRadius = radius;
        }
    }
 
    return nearestGuide;
}

References KoViewConverter::documentToView().

getButtonFromEvent()

Qt::MouseButton KisGuidesManager::Private::getButtonFromEvent

(

QEvent *

event

)

Definition at line 629 of file kis_guides_manager.cpp.

{
    Qt::MouseButton button = Qt::NoButton;
 
    if (event->type() == QEvent::MouseMove ||
        event->type() == QEvent::MouseButtonPress ||
        event->type() == QEvent::MouseButtonRelease) {
 
        QMouseEvent *mouseEvent = static_cast<QMouseEvent*>(event);
        button = mouseEvent->button();
 
    } else if (event->type() == QEvent::TabletMove ||
               event->type() == QEvent::TabletPress ||
               event->type() == QEvent::TabletRelease) {
 
        QTabletEvent *tabletEvent = static_cast<QTabletEvent*>(event);
        button = tabletEvent->button();
    }
 
    return button;
}

References button().

getDocPointFromEvent()

QPointF KisGuidesManager::Private::getDocPointFromEvent

(

QEvent *

event

)

Definition at line 597 of file kis_guides_manager.cpp.

{
    QPointF result;
 
    KisCanvas2 *canvas = view->canvasBase();
    const KisCoordinatesConverter *converter = canvas->coordinatesConverter();
 
    if (event->type() == QEvent::Enter) {
        QEnterEvent *enterEvent = static_cast<QEnterEvent*>(event);
        result = alignToPixels(converter->widgetToDocument(enterEvent->pos()));
    } else if (event->type() == QEvent::MouseMove ||
        event->type() == QEvent::MouseButtonPress ||
        event->type() == QEvent::MouseButtonRelease) {
 
        QMouseEvent *mouseEvent = static_cast<QMouseEvent*>(event);
        result = alignToPixels(converter->widgetToDocument(mouseEvent->pos()));
 
    } else if (event->type() == QEvent::TabletMove ||
               event->type() == QEvent::TabletPress ||
               event->type() == QEvent::TabletRelease) {
 
        QTabletEvent *tabletEvent = static_cast<QTabletEvent*>(event);
        result = alignToPixels(converter->widgetToDocument(tabletEvent->pos()));
    } else {
        // we shouldn't silently return QPointF(0,0), higher level code may
        // snap to some unexpected guide
        KIS_SAFE_ASSERT_RECOVER_NOOP(0 && "event type is not supported!");
    }
 
    return result;
}

References KisCanvas2::coordinatesConverter, KIS_SAFE_ASSERT_RECOVER_NOOP, and KisCoordinatesConverter::widgetToDocument().

guideValue()

qreal KisGuidesManager::Private::guideValue

(

const GuideHandle &

h

)

Definition at line 437 of file kis_guides_manager.cpp.

{
    return h.first == Qt::Horizontal ?
        guidesConfig.horizontalGuideLines()[h.second] :
        guidesConfig.verticalGuideLines()[h.second];
}

initDragStart()

void KisGuidesManager::Private::initDragStart	(	const GuideHandle &	guide,
		const QPointF &	dragStart,
		qreal	guideValue,
		bool	snapToStart )

Definition at line 496 of file kis_guides_manager.cpp.

{
    currentGuide = guide;
    dragStartDoc = dragStart;
    dragStartGuidePos = guideValue;
    dragPointerOffset =
        guide.first == Qt::Horizontal ?
        QPointF(0, dragStartGuidePos - dragStartDoc.y()) :
        QPointF(dragStartGuidePos - dragStartDoc.x(), 0);
 
    KoSnapGuide *snapGuide = view->canvasBase()->snapGuide();
    snapGuide->reset();
 
    if (snapToStart) {
        KisSnapLineStrategy *strategy = new KisSnapLineStrategy();
        strategy->addLine(guide.first, guideValue);
        snapGuide->addCustomSnapStrategy(strategy);
    }
}

References KoSnapGuide::addCustomSnapStrategy(), KisSnapLineStrategy::addLine(), and KoSnapGuide::reset().

isGuideValid()

bool KisGuidesManager::Private::isGuideValid

(

const GuideHandle &

h

)

Definition at line 432 of file kis_guides_manager.cpp.

{
    return h.second >= 0;
}

mouseMoveHandler()

bool KisGuidesManager::Private::mouseMoveHandler	(	const QPointF &	docPos,
		Qt::KeyboardModifiers	modifiers )

Definition at line 527 of file kis_guides_manager.cpp.

{
    if (isGuideValid(currentGuide)) {
        KoSnapGuide *snapGuide = view->canvasBase()->snapGuide();
        const QPointF snappedPos = snapGuide->snap(docPos, dragPointerOffset, modifiers);
        const QPointF offset = snappedPos - dragStartDoc;
        const qreal newValue = dragStartGuidePos +
            (currentGuide.first == Qt::Horizontal ?
             offset.y() : offset.x());
 
        setGuideValue(currentGuide, newValue);
        q->setGuidesConfigImpl(guidesConfig);
 
        const KisCoordinatesConverter *converter = view->canvasBase()->coordinatesConverter();
        if(currentGuide.first == Qt::Horizontal) {
            view->canvasBase()->viewManager()->showFloatingMessage(
                    i18n("Y: %1 px", converter->documentToImage(docPos).toPoint().y()), QIcon(), 1000
                        , KisFloatingMessage::High, Qt::AlignLeft | Qt::TextWordWrap | Qt::AlignVCenter);
        }
        else {
            view->canvasBase()->viewManager()->showFloatingMessage(
                    i18n("X: %1 px",  converter->documentToImage(docPos).toPoint().x()), QIcon(), 1000
                        , KisFloatingMessage::High, Qt::AlignLeft | Qt::TextWordWrap | Qt::AlignVCenter);
        }
    }
 
    return updateCursor(docPos);
}

References KisCoordinatesConverter::documentToImage(), KisFloatingMessage::High, and KoSnapGuide::snap().

mouseReleaseHandler()

bool KisGuidesManager::Private::mouseReleaseHandler

(

const QPointF &

docPos

)

When we delete a guide, it might happen that we are deleting the last guide. Therefore we should eat the corresponding event so that the event filter would stop the filter processing.

Definition at line 556 of file kis_guides_manager.cpp.

{
    bool result = false;
    KisCanvas2 *canvas = view->canvasBase();
    const KisCoordinatesConverter *converter = canvas->coordinatesConverter();
 
    if (isGuideValid(currentGuide)) {
        const QRectF docRect = converter->imageRectInDocumentPixels();
        // TODO: enable work rect after we fix painting guides
        //       outside canvas in openGL mode
        const QRectF workRect = KisAlgebra2D::blowRect(docRect, 0 /*0.2*/);
        if (!workRect.contains(docPos)) {
            deleteGuide(currentGuide);
            q->setGuidesConfigImpl(guidesConfig);
 
            result = true;
        }
 
        currentGuide = invalidGuide;
        dragStartDoc = QPointF();
        dragPointerOffset = QPointF();
        dragStartGuidePos = 0;
 
        KoSnapGuide *snapGuide = view->canvasBase()->snapGuide();
        snapGuide->reset();
 
        updateSnappingStatus(guidesConfig);
    }
 
    q->slotUploadConfigToDocument();
    createUndoCommandIfNeeded();
 
    return updateCursor(docPos) | result;
}

References KisAlgebra2D::blowRect(), KisCanvas2::coordinatesConverter, KisCoordinatesConverter::imageRectInDocumentPixels(), and KoSnapGuide::reset().

needsUndoCommand()

bool KisGuidesManager::Private::needsUndoCommand

(

)

Definition at line 185 of file kis_guides_manager.cpp.

{
    return !(oldGuidesConfig.hasSamePositionAs(guidesConfig));
}

setGuideValue()

void KisGuidesManager::Private::setGuideValue	(	const GuideHandle &	h,
		qreal	value )

Definition at line 444 of file kis_guides_manager.cpp.

{
    if (h.first == Qt::Horizontal) {
        QList<qreal> guides = guidesConfig.horizontalGuideLines();
        guides[h.second] = value;
        guidesConfig.setHorizontalGuideLines(guides);
    } else {
        QList<qreal> guides = guidesConfig.verticalGuideLines();
        guides[h.second] = value;
        guidesConfig.setVerticalGuideLines(guides);
    }
}

References value().

syncAction()

void KisGuidesManager::Private::syncAction	(	const QString &	actionName,
		bool	value )

Definition at line 176 of file kis_guides_manager.cpp.

{
    KisActionManager *actionManager = view->viewManager()->actionManager();
    KisAction *action = actionManager->actionByName(actionName);
    KIS_ASSERT_RECOVER_RETURN(action);
    KisSignalsBlocker b(action);
    action->setChecked(value);
}

References KisActionManager::actionByName(), KIS_ASSERT_RECOVER_RETURN, value(), and view.

updateCursor()

bool KisGuidesManager::Private::updateCursor	(	const QPointF &	docPos,
		bool	forceDisableCursor = false )

Definition at line 470 of file kis_guides_manager.cpp.

{
    KisCanvas2 *canvas = view->canvasBase();
 
    const GuideHandle guide = findGuide(docPos);
    const bool guideValid = isGuideValid(guide) && !forceDisableCursor;
 
    if (guideValid && !cursorSwitched) {
        oldCursor = canvas->canvasWidget()->cursor();
    }
 
    if (guideValid) {
        cursorSwitched = true;
        QCursor newCursor = guide.first == Qt::Horizontal ?
            Qt::SizeVerCursor : Qt::SizeHorCursor;
        canvas->canvasWidget()->setCursor(newCursor);
    }
 
    if (!guideValid && cursorSwitched) {
        canvas->canvasWidget()->setCursor(oldCursor);
        cursorSwitched = false;
    }
 
    return guideValid;
}

References KisCanvas2::canvasWidget.

updateSnappingStatus()

void KisGuidesManager::Private::updateSnappingStatus

(

const KisGuidesConfig &

value

)

Definition at line 217 of file kis_guides_manager.cpp.

{
    if (!view) return;
 
    KoSnapGuide *snapGuide = view->canvasBase()->snapGuide();
    KisSnapLineStrategy *guidesSnap = 0;
 
    if (value.snapToGuides()) {
        guidesSnap = new KisSnapLineStrategy(KoSnapGuide::GuideLineSnapping);
        guidesSnap->setHorizontalLines(value.horizontalGuideLines());
        guidesSnap->setVerticalLines(value.verticalGuideLines());
    }
 
    snapGuide->overrideSnapStrategy(KoSnapGuide::GuideLineSnapping, guidesSnap);
    snapGuide->enableSnapStrategy(KoSnapGuide::GuideLineSnapping, guidesSnap);
 
    snapGuide->enableSnapStrategy(KoSnapGuide::OrthogonalSnapping, snapConfig.orthogonal());
    snapGuide->enableSnapStrategy(KoSnapGuide::NodeSnapping, snapConfig.node());
    snapGuide->enableSnapStrategy(KoSnapGuide::ExtensionSnapping, snapConfig.extension());
    snapGuide->enableSnapStrategy(KoSnapGuide::IntersectionSnapping, snapConfig.intersection());
    snapGuide->enableSnapStrategy(KoSnapGuide::BoundingBoxSnapping, snapConfig.boundingBox());
    snapGuide->enableSnapStrategy(KoSnapGuide::DocumentBoundsSnapping, snapConfig.imageBounds());
    snapGuide->enableSnapStrategy(KoSnapGuide::DocumentCenterSnapping, snapConfig.imageCenter());
    snapGuide->enableSnapStrategy(KoSnapGuide::PixelSnapping, snapConfig.toPixel());
 
    snapConfig.saveStaticData();
}

References KoSnapGuide::BoundingBoxSnapping, KoSnapGuide::DocumentBoundsSnapping, KoSnapGuide::DocumentCenterSnapping, KoSnapGuide::enableSnapStrategy(), KoSnapGuide::ExtensionSnapping, KoSnapGuide::GuideLineSnapping, KoSnapGuide::IntersectionSnapping, KoSnapGuide::NodeSnapping, KoSnapGuide::OrthogonalSnapping, KoSnapGuide::overrideSnapStrategy(), KoSnapGuide::PixelSnapping, KisSnapLineStrategy::setHorizontalLines(), KisSnapLineStrategy::setVerticalLines(), and value().

Member Data Documentation

currentGuide

GuideHandle KisGuidesManager::Private::currentGuide

Definition at line 78 of file kis_guides_manager.cpp.

cursorSwitched

bool KisGuidesManager::Private::cursorSwitched

Definition at line 80 of file kis_guides_manager.cpp.

decoration

KisGuidesDecoration* KisGuidesManager::Private::decoration

Definition at line 45 of file kis_guides_manager.cpp.

dragPointerOffset

QPointF KisGuidesManager::Private::dragPointerOffset

Definition at line 84 of file kis_guides_manager.cpp.

dragStartDoc

QPointF KisGuidesManager::Private::dragStartDoc

Definition at line 83 of file kis_guides_manager.cpp.

dragStartGuidePos

qreal KisGuidesManager::Private::dragStartGuidePos

Definition at line 85 of file kis_guides_manager.cpp.

guidesConfig

KisGuidesConfig KisGuidesManager::Private::guidesConfig

Definition at line 46 of file kis_guides_manager.cpp.

invalidGuide

const GuideHandle KisGuidesManager::Private::invalidGuide

Definition at line 58 of file kis_guides_manager.cpp.

oldCursor

QCursor KisGuidesManager::Private::oldCursor

Definition at line 81 of file kis_guides_manager.cpp.

oldGuidesConfig

KisGuidesConfig KisGuidesManager::Private::oldGuidesConfig

Definition at line 47 of file kis_guides_manager.cpp.

q

KisGuidesManager* KisGuidesManager::Private::q

Definition at line 43 of file kis_guides_manager.cpp.

shouldSetModified

bool KisGuidesManager::Private::shouldSetModified

Definition at line 89 of file kis_guides_manager.cpp.

snapConfig

KisSnapConfig KisGuidesManager::Private::snapConfig

Definition at line 48 of file kis_guides_manager.cpp.

view

QPointer<KisView> KisGuidesManager::Private::view

Definition at line 49 of file kis_guides_manager.cpp.

viewConnections

KisSignalAutoConnectionsStore KisGuidesManager::Private::viewConnections

Definition at line 87 of file kis_guides_manager.cpp.

---

The documentation for this struct was generated from the following file:

• libs/ui/canvas/kis_guides_manager.cpp