KisZoomManager Class Reference

#include <kis_zoom_manager.h>

Inheritance diagram for KisZoomManager:

Public Slots
void	applyRulersUnit (const KoUnit &baseUnit)
void	mousePositionChanged (const QPoint &viewPos)
void	setRulersPixelMultiple2 (bool enabled)
void	setRulersTrackMouse (bool value)
void	setShowRulers (bool show)
void	slotToggleZoomToFit ()
void	slotZoomIn ()
void	slotZoomOut ()
void	slotZoomToFit ()
void	slotZoomToFitHeight ()
void	slotZoomToFitWidth ()
void	zoomTo100 ()

Public Member Functions
KoRuler *	horizontalRuler () const
	KisZoomManager (QPointer< KisView > view, KoZoomHandler *, KoCanvasController *)
void	setup (KisKActionCollection *actionCollection)
void	syncOnImageResolutionChange ()
void	updateImageBoundsSnapping ()
KoRuler *	verticalRuler () const
KoZoomAction *	zoomAction () const
QWidget *	zoomActionWidget () const
	~KisZoomManager () override

Private Slots
void	slotConfigChanged ()
void	slotUpdateGuiAfterDocumentRectChanged ()
void	slotUpdateGuiAfterZoomChange ()

Private Member Functions
void	updateCurrentZoomResource ()
void	updateMouseTrackingConnections ()

Private Attributes
QRect	m_cachedRulersRect
KoCanvasController *	m_canvasController {nullptr}
KisSignalCompressor	m_documentRectChangedCompressor
KoRuler *	m_horizontalRuler {nullptr}
KisSignalAutoConnectionsStore	m_mouseTrackingConnections
qreal	m_previousZoomLevel {1.0}
KoZoomMode::Mode	m_previousZoomMode
QPointF	m_previousZoomPoint
KoRuler *	m_verticalRuler {nullptr}
QPointer< KisView >	m_view
KoZoomAction *	m_zoomAction {nullptr}
QPointer< QWidget >	m_zoomActionWidget
KisSignalCompressor	m_zoomChangedCompressor
KoZoomHandler *	m_zoomHandler {nullptr}

Detailed Description

The zoom manager handles all user actions related to zooming and unzooming. The actual computation of zoom levels and things are the job of KoZoomHandler or its descendants

Definition at line 36 of file kis_zoom_manager.h.

Constructor & Destructor Documentation

KisZoomManager()

KisZoomManager::KisZoomManager	(	QPointer< KisView >	view,
		KoZoomHandler *	zoomHandler,
		KoCanvasController *	canvasController )

Definition at line 43 of file kis_zoom_manager.cc.

        : m_view(view)
        , m_zoomHandler(zoomHandler)
        , m_canvasController(canvasController)
        , m_zoomChangedCompressor(guiUpdateDelay, KisSignalCompressor::FIRST_ACTIVE)
        , m_documentRectChangedCompressor(guiUpdateDelay, KisSignalCompressor::FIRST_ACTIVE)
        , m_previousZoomMode(KoZoomMode::ZOOM_PAGE)
        , m_previousZoomPoint(QPointF(0.0, 0.0))
{
}

~KisZoomManager()

KisZoomManager::~KisZoomManager ( )

override

Definition at line 55 of file kis_zoom_manager.cc.

{
    if (m_zoomActionWidget && !m_zoomActionWidget->parent()) {
        delete m_zoomActionWidget;
    }
}

References m_zoomActionWidget.

Member Function Documentation

applyRulersUnit

void KisZoomManager::applyRulersUnit ( const KoUnit & baseUnit )

slot

Definition at line 226 of file kis_zoom_manager.cc.

{
    if (m_view && m_view->image()) {
        m_horizontalRuler->setUnit(KoUnit(baseUnit.type(), m_view->image()->xRes()));
        m_verticalRuler->setUnit(KoUnit(baseUnit.type(), m_view->image()->yRes()));
    }
    if (m_view->viewManager()) {
        m_view->viewManager()->guidesManager()->setUnitType(baseUnit.type());
    }
}

References m_horizontalRuler, m_verticalRuler, m_view, KoRuler::setUnit(), and KoUnit::type().

