KisGuidesManager Class Reference

#include <kis_guides_manager.h>

Inheritance diagram for KisGuidesManager:

Classes
struct	Private

Public Slots
void	setGuidesConfig (const KisGuidesConfig &config)
void	setLockGuides (bool value)
void	setRulersMultiple2 (bool value)
void	setShowGuides (bool value)
void	setSnapBoundingBox (bool value)
void	setSnapExtension (bool value)
void	setSnapImageBounds (bool value)
void	setSnapImageCenter (bool value)
void	setSnapIntersection (bool value)
void	setSnapNode (bool value)
void	setSnapOrthogonal (bool value)
void	setSnapToGuides (bool value)
void	setSnapToPixel (bool value)
void	setUnitType (KoUnit::Type type)
void	slotDocumentRequestedConfig (const KisGuidesConfig &config)
void	slotGuideCreationFinished (Qt::Orientation orientation, const QPoint &globalPos)
void	slotGuideCreationInProgress (Qt::Orientation orientation, const QPoint &globalPos)
void	slotShowSnapOptions ()
void	slotUploadConfigToDocument ()

Signals
void	sigRequestUpdateGuidesConfig (const KisGuidesConfig &config)

Public Member Functions
bool	eventFilter (QObject *obj, QEvent *event) override
	KisGuidesManager (QObject *parent=0)
bool	lockGuides () const
bool	rulersMultiple2 () const
void	setup (KisActionManager *actionManager)
void	setView (QPointer< KisView > view)
bool	showGuides () const
bool	snapToGuides () const
KoUnit::Type	unitType () const
	~KisGuidesManager () override

Private Member Functions
void	attachEventFilterImpl (bool value)
void	setGuidesConfigImpl (const KisGuidesConfig &value, bool emitModified=true)
void	syncActionsStatus ()

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 21 of file kis_guides_manager.h.

Constructor & Destructor Documentation

KisGuidesManager()

KisGuidesManager::KisGuidesManager

(

QObject *

parent = 0

)

Definition at line 92 of file kis_guides_manager.cpp.

    : QObject(parent),
      m_d(new Private(this))
{
}

~KisGuidesManager()

KisGuidesManager::~KisGuidesManager ( )

override

Definition at line 98 of file kis_guides_manager.cpp.

{
}

Member Function Documentation

attachEventFilterImpl()

void KisGuidesManager::attachEventFilterImpl ( bool value )

private

Definition at line 162 of file kis_guides_manager.cpp.

{
    if (!m_d->view) return;
 
    KisInputManager *inputManager = m_d->view->globalInputManager();
    if (inputManager) {
        if (value) {
            inputManager->attachPriorityEventFilter(this, 100);
        } else {
            inputManager->detachPriorityEventFilter(this);
        }
    }
}

References KisInputManager::attachPriorityEventFilter(), KisInputManager::detachPriorityEventFilter(), m_d, and value().

eventFilter()

bool KisGuidesManager::eventFilter ( QObject * obj, QEvent * event )

override

Definition at line 651 of file kis_guides_manager.cpp.

{
    if (!m_d->view || obj != m_d->view->canvasBase()->canvasWidget()) return false;
 
    bool retval = false;
 
    switch (event->type()) {
    case QEvent::Leave:
        m_d->updateCursor(QPointF(), true);
        break;
    case QEvent::Enter:
    case QEvent::TabletMove:
    case QEvent::MouseMove: {
        const QPointF docPos = m_d->getDocPointFromEvent(event);
        const Qt::KeyboardModifiers modifiers = qApp->keyboardModifiers();
 
        // we should never eat Enter events, input manager may get crazy about it
        retval = m_d->mouseMoveHandler(docPos, modifiers) && event->type() != QEvent::Enter;
 
        break;
    }
    case QEvent::TabletPress:
    case QEvent::MouseButtonPress: {
        if (m_d->getButtonFromEvent(event) != Qt::LeftButton) break;
 
        const QPointF docPos = m_d->getDocPointFromEvent(event);
        const Private::GuideHandle guide = m_d->findGuide(docPos);
        const bool guideValid = m_d->isGuideValid(guide);
 
        if (guideValid) {
            m_d->oldGuidesConfig = m_d->guidesConfig;
            m_d->initDragStart(guide, docPos, m_d->guideValue(guide), true);
        }
 
        retval = m_d->updateCursor(docPos);
 
        break;
    }
    case QEvent::TabletRelease:
    case QEvent::MouseButtonRelease: {
        if (m_d->getButtonFromEvent(event) != Qt::LeftButton) break;
 
        const QPointF docPos = m_d->getDocPointFromEvent(event);
        retval = m_d->mouseReleaseHandler(docPos);
 
        break;
    }
    default:
        break;
    }
 
    return !retval ? QObject::eventFilter(obj, event) : true;
}

