KoZoomAction Class Reference

#include <KoZoomAction.h>

Inheritance diagram for KoZoomAction:

Public Slots
void	setUsePrintResolutionMode (bool value)
void	slotZoomStateChanged (const KoZoomState &zoomState)

Signals
void	sigInternalUpdateUsePrintResolutionMode (bool value)
void	sigInternalUpdateZoomLevelsComboState (const QStringList &values, int index, const QString &activeText)
void	sigInternalUpdateZoomLevelsSliderState (int size, int index)
void	sigUsePrintResolutionModeChanged (bool value)
void	zoomChanged (KoZoomMode::Mode mode, qreal zoom)

Public Member Functions
QWidget *	createWidget (QWidget *parent) override
	KoZoomAction (const QString &text, QObject *parent)
	Private (KoZoomAction *_parent)
	~KoZoomAction () override

Public Attributes
KoZoomActionState	currentActionState
KoZoomState	currentZoomState
KisSignalCompressor	guiUpdateCompressor
KoZoomAction *	parent {nullptr}

Protected Slots
void	sliderValueChanged (int value)
void	slotTextZoomChanged (const QString &value)
void	slotUpdateGuiAfterZoom ()
void	slotZoomLevelChangedIndex (int index)

Protected Member Functions
void	regenerateItems ()
void	syncSliderWithZoom ()

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

Class KoZoomAction implements an action to provide zoom values. In a toolbar, KoZoomAction will show a dropdown list (combobox), also with the possibility for the user to enter arbitrary zoom value (must be an integer). The values shown on the list are always sorted. In a statusbar it provides a scale (slider) plus an editable value plus some buttons for special zoommodes

Definition at line 26 of file KoZoomAction.cpp.

Constructor & Destructor Documentation

KoZoomAction()

KoZoomAction::KoZoomAction	(	const QString &	text,
		QObject *	parent )

Creates a new zoom action.

Parameters

zoomModes	which zoom modes that should be shown
text	The text that will be displayed.
parent	The action's parent object.

Definition at line 45 of file KoZoomAction.cpp.

    : KSelectAction(text, parent)
    , d(new Private(this))
{
    setIcon(koIcon("zoom-original"));
    setEditable( true );
    setMaxComboViewCount( 15 );
 
    regenerateItems();
    connect(&d->guiUpdateCompressor, SIGNAL(timeout()), SLOT(slotUpdateGuiAfterZoom()));
}

References connect(), d, koIcon, regenerateItems(), and slotUpdateGuiAfterZoom().

~KoZoomAction()

KoZoomAction::~KoZoomAction ( )

override

Definition at line 57 of file KoZoomAction.cpp.

{
    delete d;
}

References d.

Member Function Documentation

createWidget()

QWidget * KoZoomAction::createWidget ( QWidget * parent )

override

Reimplemented from QWidgetAction.

Definition at line 157 of file KoZoomAction.cpp.

{
    KoZoomWidget* zoomWidget = new KoZoomWidget(parent, d->currentActionState.standardLevels.size());
 
    connect(this, &KoZoomAction::sigInternalUpdateZoomLevelsComboState, zoomWidget, &KoZoomWidget::setZoomLevelsState);
    connect(this, &KoZoomAction::sigInternalUpdateZoomLevelsSliderState, zoomWidget, &KoZoomWidget::setSliderState);
    connect(this, &KoZoomAction::sigInternalUpdateUsePrintResolutionMode, zoomWidget, &KoZoomWidget::setUsePrintResolutionMode);
 
    connect(zoomWidget, SIGNAL(zoomLevelChanged(QString)), this, SLOT(slotTextZoomChanged(QString)));
    connect(zoomWidget, SIGNAL(sliderValueChanged(int)), this, SLOT(sliderValueChanged(int)));
    connect(zoomWidget, SIGNAL(zoomLevelChangedIndex(int)), this, SLOT(slotZoomLevelChangedIndex(int)));
    connect(zoomWidget, SIGNAL(sigUsePrintResolutionModeChanged(bool)), this, SIGNAL(sigUsePrintResolutionModeChanged(bool)));
 
    syncSliderWithZoom();
    regenerateItems();
 
    return zoomWidget;
}