horizontalRuler()

KoRuler * KisZoomManager::horizontalRuler

(

)

const

Definition at line 194 of file kis_zoom_manager.cc.

{
    return m_horizontalRuler;
}

References m_horizontalRuler.

mousePositionChanged

void KisZoomManager::mousePositionChanged ( const QPoint & viewPos )

slot

Definition at line 204 of file kis_zoom_manager.cc.

{
    QPoint pt = viewPos - m_cachedRulersRect.topLeft();
 
    m_horizontalRuler->updateMouseCoordinate(pt.x());
    m_verticalRuler->updateMouseCoordinate(pt.y());
}

References m_cachedRulersRect, m_horizontalRuler, m_verticalRuler, and KoRuler::updateMouseCoordinate().

setRulersPixelMultiple2

void KisZoomManager::setRulersPixelMultiple2 ( bool enabled )

slot

Definition at line 237 of file kis_zoom_manager.cc.

{
    m_horizontalRuler->setUnitPixelMultiple2(enabled);
    m_verticalRuler->setUnitPixelMultiple2(enabled);
    if (m_view->viewManager()) {
        m_view->viewManager()->guidesManager()->setRulersMultiple2(enabled);
    }
}

References m_horizontalRuler, m_verticalRuler, m_view, and KoRuler::setUnitPixelMultiple2().

setRulersTrackMouse

void KisZoomManager::setRulersTrackMouse ( bool value )

slot

Definition at line 219 of file kis_zoom_manager.cc.

{
    m_horizontalRuler->setShowMousePosition(value);
    m_verticalRuler->setShowMousePosition(value);
    updateMouseTrackingConnections();
}

References m_horizontalRuler, m_verticalRuler, KoRuler::setShowMousePosition(), updateMouseTrackingConnections(), and value().

setShowRulers

void KisZoomManager::setShowRulers ( bool show )

slot

Definition at line 212 of file kis_zoom_manager.cc.

{
    m_horizontalRuler->setVisible(show);
    m_verticalRuler->setVisible(show);
    updateMouseTrackingConnections();
}

References m_horizontalRuler, m_verticalRuler, and updateMouseTrackingConnections().

setup()

void KisZoomManager::setup

(

KisKActionCollection *

actionCollection

)

Definition at line 62 of file kis_zoom_manager.cc.