References m_d.

lockGuides()

bool KisGuidesManager::lockGuides

(

)

const

Definition at line 257 of file kis_guides_manager.cpp.

{
    return m_d->guidesConfig.lockGuides();
}

References m_d.

rulersMultiple2()

bool KisGuidesManager::rulersMultiple2

(

)

const

Definition at line 281 of file kis_guides_manager.cpp.

{
    return m_d->guidesConfig.rulersMultiple2();
}

References m_d.

setGuidesConfig

void KisGuidesManager::setGuidesConfig ( const KisGuidesConfig & config )

slot

Definition at line 102 of file kis_guides_manager.cpp.

{
    if (config == m_d->guidesConfig) return;
    setGuidesConfigImpl(config, !config.hasSamePositionAs(m_d->guidesConfig));
    slotUploadConfigToDocument();
}

References KisGuidesConfig::hasSamePositionAs(), m_d, setGuidesConfigImpl(), and slotUploadConfigToDocument().

setGuidesConfigImpl()

void KisGuidesManager::setGuidesConfigImpl ( const KisGuidesConfig & value, bool emitModified = true )

private

Definition at line 133 of file kis_guides_manager.cpp.

{
    m_d->guidesConfig = value;
 
    if (m_d->decoration && value != m_d->decoration->guidesConfig()) {
        m_d->decoration->setVisible(value.showGuides());
        m_d->decoration->setGuidesConfig(value);
    }
 
    m_d->shouldSetModified |= emitModified;
 
    const bool shouldFilterEvent =
        value.showGuides() && !value.lockGuides() && value.hasGuides();
 
    attachEventFilterImpl(shouldFilterEvent);
    syncActionsStatus();
 
    if (!m_d->isGuideValid(m_d->currentGuide)) {
        m_d->updateSnappingStatus(value);
    }
 
    if (m_d->view) {
        m_d->view->document()->setUnit(KoUnit(m_d->guidesConfig.unitType()));
        m_d->view->viewManager()->actionManager()->actionByName("ruler_pixel_multiple2")->setChecked(value.rulersMultiple2());
    }
 
    Q_EMIT sigRequestUpdateGuidesConfig(m_d->guidesConfig);
}

References attachEventFilterImpl(), m_d, sigRequestUpdateGuidesConfig(), syncActionsStatus(), and value().

setLockGuides

void KisGuidesManager::setLockGuides ( bool value )

slot

Definition at line 262 of file kis_guides_manager.cpp.

{
    m_d->guidesConfig.setLockGuides(value);
    setGuidesConfigImpl(m_d->guidesConfig);
    slotUploadConfigToDocument();
}

References m_d, setGuidesConfigImpl(), slotUploadConfigToDocument(), and value().

setRulersMultiple2

void KisGuidesManager::setRulersMultiple2 ( bool value )

slot

Definition at line 286 of file kis_guides_manager.cpp.

{
    m_d->guidesConfig.setRulersMultiple2(value);
    setGuidesConfigImpl(m_d->guidesConfig);
    slotUploadConfigToDocument();
}

References m_d, setGuidesConfigImpl(), slotUploadConfigToDocument(), and value().

setShowGuides

void KisGuidesManager::setShowGuides ( bool value )

slot

Definition at line 250 of file kis_guides_manager.cpp.

{
    m_d->guidesConfig.setShowGuides(value);
    setGuidesConfigImpl(m_d->guidesConfig);
    slotUploadConfigToDocument();
}

References m_d, setGuidesConfigImpl(), slotUploadConfigToDocument(), and value().

setSnapBoundingBox

void KisGuidesManager::setSnapBoundingBox ( bool value )

slot