References connect(), d, parent, regenerateItems(), KoZoomWidget::setSliderState(), KoZoomWidget::setUsePrintResolutionMode(), KoZoomWidget::setZoomLevelsState(), sigInternalUpdateUsePrintResolutionMode(), sigInternalUpdateZoomLevelsComboState(), sigInternalUpdateZoomLevelsSliderState(), sigUsePrintResolutionModeChanged(), sliderValueChanged(), slotTextZoomChanged(), slotZoomLevelChangedIndex(), and syncSliderWithZoom().

Private()

KoZoomAction::Private ( KoZoomAction * _parent )

inline

Definition at line 30 of file KoZoomAction.cpp.

        : parent(_parent)
        , guiUpdateCompressor(200, KisSignalCompressor::FIRST_ACTIVE)
        , currentActionState(currentZoomState)
    {}

regenerateItems()

void KoZoomAction::regenerateItems ( )

protected

Definition at line 124 of file KoZoomAction.cpp.

{
    QStringList values;
 
    std::transform(d->currentActionState.realGuiLevels.begin(),
                   d->currentActionState.realGuiLevels.end(),
                   std::back_inserter(values),
                   [](const auto &item) {
                       return std::get<QString>(item);
                   });
 
    {
        QSignalBlocker b(this);
        setItems(values);
        setCurrentItem(d->currentActionState.currentRealLevelIndex);
    }
 
    Q_EMIT sigInternalUpdateZoomLevelsComboState(
        values,
        d->currentActionState.currentRealLevelIndex,
        d->currentActionState.currentRealLevelText);
}

References d, and sigInternalUpdateZoomLevelsComboState().

setUsePrintResolutionMode

void KoZoomAction::setUsePrintResolutionMode ( bool value )

slot

Change status of canvas size mapping button (emits canvasMappingModeChanged(bool) after the change, ALWAYS)

Definition at line 182 of file KoZoomAction.cpp.

{
    Q_EMIT sigInternalUpdateUsePrintResolutionMode(value);
}

References sigInternalUpdateUsePrintResolutionMode(), and value().

sigInternalUpdateUsePrintResolutionMode

void KoZoomAction::sigInternalUpdateUsePrintResolutionMode ( bool value )

signal

sigInternalUpdateZoomLevelsComboState

void KoZoomAction::sigInternalUpdateZoomLevelsComboState ( const QStringList & values, int index, const QString & activeText )

signal

sigInternalUpdateZoomLevelsSliderState

void KoZoomAction::sigInternalUpdateZoomLevelsSliderState ( int size, int index )

signal

sigUsePrintResolutionModeChanged

void KoZoomAction::sigUsePrintResolutionModeChanged ( bool value )

signal

sliderValueChanged

void KoZoomAction::sliderValueChanged ( int value )

protectedslot

Definition at line 147 of file KoZoomAction.cpp.

{
    if (value < 0 || value >= d->currentActionState.standardLevels.size()) return;
 
    KoZoomMode::Mode mode = KoZoomMode::ZOOM_CONSTANT;
    qreal zoom = d->currentActionState.standardLevels[value];
 
    Q_EMIT zoomChanged(mode, zoom);
}

References d, value(), KoZoomMode::ZOOM_CONSTANT, and zoomChanged().

slotTextZoomChanged

void KoZoomAction::slotTextZoomChanged ( const QString & value )

protectedslot

In Turkish language, the percent sign can go before the number...

If the value has been selected from the dropdown, then it has already been activated by slotZoomLevelChangedIndex() and we shouldn't emit it once again.

Definition at line 70 of file KoZoomAction.cpp.