{
 
    KisImageWSP image = m_view->image();
    if (!image) return;
 
    m_zoomAction = new KoZoomAction(i18n("Zoom"), this);
    m_zoomActionWidget = m_zoomAction->createWidget(0);
 
    connect(m_zoomAction, &KoZoomAction::zoomChanged, this,
        [this](KoZoomMode::Mode mode, qreal zoom) {
            m_canvasController->setZoom(mode, zoom);
        });
    connect(m_canvasController->proxyObject, &KoCanvasControllerProxyObject::zoomStateChanged, m_zoomAction, &KoZoomAction::slotZoomStateChanged);
    m_zoomAction->slotZoomStateChanged(m_canvasController->zoomState());
 
    // Put the canvascontroller in a layout so it resizes with us
    QGridLayout * layout = new QGridLayout(m_view);
    layout->setSpacing(0);
    layout->setContentsMargins(0, 0, 0, 0);
 
    m_view->document()->setUnit(KoUnit(KoUnit::Pixel));
 
    m_horizontalRuler = new KoRuler(m_view, Qt::Horizontal, m_zoomHandler);
    m_horizontalRuler->setShowMousePosition(true);
    m_horizontalRuler->createGuideToolConnection(m_view->canvasBase());
    m_horizontalRuler->setVisible(false); // this prevents the rulers from flashing on to off when a new document is created
 
    m_verticalRuler = new KoRuler(m_view, Qt::Vertical, m_zoomHandler);
    m_verticalRuler->setShowMousePosition(true);
    m_verticalRuler->createGuideToolConnection(m_view->canvasBase());
    m_verticalRuler->setVisible(false);
 
 
    QAction *rulerAction = actionCollection->action("ruler_pixel_multiple2");
    if (m_view->document()->guidesConfig().rulersMultiple2()) {
        m_horizontalRuler->setUnitPixelMultiple2(true);
        m_verticalRuler->setUnitPixelMultiple2(true);
    }
    QList<QAction*> unitActions = m_view->createChangeUnitActions(true);
    unitActions.append(rulerAction);
    m_horizontalRuler->setPopupActionList(unitActions);
    m_verticalRuler->setPopupActionList(unitActions);
 
    connect(m_view->document(), SIGNAL(unitChanged(KoUnit)), SLOT(applyRulersUnit(KoUnit)));
    connect(rulerAction, SIGNAL(toggled(bool)), SLOT(setRulersPixelMultiple2(bool)));
    applyRulersUnit(m_view->document()->unit());
 
    layout->addWidget(m_horizontalRuler, 0, 1);
    layout->addWidget(m_verticalRuler, 1, 0);
    layout->addWidget(static_cast<KoCanvasControllerWidget*>(m_canvasController), 1, 1);
 
    connect(m_canvasController->proxyObject, &KoCanvasControllerProxyObject::zoomStateChanged,
            &m_zoomChangedCompressor, &KisSignalCompressor::start);
    connect(m_canvasController->proxyObject, &KoCanvasControllerProxyObject::documentRectInWidgetPixelsChanged,
            &m_documentRectChangedCompressor, &KisSignalCompressor::start);
    connect(&m_zoomChangedCompressor, &KisSignalCompressor::timeout,
            this,
            &KisZoomManager::slotUpdateGuiAfterZoomChange);
    connect(&m_documentRectChangedCompressor,
            &KisSignalCompressor::timeout,
            this,
            &KisZoomManager::slotUpdateGuiAfterDocumentRectChanged);
 
    connect(KisConfigNotifier::instance(), &KisConfigNotifier::configChanged,
            this, &KisZoomManager::slotConfigChanged);
    slotConfigChanged();
}

References KisKActionCollection::action(), applyRulersUnit(), KisConfigNotifier::configChanged(), connect(), KoRuler::createGuideToolConnection(), KoZoomAction::createWidget(), KoCanvasControllerProxyObject::documentRectInWidgetPixelsChanged(), KisConfigNotifier::instance(), m_canvasController, m_documentRectChangedCompressor, m_horizontalRuler, m_verticalRuler, m_view, m_zoomAction, m_zoomActionWidget, m_zoomChangedCompressor, m_zoomHandler, KoUnit::Pixel, KoCanvasController::proxyObject, KoRuler::setPopupActionList(), setRulersPixelMultiple2(), KoRuler::setShowMousePosition(), KoRuler::setUnitPixelMultiple2(), KoCanvasController::setZoom(), slotConfigChanged(), slotUpdateGuiAfterDocumentRectChanged(), slotUpdateGuiAfterZoomChange(), KoZoomAction::slotZoomStateChanged(), KisSignalCompressor::start(), KisSignalCompressor::timeout(), KoZoomAction::zoomChanged(), KoCanvasController::zoomState(), and KoCanvasControllerProxyObject::zoomStateChanged().

slotConfigChanged

void KisZoomManager::slotConfigChanged ( )

privateslot

Definition at line 340 of file kis_zoom_manager.cc.

{
    KisConfig cfg(true);
 
    KisCoordinatesConverter *converter =
        dynamic_cast<KisCoordinatesConverter*>(m_zoomHandler);
    KIS_ASSERT_RECOVER_RETURN(converter);
 
    const int oldZoomMarginSize = converter->zoomMarginSize();
    if (oldZoomMarginSize != cfg.zoomMarginSize()) {
        converter->setZoomMarginSize(cfg.zoomMarginSize());
        if (converter->zoomMode() != KoZoomMode::ZOOM_CONSTANT) {
            m_canvasController->setZoom(converter->zoomMode(), converter->zoom());
        }
    }
}

References KIS_ASSERT_RECOVER_RETURN, m_canvasController, m_zoomHandler, KoCanvasController::setZoom(), KoZoomHandler::setZoomMarginSize(), KoZoomHandler::zoom(), KoZoomMode::ZOOM_CONSTANT, KoZoomHandler::zoomMarginSize(), KisConfig::zoomMarginSize(), and KoZoomHandler::zoomMode().