Definition at line 816 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setBoundingBox(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapExtension

void KisGuidesManager::setSnapExtension ( bool value )

slot

Definition at line 804 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setExtension(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapImageBounds

void KisGuidesManager::setSnapImageBounds ( bool value )

slot

Definition at line 822 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setImageBounds(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapImageCenter

void KisGuidesManager::setSnapImageCenter ( bool value )

slot

Definition at line 828 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setImageCenter(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapIntersection

void KisGuidesManager::setSnapIntersection ( bool value )

slot

Definition at line 810 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setIntersection(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapNode

void KisGuidesManager::setSnapNode ( bool value )

slot

Definition at line 798 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setNode(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapOrthogonal

void KisGuidesManager::setSnapOrthogonal ( bool value )

slot

Definition at line 792 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setOrthogonal(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setSnapToGuides

void KisGuidesManager::setSnapToGuides ( bool value )

slot

Definition at line 274 of file kis_guides_manager.cpp.

{
    m_d->guidesConfig.setSnapToGuides(value);
    setGuidesConfigImpl(m_d->guidesConfig);
    slotUploadConfigToDocument();
}

References m_d, setGuidesConfigImpl(), slotUploadConfigToDocument(), and value().

setSnapToPixel

void KisGuidesManager::setSnapToPixel ( bool value )

slot

Definition at line 834 of file kis_guides_manager.cpp.

{
    m_d->snapConfig.setToPixel(value);
    m_d->updateSnappingStatus(m_d->guidesConfig);
}

References m_d, and value().

setUnitType

void KisGuidesManager::setUnitType ( KoUnit::Type type )

slot

Definition at line 298 of file kis_guides_manager.cpp.

{
    m_d->guidesConfig.setUnitType(type);
    setGuidesConfigImpl(m_d->guidesConfig, false);
    slotUploadConfigToDocument();
}

References m_d, setGuidesConfigImpl(), and slotUploadConfigToDocument().

setup()

void KisGuidesManager::setup

(

KisActionManager *

actionManager

)

Definition at line 305 of file kis_guides_manager.cpp.

{
    KisAction *action = 0;
 
    action = actionManager->createAction("view_show_guides");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setShowGuides(bool)));
 
    action = actionManager->createAction("view_lock_guides");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setLockGuides(bool)));
 
    action = actionManager->createAction("view_snap_to_guides");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapToGuides(bool)));
 
    action = actionManager->createAction("show_snap_options_popup");
    connect(action, SIGNAL(triggered()), this, SLOT(slotShowSnapOptions()));
 
    action = actionManager->createAction("view_snap_orthogonal");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapOrthogonal(bool)));
 
    action = actionManager->createAction("view_snap_node");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapNode(bool)));
 
    action = actionManager->createAction("view_snap_extension");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapExtension(bool)));
 
    action = actionManager->createAction("view_snap_intersection");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapIntersection(bool)));
 
    action = actionManager->createAction("view_snap_bounding_box");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapBoundingBox(bool)));
 
    action = actionManager->createAction("view_snap_image_bounds");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapImageBounds(bool)));
 
    action = actionManager->createAction("view_snap_image_center");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapImageCenter(bool)));
 
    action = actionManager->createAction("view_snap_to_pixel");
    connect(action, SIGNAL(toggled(bool)), this, SLOT(setSnapToPixel(bool)));
 
    m_d->updateSnappingStatus(m_d->guidesConfig);
    syncActionsStatus();
}

References connect(), KisActionManager::createAction(), m_d, setLockGuides(), setShowGuides(), setSnapBoundingBox(), setSnapExtension(), setSnapImageBounds(), setSnapImageCenter(), setSnapIntersection(), setSnapNode(), setSnapOrthogonal(), setSnapToGuides(), setSnapToPixel(), slotShowSnapOptions(), and syncActionsStatus().

setView()

void KisGuidesManager::setView

(

QPointer< KisView >

view

)

Definition at line 349 of file kis_guides_manager.cpp.

