Scratchpad
#include <Scratchpad.h>
Signals | |
void | contentChanged () |
void | scaleChanged (qreal scale) |
void | viewportChanged (const QRect rect) |
Public Slots | |
bool | canvasZoomLink () |
void | clear () |
QRect | contentBounds () const |
QImage | copyScratchpadImageData () |
void | fillBackground () |
void | fillDefault () |
void | fillDocument (bool fullContent=true) |
void | fillForeground () |
void | fillGradient (const QPoint &gradientVectorStart=QPoint(), const QPoint &gradientVectorEnd=QPoint(), const QString &gradientShape="linear", const QString &gradientRepeat="none", bool reverseGradient=false, bool dither=false) |
void | fillLayer (bool fullContent=true) |
void | fillPattern (QTransform transform=QTransform()) |
void | fillTransparent () |
void | linkCanvasZoom (bool value) |
void | loadScratchpadImage (QImage image) |
void | panCenter () |
void | panTo (qint32 x, qint32 y) |
qreal | scale () |
void | scaleReset () |
void | scaleToFit () |
void | setCanvasZoomLink (bool value) |
void | setFillColor (QColor color) |
void | setMode (QString modeName) |
void | setModeManually (bool value) |
bool | setScale (qreal scale) const |
QRect | viewportBounds () const |
Public Member Functions | |
Scratchpad (View *view, const QColor &defaultColor, QWidget *parent=0) | |
Public Member Functions inherited from QWidget | |
QWidget (QWidget *parent, Qt::WindowFlags f) | |
bool | acceptDrops () const const |
QString | accessibleDescription () const const |
QString | accessibleName () const const |
QList< QAction * > | actions () const const |
void | activateWindow () |
QAction * | addAction (const QIcon &icon, const QString &text) |
QAction * | addAction (const QIcon &icon, const QString &text, Args &&... args) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QString &text) |
QAction * | addAction (const QString &text, Args &&... args) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut, Args &&... args) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type) |
void | addAction (QAction *action) |
void | addActions (const QList< QAction * > &actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (int x, int y) const const |
QRect | childrenRect () const const |
QRegion | childrenRegion () const const |
void | clearFocus () |
void | clearMask () |
bool | close () |
QMargins | contentsMargins () const const |
QRect | contentsRect () const const |
Qt::ContextMenuPolicy | contextMenuPolicy () const const |
QCursor | cursor () const const |
void | customContextMenuRequested (const QPoint &pos) |
WId | effectiveWinId () const const |
void | ensurePolished () const const |
Qt::FocusPolicy | focusPolicy () const const |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () const const |
QPixmap | grab (const QRect &rectangle) |
void | grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags) |
void | grabKeyboard () |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
bool | hasEditFocus () const const |
bool | hasFocus () const const |
virtual bool | hasHeightForWidth () const const |
bool | hasMouseTracking () const const |
bool | hasTabletTracking () const const |
int | height () const const |
virtual int | heightForWidth (int w) const const |
void | hide () |
Qt::InputMethodHints | inputMethodHints () const const |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const const |
void | insertAction (QAction *before, QAction *action) |
void | insertActions (QAction *before, const QList< QAction * > &actions) |
bool | isActiveWindow () const const |
bool | isAncestorOf (const QWidget *child) const const |
bool | isEnabled () const const |
bool | isEnabledTo (const QWidget *ancestor) const const |
bool | isFullScreen () const const |
bool | isHidden () const const |
bool | isMaximized () const const |
bool | isMinimized () const const |
bool | isModal () const const |
bool | isTopLevel () const const |
bool | isVisible () const const |
bool | isVisibleTo (const QWidget *ancestor) const const |
bool | isWindow () const const |
bool | isWindowModified () const const |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPointF | mapFrom (const QWidget *parent, const QPointF &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPointF | mapFromGlobal (const QPointF &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPointF | mapFromParent (const QPointF &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPointF | mapTo (const QWidget *parent, const QPointF &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPointF | mapToGlobal (const QPointF &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QPointF | mapToParent (const QPointF &pos) const const |
QRegion | mask () const const |
int | maximumHeight () const const |
QSize | maximumSize () const const |
int | maximumWidth () const const |
int | minimumHeight () const const |
QSize | minimumSize () const const |
virtual QSize | minimumSizeHint () const const |
int | minimumWidth () const const |
void | move (const QPoint &) |
void | move (int x, int y) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () const const |
QWIDGETSIZE_MAX QWIDGETSIZE_MAX | |
void | raise () |
QRect | rect () const const |
void | releaseKeyboard () |
void | releaseMouse () |
void | releaseShortcut (int id) |
void | removeAction (QAction *action) |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags) |
void | repaint () |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | resize (const QSize &) |
void | resize (int w, int h) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const const |
QScreen * | screen () const const |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
void | setAcceptDrops (bool on) |
void | setAccessibleDescription (const QString &description) |
void | setAccessibleName (const QString &name) |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
void | setAutoFillBackground (bool enabled) |
void | setBackgroundRole (QPalette::ColorRole role) |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setContentsMargins (const QMargins &margins) |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | setCursor (const QCursor &) |
void | setDisabled (bool disable) |
void | setEditFocus (bool enable) |
void | setEnabled (bool) |
void | setFixedHeight (int h) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFocus () |
void | setFocus (Qt::FocusReason reason) |
void | setFocusPolicy (Qt::FocusPolicy policy) |
void | setFocusProxy (QWidget *w) |
void | setFont (const QFont &) |
void | setForegroundRole (QPalette::ColorRole role) |
void | setGeometry (const QRect &) |
void | setGeometry (int x, int y, int w, int h) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setHidden (bool hidden) |
void | setInputMethodHints (Qt::InputMethodHints hints) |
void | setLayout (QLayout *layout) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
void | setLocale (const QLocale &locale) |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMaximumWidth (int maxw) |
void | setMinimumHeight (int minh) |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
void | setMinimumWidth (int minw) |
void | setMouseTracking (bool enable) |
void | setPalette (const QPalette &) |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | setScreen (QScreen *screen) |
void | setShortcutAutoRepeat (int id, bool enable) |
void | setShortcutEnabled (int id, bool enable) |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
void | setStatusTip (const QString &) |
void | setStyle (QStyle *style) |
void | setStyleSheet (const QString &styleSheet) |
void | setTabletTracking (bool enable) |
void | setToolTip (const QString &) |
void | setToolTipDuration (int msec) |
void | setUpdatesEnabled (bool enable) |
void | setupUi (QWidget *widget) |
virtual void | setVisible (bool visible) |
void | setWhatsThis (const QString &) |
void | setWindowFilePath (const QString &filePath) |
void | setWindowFlag (Qt::WindowType flag, bool on) |
void | setWindowFlags (Qt::WindowFlags type) |
void | setWindowIcon (const QIcon &icon) |
void | setWindowIconText (const QString &) |
void | setWindowModality (Qt::WindowModality windowModality) |
void | setWindowModified (bool) |
void | setWindowOpacity (qreal level) |
void | setWindowRole (const QString &role) |
void | setWindowState (Qt::WindowStates windowState) |
void | setWindowTitle (const QString &) |
void | show () |
void | showFullScreen () |
void | showMaximized () |
void | showMinimized () |
void | showNormal () |
QSize | size () const const |
virtual QSize | sizeHint () const const |
QSize | sizeIncrement () const const |
QSizePolicy | sizePolicy () const const |
void | stackUnder (QWidget *w) |
QString | statusTip () const const |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () const const |
bool | underMouse () const const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | update () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | updateGeometry () |
bool | updatesEnabled () const const |
QRegion | visibleRegion () const const |
QString | whatsThis () const const |
int | width () const const |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () const const |
QIcon | windowIcon () const const |
void | windowIconChanged (const QIcon &icon) |
QString | windowIconText () const const |
void | windowIconTextChanged (const QString &iconText) |
Qt::WindowModality | windowModality () const const |
qreal | windowOpacity () const const |
QString | windowRole () const const |
Qt::WindowStates | windowState () const const |
QString | windowTitle () const const |
void | windowTitleChanged (const QString &title) |
Qt::WindowType | windowType () const const |
WId | winId () const const |
int | x () const const |
int | y () const const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Public Member Functions inherited from QPaintDevice | |
int | colorCount () const const |
int | depth () const const |
qreal | devicePixelRatio () const const |
qreal | devicePixelRatioF () const const |
int | height () const const |
int | heightMM () const const |
int | logicalDpiX () const const |
int | logicalDpiY () const const |
bool | paintingActive () const const |
int | physicalDpiX () const const |
int | physicalDpiY () const const |
int | width () const const |
int | widthMM () const const |
Detailed Description
The Scratchpad class A scratchpad is a type of blank canvas area that can be painted on with the normal painting devices.
Definition at line 27 of file Scratchpad.h.
Constructor & Destructor Documentation
◆ Scratchpad()
Definition at line 27 of file Scratchpad.cpp.
◆ ~Scratchpad()
Scratchpad::~Scratchpad | ( | ) |
Definition at line 47 of file Scratchpad.cpp.
Member Function Documentation
◆ canvasZoomLink
|
slot |
return if scratchpad zoom level is linked with current view zoom level
- Returns
- return True if connection between the zoom of the canvas and scratchpad (so they zoom in sync) is active
Definition at line 72 of file Scratchpad.cpp.
◆ clear
|
slot |
Clears out scratchpad with color specified set during setup.
Definition at line 130 of file Scratchpad.cpp.
◆ contentBounds
|
slot |
The content of scratchpad can be bigger or smaller than scratchpad dimension.
The bounds return the area in which there's some content
- Returns
- scratchpad content bounds as a QRect
Definition at line 221 of file Scratchpad.cpp.
◆ contentChanged
|
signal |
signal is emitted when scratchpad content is changed (stroke or fill)
◆ copyScratchpadImageData
|
slot |
Take what is on the scratchpad area and grab image.
- Returns
- the image data from the scratchpad
Definition at line 125 of file Scratchpad.cpp.
◆ fillBackground
|
slot |
Fill the entire scratchpad with current background color.
Definition at line 151 of file Scratchpad.cpp.
◆ fillDefault
|
slot |
Fill the entire scratchpad with default color.
Definition at line 141 of file Scratchpad.cpp.
◆ fillDocument
|
slot |
Fill the entire scratchpad with current document projection content.
- Parameters
-
fullContent when True, full document projection is loaded in scratchpad, otherwise only content matching scratchpad viewport is loaded
Definition at line 206 of file Scratchpad.cpp.
◆ fillForeground
|
slot |
Fill the entire scratchpad with current foreground color.
Definition at line 156 of file Scratchpad.cpp.
◆ fillGradient
|
slot |
Fill the entire scratchpad with current gradient.
- Parameters
-
gradientVectorStart is a QPoint to define origin of gradient Set an empty QPoint() to use default scratchpad top-left gradientVectorEnd is a QPoint to define end of gradient set an empty QPoint() to use default scratchpad bottom-right gradientShape define which gradient to apply, can be: - "linear"
- "bilinear"
- "radial"
- "square"
- "conical"
- "conicalSymmetric"
- "spiral"
- "reverseSpiral"
- "polygonal"
gradientRepeat define how to repeat gradient, can be: - "none"
- "alternate"
- "forwards"
reverseGradient a boolean to define if gradient is reversed or not dither a boolean to define if gradient is dithered or not
Definition at line 161 of file Scratchpad.cpp.
◆ fillLayer
|
slot |
Fill the entire scratchpad with current layer content.
- Parameters
-
fullContent when True, full layer content is loaded in scratchpad, otherwise only content matching scratchpad viewport is loaded
Definition at line 201 of file Scratchpad.cpp.
◆ fillPattern
|
slot |
Fill the entire scratchpad with current pattern.
- Parameters
-
transform is QTransform that let define pattern scale/rotation property
Definition at line 211 of file Scratchpad.cpp.
◆ fillTransparent
|
slot |
Fill the entire scratchpad with a transparent color.
Definition at line 146 of file Scratchpad.cpp.
◆ linkCanvasZoom
|
slot |
DEPRECATED – USE setCanvasZoomLink() instead Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync.
- Parameters
-
value If True (default) the scratchpad will share the current view zoom level. If False, then use scratchpad scale methods to define current zoom level
Definition at line 61 of file Scratchpad.cpp.
◆ loadScratchpadImage
|
slot |
Load image data to the scratchpad.
- Parameters
-
image Image object to load
Definition at line 120 of file Scratchpad.cpp.
◆ panCenter
|
slot |
pan scratchpad content to center content in viewport
Definition at line 115 of file Scratchpad.cpp.
◆ panTo
|
slot |
pan scratchpad content to top-left position of scratchpad viewport Provided value are absolute
- Parameters
-
x abscissa position to pan to y ordinate position to pan to
Definition at line 110 of file Scratchpad.cpp.
◆ scale
|
slot |
return current zoom level applied on scratchpad (whatever the zoom source is: view zoom level or set manually)
- Returns
- a float value (1.00 = 100%)
Definition at line 77 of file Scratchpad.cpp.
◆ scaleChanged
|
signal |
signal is emitted when scratchpad scale is changed (from zoom canvas or manually)
- Parameters
-
scale updated scale value (1.00 = 100%)
◆ scaleReset
|
slot |
reset scale and pan to origin Note: call method is ignored if canvasZoomLink() is True
Definition at line 101 of file Scratchpad.cpp.
◆ scaleToFit
|
slot |
calculate scale automatically to fit scratchpad content in scratchpad viewport Note: call method is ignored if canvasZoomLink() is True
Definition at line 92 of file Scratchpad.cpp.
◆ setCanvasZoomLink
|
slot |
Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync.
- Parameters
-
value If True (default) the scratchpad will share the current view zoom level. If False, then use scratchpad scale methods to define current zoom level
Definition at line 67 of file Scratchpad.cpp.
◆ setFillColor
|
slot |
Define default fill color for scratchpad.
- Parameters
-
Color to fill the canvas with
Definition at line 136 of file Scratchpad.cpp.
◆ setMode
|
slot |
Manually set what mode scratchpad is in.
Ignored if "setModeManually is set to false @param modeName Available options are: - "painting" - "panning" - "colorsampling"
Definition at line 56 of file Scratchpad.cpp.
◆ setModeManually
|
slot |
Switches between a GUI controlling the current mode and when mouse clicks control mode.
- Parameters
-
value Set to True allows GUI to control the mode with explicitly setting mode
Definition at line 51 of file Scratchpad.cpp.
◆ setScale
|
slot |
allow to manually set scratchpad zoom level Note: call method is ignored if canvasZoomLink() is True,
- Parameters
-
scale zoom level to apply (1.00 = 100%)
- Returns
- if scale has been applied return True, otherwise return False
Definition at line 83 of file Scratchpad.cpp.
◆ viewportBounds
|
slot |
The viewport indicates which part of scratchpad content is visible.
It takes in account the current translation & scale
Example 1:
- Scratchpad size: 500x500
- Scratchpad content: 2000x2000
- Scratchpad scale: 1.0
- Scratchpad pan: 0, 0 Returned viewport is a QRect(0, 0, 500, 500) matching content really visible in scratchpad. If scale is 2.00, returned viewport will be QRect(0, 0, 250, 250) If scale is 0.50, returned viewport will be QRect(0, 0, 1000, 1000)
Example 2:
- Scratchpad size: 500x500
- Scratchpad content: 2000x2000
- Scratchpad scale: 2.0
- Scratchpad pan: 500, 1500 Returned viewport is a QRect(500, 1500, 250, 250) matching content really visible in scratchpad.
- Returns
- scratchpad viewport bounds as a QRect
Definition at line 216 of file Scratchpad.cpp.
◆ viewportChanged
|
signal |
signal is emitted when scratchpad viewport has been modified (pan, zoom)
- Parameters
-
rect new viewport bounds
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:13:08 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.