slotToggleZoomToFit

void KisZoomManager::slotToggleZoomToFit ( )

slot

Definition at line 325 of file kis_zoom_manager.cc.

{
    KoZoomMode::Mode currentZoomMode = m_zoomHandler->zoomMode();
    if (currentZoomMode == KoZoomMode::ZOOM_CONSTANT) {
        m_previousZoomLevel = m_zoomHandler->zoom();
        m_previousZoomPoint = m_canvasController->preferredCenter();
        m_canvasController->setZoom(m_previousZoomMode, m_previousZoomLevel);
    }
    else {
        m_previousZoomMode = currentZoomMode;
        m_canvasController->setZoom(KoZoomMode::ZOOM_CONSTANT, m_previousZoomLevel);
        m_canvasController->setPreferredCenter(m_previousZoomPoint);
    }
}

References m_canvasController, m_previousZoomLevel, m_previousZoomMode, m_previousZoomPoint, m_zoomHandler, KoCanvasController::preferredCenter(), KoCanvasController::setPreferredCenter(), KoCanvasController::setZoom(), KoZoomHandler::zoom(), KoZoomMode::ZOOM_CONSTANT, and KoZoomHandler::zoomMode().

slotUpdateGuiAfterDocumentRectChanged

void KisZoomManager::slotUpdateGuiAfterDocumentRectChanged ( )

privateslot

Definition at line 274 of file kis_zoom_manager.cc.

{
    const QRectF widgetRect = m_view->canvasBase()->coordinatesConverter()->imageRectInWidgetPixels();
    const QRect alignedWidgetRect = widgetRect.toAlignedRect();
 
    if (m_cachedRulersRect == alignedWidgetRect) return;
 
    applyRulersUnit(m_horizontalRuler->unit());
 
    // A bit weird conversion: convert the widget rect as if it were unrotated
    const QRectF documentRect = m_view->canvasBase()->coordinatesConverter()->flakeToDocument(widgetRect);
    const QSize documentSize = documentRect.toAlignedRect().size();
 
    m_horizontalRuler->setRulerLength(documentSize.width());
    m_verticalRuler->setRulerLength(documentSize.height());
 
    m_horizontalRuler->setOffset(alignedWidgetRect.x());
    m_verticalRuler->setOffset(alignedWidgetRect.y());
 
    m_cachedRulersRect = alignedWidgetRect;
}

References applyRulersUnit(), m_cachedRulersRect, m_horizontalRuler, m_verticalRuler, m_view, KoRuler::setOffset(), KoRuler::setRulerLength(), and KoRuler::unit().

slotUpdateGuiAfterZoomChange

void KisZoomManager::slotUpdateGuiAfterZoomChange ( )

privateslot

Definition at line 246 of file kis_zoom_manager.cc.

{
    const qreal zoomValue = m_view->canvasBase()->coordinatesConverter()->zoom();
    const qreal humanZoom = zoomValue * 100.0;
 
    // XXX: KOMVC -- this is very irritating in MDI mode
 
    if (m_view->viewManager()) {
        m_view->viewManager()->
                showFloatingMessage(
                    i18nc("floating message about zoom", "Zoom: %1 %",
                          KritaUtils::prettyFormatReal(humanZoom)),
                    QIcon(), 500, KisFloatingMessage::Low, Qt::AlignCenter);
    }
 
    updateCurrentZoomResource();
}

References KisFloatingMessage::Low, m_view, KritaUtils::prettyFormatReal(), and updateCurrentZoomResource().

slotZoomIn

void KisZoomManager::slotZoomIn ( )

slot

Definition at line 301 of file kis_zoom_manager.cc.

{
    m_canvasController->zoomIn();
}

References m_canvasController, and KoCanvasController::zoomIn().

slotZoomOut

void KisZoomManager::slotZoomOut ( )

slot

Definition at line 306 of file kis_zoom_manager.cc.

{
    m_canvasController->zoomOut();
}

References m_canvasController, and KoCanvasController::zoomOut().

slotZoomToFit

void KisZoomManager::slotZoomToFit ( )