{
    // HACK ALERT: all items in predefined zooms are handled by
    //             slotZoomLevelChangedIndex(), which comes first;
    //             this implementation is for explicitly entered
    //             values only.
 
    bool isValid = false;
    qreal zoom = QLocale().toDouble(value, &isValid);
 
    if (!isValid) {
        using KisPortingUtils::stringRemoveFirst;
        using KisPortingUtils::stringRemoveLast;
 
        QString trimmedValue = value.trimmed();
        if (trimmedValue.endsWith('%')) {
            stringRemoveLast(trimmedValue);
        } else if (trimmedValue.startsWith('%')) {
            stringRemoveFirst(trimmedValue);
        }
        zoom = QLocale().toDouble(trimmedValue, &isValid);
    }
 
    if (isValid) {
        const KoZoomState &zoomState = d->currentActionState.zoomState;
        if (zoomState.mode != KoZoomMode::ZOOM_CONSTANT ||
            qRound(zoomState.zoom * 1000.0) != qRound(zoom * 10.0)) {
 
            Q_EMIT zoomChanged(KoZoomMode::ZOOM_CONSTANT, zoom / 100.0);
        }
 
    }
}

References d, KoZoomState::mode, KisPortingUtils::stringRemoveFirst(), KisPortingUtils::stringRemoveLast(), value(), KoZoomState::zoom, KoZoomMode::ZOOM_CONSTANT, and zoomChanged().

slotUpdateGuiAfterZoom

void KoZoomAction::slotUpdateGuiAfterZoom ( )

protectedslot

Definition at line 176 of file KoZoomAction.cpp.

{
    syncSliderWithZoom();
    regenerateItems();
}

References regenerateItems(), and syncSliderWithZoom().

slotZoomLevelChangedIndex

void KoZoomAction::slotZoomLevelChangedIndex ( int index )

protectedslot

Definition at line 113 of file KoZoomAction.cpp.

{
    if (index < 0 || index >= d->currentActionState.realGuiLevels.size()) return;
    if (index == d->currentActionState.currentRealLevelIndex) return;
 
    KoZoomMode::Mode mode = std::get<KoZoomMode::Mode>(d->currentActionState.realGuiLevels[index]);
    qreal zoom = std::get<qreal>(d->currentActionState.realGuiLevels[index]);
 
    Q_EMIT zoomChanged(mode, zoom);
}

References d, and zoomChanged().

slotZoomStateChanged

void KoZoomAction::slotZoomStateChanged ( const KoZoomState & zoomState )

slot

Definition at line 62 of file KoZoomAction.cpp.

{
    d->currentZoomState = zoomState;
    d->currentActionState.setZoomState(zoomState);
 
    d->guiUpdateCompressor.start();
}

References d.

syncSliderWithZoom()

void KoZoomAction::syncSliderWithZoom ( )

protected

Definition at line 187 of file KoZoomAction.cpp.

{
    const int index = d->currentActionState.calcNearestStandardLevel();
    Q_EMIT sigInternalUpdateZoomLevelsSliderState(d->currentActionState.standardLevels.size(), index);
}

References d, and sigInternalUpdateZoomLevelsSliderState().

zoomChanged

void KoZoomAction::zoomChanged ( KoZoomMode::Mode mode, qreal zoom )

signal

Signal zoomChanged is triggered when user changes the zoom value, either by choosing it from the list or by entering new value.

Parameters

mode	The selected zoom mode
zoom	the zoom, only defined if mode is KoZoomMode::ZOOM_CONSTANT

Member Data Documentation

currentActionState

KoZoomActionState KoZoomAction::currentActionState

Definition at line 41 of file KoZoomAction.cpp.

currentZoomState

KoZoomState KoZoomAction::currentZoomState

Definition at line 38 of file KoZoomAction.cpp.

d

Private* const KoZoomAction::d

private

Definition at line 87 of file KoZoomAction.h.

guiUpdateCompressor

KisSignalCompressor KoZoomAction::guiUpdateCompressor

Definition at line 39 of file KoZoomAction.cpp.

parent

KoZoomAction* KoZoomAction::parent {nullptr}

Definition at line 36 of file KoZoomAction.cpp.

{nullptr};

---

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

• libs/widgets/KoZoomAction.cpp
• libs/widgets/KoZoomAction.h