{
    if (m_d->view) {
        KoSnapGuide *snapGuide = m_d->view->canvasBase()->snapGuide();
        snapGuide->overrideSnapStrategy(KoSnapGuide::GuideLineSnapping, 0);
        snapGuide->enableSnapStrategy(KoSnapGuide::GuideLineSnapping, false);
 
        slotUploadConfigToDocument();
 
        m_d->decoration = 0;
        m_d->viewConnections.clear();
        attachEventFilterImpl(false);
    }
 
    m_d->view = view;
 
    if (m_d->view) {
        KisGuidesDecoration* decoration = qobject_cast<KisGuidesDecoration*>(m_d->view->canvasBase()->decoration(GUIDES_DECORATION_ID).data());
        if (!decoration) {
            decoration = new KisGuidesDecoration(m_d->view);
            m_d->view->canvasBase()->addDecoration(decoration);
        }
        m_d->decoration = decoration;
 
        m_d->guidesConfig = m_d->view->document()->guidesConfig();
        setGuidesConfigImpl(m_d->guidesConfig, false);
 
        m_d->viewConnections.addUniqueConnection(
            m_d->view->zoomManager()->horizontalRuler(), SIGNAL(guideCreationInProgress(Qt::Orientation,QPoint)),
            this, SLOT(slotGuideCreationInProgress(Qt::Orientation,QPoint)));
 
        m_d->viewConnections.addUniqueConnection(
            m_d->view->zoomManager()->horizontalRuler(), SIGNAL(guideCreationFinished(Qt::Orientation,QPoint)),
            this, SLOT(slotGuideCreationFinished(Qt::Orientation,QPoint)));
 
        m_d->viewConnections.addUniqueConnection(
            m_d->view->zoomManager()->verticalRuler(), SIGNAL(guideCreationInProgress(Qt::Orientation,QPoint)),
            this, SLOT(slotGuideCreationInProgress(Qt::Orientation,QPoint)));
 
        m_d->viewConnections.addUniqueConnection(
            m_d->view->zoomManager()->verticalRuler(), SIGNAL(guideCreationFinished(Qt::Orientation,QPoint)),
            this, SLOT(slotGuideCreationFinished(Qt::Orientation,QPoint)));
 
        m_d->viewConnections.addUniqueConnection(
            m_d->view->document(), SIGNAL(sigGuidesConfigChanged(KisGuidesConfig)),
            this, SLOT(slotDocumentRequestedConfig(KisGuidesConfig)));
    }
}

References attachEventFilterImpl(), KoSnapGuide::enableSnapStrategy(), KoSnapGuide::GuideLineSnapping, GUIDES_DECORATION_ID, KisGuidesDecoration::guidesConfig(), m_d, KoSnapGuide::overrideSnapStrategy(), setGuidesConfigImpl(), slotDocumentRequestedConfig(), slotGuideCreationFinished(), slotGuideCreationInProgress(), and slotUploadConfigToDocument().

showGuides()

bool KisGuidesManager::showGuides

(

)

const

Definition at line 245 of file kis_guides_manager.cpp.

{
    return m_d->guidesConfig.showGuides();
}

References m_d.

sigRequestUpdateGuidesConfig

void KisGuidesManager::sigRequestUpdateGuidesConfig ( const KisGuidesConfig & config )

signal

slotDocumentRequestedConfig

void KisGuidesManager::slotDocumentRequestedConfig ( const KisGuidesConfig & config )

slot

Definition at line 109 of file kis_guides_manager.cpp.

{
    if (config == m_d->guidesConfig) return;
    setGuidesConfigImpl(config, false);
}

References m_d, and setGuidesConfigImpl().

slotGuideCreationFinished

void KisGuidesManager::slotGuideCreationFinished ( Qt::Orientation orientation, const QPoint & globalPos )

slot

Definition at line 742 of file kis_guides_manager.cpp.

{
    Q_UNUSED(orientation);
    if (m_d->guidesConfig.lockGuides()) return;
 
    KisCanvas2 *canvas = m_d->view->canvasBase();
    const KisCoordinatesConverter *converter = canvas->coordinatesConverter();
    const QPointF widgetPos = canvas->canvasWidget()->mapFromGlobal(globalPos);
    const QPointF docPos = m_d->alignToPixels(converter->widgetToDocument(widgetPos));
 
    m_d->mouseReleaseHandler(docPos);
}

References KisCanvas2::canvasWidget, KisCanvas2::coordinatesConverter, m_d, KisCanvas2::view, and KisCoordinatesConverter::widgetToDocument().

slotGuideCreationInProgress

void KisGuidesManager::slotGuideCreationInProgress ( Qt::Orientation orientation, const QPoint & globalPos )

slot

Definition at line 705 of file kis_guides_manager.cpp.

{
    if (m_d->guidesConfig.lockGuides()) return;
 
    KisCanvas2 *canvas = m_d->view->canvasBase();
    const KisCoordinatesConverter *converter = canvas->coordinatesConverter();
    const QPointF widgetPos = canvas->canvasWidget()->mapFromGlobal(globalPos);
    const QPointF docPos = m_d->alignToPixels(converter->widgetToDocument(widgetPos));
 
    if (m_d->isGuideValid(m_d->currentGuide)) {
        const Qt::KeyboardModifiers modifiers = qApp->keyboardModifiers();
        m_d->mouseMoveHandler(docPos, modifiers);
    } else {
        m_d->guidesConfig.setShowGuides(true);
 
        m_d->oldGuidesConfig = m_d->guidesConfig;
 
        if (orientation == Qt::Horizontal) {
            QList<qreal> guides = m_d->guidesConfig.horizontalGuideLines();
            guides.append(docPos.y());
            m_d->currentGuide.first = orientation;
            m_d->currentGuide.second = guides.size() - 1;
            m_d->guidesConfig.setHorizontalGuideLines(guides);
            m_d->initDragStart(m_d->currentGuide, docPos, docPos.y(), false);
        } else {
            QList<qreal> guides = m_d->guidesConfig.verticalGuideLines();
            guides.append(docPos.x());
            m_d->currentGuide.first = orientation;
            m_d->currentGuide.second = guides.size() - 1;
            m_d->guidesConfig.setVerticalGuideLines(guides);
            m_d->initDragStart(m_d->currentGuide, docPos, docPos.x(), false);
        }
 
        setGuidesConfigImpl(m_d->guidesConfig);
    }
}