slot

Definition at line 311 of file kis_zoom_manager.cc.

{
    m_canvasController->setZoom(KoZoomMode::ZOOM_PAGE, 0);
}

References m_canvasController, KoCanvasController::setZoom(), and KoZoomMode::ZOOM_PAGE.

slotZoomToFitHeight

void KisZoomManager::slotZoomToFitHeight ( )

slot

Definition at line 320 of file kis_zoom_manager.cc.

{
    m_canvasController->setZoom(KoZoomMode::ZOOM_HEIGHT, 0);
}

References m_canvasController, KoCanvasController::setZoom(), and KoZoomMode::ZOOM_HEIGHT.

slotZoomToFitWidth

void KisZoomManager::slotZoomToFitWidth ( )

slot

Definition at line 316 of file kis_zoom_manager.cc.

{
    m_canvasController->setZoom(KoZoomMode::ZOOM_WIDTH, 0);
}

References m_canvasController, KoCanvasController::setZoom(), and KoZoomMode::ZOOM_WIDTH.

syncOnImageResolutionChange()

void KisZoomManager::syncOnImageResolutionChange

(

)

Definition at line 161 of file kis_zoom_manager.cc.

{
    m_documentRectChangedCompressor.start();
}

References m_documentRectChangedCompressor, and KisSignalCompressor::start().

updateCurrentZoomResource()

void KisZoomManager::updateCurrentZoomResource ( )

private

Definition at line 166 of file kis_zoom_manager.cc.

{
    const qreal effectiveZoom =
        m_view->canvasBase()->coordinatesConverter()->effectiveZoom();
    const qreal effectivePhysicalZoom =
        m_view->canvasBase()->coordinatesConverter()->effectivePhysicalZoom();
 
    m_view->canvasBase()->resourceManager()->setResource(KoCanvasResource::EffectiveZoom, effectiveZoom);
    m_view->canvasBase()->resourceManager()->setResource(KoCanvasResource::EffectivePhysicalZoom, effectivePhysicalZoom);
}

References KoCanvasResource::EffectivePhysicalZoom, KoCanvasResource::EffectiveZoom, and m_view.

updateImageBoundsSnapping()

void KisZoomManager::updateImageBoundsSnapping

(

)

Definition at line 131 of file kis_zoom_manager.cc.

{
    const QRectF docRect = m_view->canvasBase()->coordinatesConverter()->imageRectInDocumentPixels();
    const QPointF docCenter = docRect.center();
 
    KoSnapGuide *snapGuide = m_view->canvasBase()->snapGuide();
 
    {
        KisSnapLineStrategy *boundsSnap =
            new KisSnapLineStrategy(KoSnapGuide::DocumentBoundsSnapping);
 
        boundsSnap->addLine(Qt::Horizontal, docRect.y());
        boundsSnap->addLine(Qt::Horizontal, docRect.bottom());
        boundsSnap->addLine(Qt::Vertical, docRect.x());
        boundsSnap->addLine(Qt::Vertical, docRect.right());
 
        snapGuide->overrideSnapStrategy(KoSnapGuide::DocumentBoundsSnapping, boundsSnap);
    }
 
    {
        KisSnapLineStrategy *centerSnap =
            new KisSnapLineStrategy(KoSnapGuide::DocumentCenterSnapping);
 
        centerSnap->addLine(Qt::Horizontal, docCenter.y());
        centerSnap->addLine(Qt::Vertical, docCenter.x());
 
        snapGuide->overrideSnapStrategy(KoSnapGuide::DocumentCenterSnapping, centerSnap);
    }
}

References KisSnapLineStrategy::addLine(), KoSnapGuide::DocumentBoundsSnapping, KoSnapGuide::DocumentCenterSnapping, m_view, and KoSnapGuide::overrideSnapStrategy().

updateMouseTrackingConnections()

void KisZoomManager::updateMouseTrackingConnections ( )

private

Definition at line 177 of file kis_zoom_manager.cc.

{
    bool value = m_horizontalRuler->isVisible() &&
        m_verticalRuler->isVisible() &&
        m_horizontalRuler->showMousePosition() &&
        m_verticalRuler->showMousePosition();
 
    m_mouseTrackingConnections.clear();
 
    if (value) {
        m_mouseTrackingConnections.addConnection(m_canvasController->proxyObject,
                SIGNAL(canvasMousePositionChanged(QPoint)),
                this,
                SLOT(mousePositionChanged(QPoint)));
    }
}

References KisSignalAutoConnectionsStore::addConnection(), KisSignalAutoConnectionsStore::clear(), m_canvasController, m_horizontalRuler, m_mouseTrackingConnections, m_verticalRuler, mousePositionChanged(), KoCanvasController::proxyObject, KoRuler::showMousePosition(), and value().

verticalRuler()

KoRuler * KisZoomManager::verticalRuler

(

)

const

Definition at line 199 of file kis_zoom_manager.cc.

{
    return m_verticalRuler;
}

References m_verticalRuler.

zoomAction()

KoZoomAction * KisZoomManager::zoomAction

(

)

const

Definition at line 264 of file kis_zoom_manager.cc.

{
    return m_zoomAction;
}

References m_zoomAction.

zoomActionWidget()

QWidget * KisZoomManager::zoomActionWidget

(

)

const

Definition at line 269 of file kis_zoom_manager.cc.

{
    return m_zoomActionWidget;
}

References m_zoomActionWidget.

zoomTo100

void KisZoomManager::zoomTo100 ( )

slot

Definition at line 296 of file kis_zoom_manager.cc.

{
    m_canvasController->setZoom(KoZoomMode::ZOOM_CONSTANT, 1.0);
}

References m_canvasController, KoCanvasController::setZoom(), and KoZoomMode::ZOOM_CONSTANT.

Member Data Documentation

m_cachedRulersRect

QRect KisZoomManager::m_cachedRulersRect

private

Definition at line 92 of file kis_zoom_manager.h.

m_canvasController

KoCanvasController* KisZoomManager::m_canvasController {nullptr}

private

Definition at line 87 of file kis_zoom_manager.h.

{nullptr};

m_documentRectChangedCompressor

KisSignalCompressor KisZoomManager::m_documentRectChangedCompressor

private

Definition at line 96 of file kis_zoom_manager.h.

m_horizontalRuler

KoRuler* KisZoomManager::m_horizontalRuler {nullptr}

private

Definition at line 88 of file kis_zoom_manager.h.

{nullptr};

m_mouseTrackingConnections

KisSignalAutoConnectionsStore KisZoomManager::m_mouseTrackingConnections

private

Definition at line 93 of file kis_zoom_manager.h.

m_previousZoomLevel

qreal KisZoomManager::m_previousZoomLevel {1.0}

private

Definition at line 97 of file kis_zoom_manager.h.

{1.0};

m_previousZoomMode

KoZoomMode::Mode KisZoomManager::m_previousZoomMode

private

Definition at line 98 of file kis_zoom_manager.h.

m_previousZoomPoint

QPointF KisZoomManager::m_previousZoomPoint

private

Definition at line 99 of file kis_zoom_manager.h.

m_verticalRuler

KoRuler* KisZoomManager::m_verticalRuler {nullptr}

private

Definition at line 89 of file kis_zoom_manager.h.

{nullptr};

m_view

QPointer<KisView> KisZoomManager::m_view

private

Definition at line 85 of file kis_zoom_manager.h.

m_zoomAction

KoZoomAction* KisZoomManager::m_zoomAction {nullptr}

private

Definition at line 90 of file kis_zoom_manager.h.

{nullptr};

m_zoomActionWidget

QPointer<QWidget> KisZoomManager::m_zoomActionWidget

private

Definition at line 91 of file kis_zoom_manager.h.

m_zoomChangedCompressor

KisSignalCompressor KisZoomManager::m_zoomChangedCompressor

private

Definition at line 95 of file kis_zoom_manager.h.

m_zoomHandler

KoZoomHandler* KisZoomManager::m_zoomHandler {nullptr}

private

Definition at line 86 of file kis_zoom_manager.h.

{nullptr};

---

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

• libs/ui/kis_zoom_manager.h
• libs/ui/kis_zoom_manager.cc