References KisCanvas2::canvasWidget, KisCanvas2::coordinatesConverter, m_d, setGuidesConfigImpl(), KisCanvas2::view, and KisCoordinatesConverter::widgetToDocument().

slotShowSnapOptions

void KisGuidesManager::slotShowSnapOptions ( )

slot

Definition at line 770 of file kis_guides_manager.cpp.

{
    const QPoint pos = QCursor::pos();
    QMenu menu;
 
    menu.addSection(i18n("Snap to:"));
    menu.addAction(m_d->createShortenedAction(i18n("Grid"), "view_snap_to_grid", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Guides"), "view_snap_to_guides", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Pixel"), "view_snap_to_pixel", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Orthogonal"), "view_snap_orthogonal", &menu));
 
    menu.addAction(m_d->createShortenedAction(i18n("Node"), "view_snap_node", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Extension"), "view_snap_extension", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Intersection"), "view_snap_intersection", &menu));
 
    menu.addAction(m_d->createShortenedAction(i18n("Bounding Box"), "view_snap_bounding_box", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Image Bounds"), "view_snap_image_bounds", &menu));
    menu.addAction(m_d->createShortenedAction(i18n("Image Center"), "view_snap_image_center", &menu));
 
    menu.exec(pos);
}

References m_d.

slotUploadConfigToDocument

void KisGuidesManager::slotUploadConfigToDocument ( )

slot

Definition at line 115 of file kis_guides_manager.cpp.

{
    const KisGuidesConfig &value = m_d->guidesConfig;
 
    KisDocument *doc = m_d->view ? m_d->view->document() : 0;
    if (doc) {
        KisSignalsBlocker b(doc);
 
        // we've made KisChangeGuidesCommand post-exec, so in all situations
        // we will replace the whole config
        doc->setGuidesConfig(value);
 
        value.saveStaticData();
    }
 
    m_d->shouldSetModified = false;
}

References m_d, KisDocument::setGuidesConfig(), and value().

snapToGuides()

bool KisGuidesManager::snapToGuides

(

)

const

Definition at line 269 of file kis_guides_manager.cpp.

{
    return m_d->guidesConfig.snapToGuides();
}

References m_d.

syncActionsStatus()

void KisGuidesManager::syncActionsStatus ( )

private

Definition at line 199 of file kis_guides_manager.cpp.

{
    if (!m_d->view) return;
 
    m_d->syncAction("view_show_guides", m_d->guidesConfig.showGuides());
    m_d->syncAction("view_lock_guides", m_d->guidesConfig.lockGuides());
    m_d->syncAction("view_snap_to_guides", m_d->guidesConfig.snapToGuides());
 
    m_d->syncAction("view_snap_orthogonal", m_d->snapConfig.orthogonal());
    m_d->syncAction("view_snap_node", m_d->snapConfig.node());
    m_d->syncAction("view_snap_extension", m_d->snapConfig.extension());
    m_d->syncAction("view_snap_intersection", m_d->snapConfig.intersection());
    m_d->syncAction("view_snap_bounding_box", m_d->snapConfig.boundingBox());
    m_d->syncAction("view_snap_image_bounds", m_d->snapConfig.imageBounds());
    m_d->syncAction("view_snap_image_center", m_d->snapConfig.imageCenter());
    m_d->syncAction("view_snap_to_pixel",m_d->snapConfig.toPixel());
}

References m_d.

unitType()

KoUnit::Type KisGuidesManager::unitType

(

)

const

Definition at line 293 of file kis_guides_manager.cpp.

{
    return m_d->guidesConfig.unitType();
}

References m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisGuidesManager::m_d

private

Definition at line 76 of file kis_guides_manager.h.

---

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

• libs/ui/canvas/kis_guides_manager.h
• libs/ui/canvas/kis_guides_manager.cpp