ImageDocument

Search for usage in LXR

ImageDocument Class Reference

#include <imagedocument.h>

Inheritance diagram for ImageDocument:

Properties

bool edited
 
QImage image
 
QUrl path
 
- Properties inherited from QObject
 objectName
 

Signals

void editedChanged ()
 
void imageChanged ()
 
void pathChanged (const QUrl &url)
 

Public Member Functions

 ImageDocument (QObject *parent=nullptr)
 
Q_INVOKABLE void cancel ()
 
Q_INVOKABLE void crop (int x, int y, int width, int height)
 
bool edited () const
 
QImage image () const
 
Q_INVOKABLE void mirror (bool horizontal, bool vertical)
 
QUrl path () const
 
Q_INVOKABLE void resize (int width, int height)
 
Q_INVOKABLE void rotate (int angle)
 
Q_INVOKABLE bool save ()
 
Q_INVOKABLE bool saveAs (const QUrl &location)
 
void setEdited (bool value)
 
void setPath (const QUrl &path)
 
Q_INVOKABLE void undo ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

An ImageDocument is the base class of the ImageEditor.

This class handles various image manipulation and contains an undo stack to allow reverting the last actions. This class does not display the image, use ImageItem for this task.

KQuickImageEditor.ImageDocument {
id: imageDocument
path: myModel.image
}
Kirigami.Actions {
iconName: "object-rotate-left"
onTriggered: imageDocument.rotate(-90);
}
KQuickImageEditor.ImageItem {
image: imageDocument.image
}

Definition at line 39 of file imagedocument.h.

Member Function Documentation

void ImageDocument::cancel ( )

Cancel all the edit.

Definition at line 32 of file imagedocument.cpp.

void ImageDocument::crop ( int  x,
int  y,
int  width,
int  height 
)

Crop the image.

Parameters
xThe x coordinate of the new image in the old image.
yThe y coordinate of the new image in the old image.
widthThe width of the new image.
heightThe height of the new image.

Definition at line 65 of file imagedocument.cpp.

bool ImageDocument::edited ( ) const

This propriety store if the document was changed or not.

See also
setEdited
editedChanged
QImage ImageDocument::image ( ) const

The image was is displayed.

This propriety is updated when the path change or commands are applied.

See also
imageChanged
void ImageDocument::mirror ( bool  horizontal,
bool  vertical 
)

Mirror the image.

Parameters
horizontalMirror the image horizontally.
verticalMirror the image vertically.

Definition at line 83 of file imagedocument.cpp.

void ImageDocument::resize ( int  width,
int  height 
)

Resize the image.

Parameters
widthThe width of the new image.
heightThe height of the new image.

Definition at line 74 of file imagedocument.cpp.

void ImageDocument::rotate ( int  angle)

Rotate the image.

Parameters
angleThe angle of the rotation in degree.

Definition at line 92 of file imagedocument.cpp.

bool ImageDocument::save ( )

Save current edited image in place.

This is a destructive operation and can't be reverted.

Returns
true iff the file saving operation was successful.

Definition at line 113 of file imagedocument.cpp.

bool ImageDocument::saveAs ( const QUrl location)

Save current edited image as a new image.

Parameters
locationThe location where to save the new image.
Returns
true iff the file saving operattion was successful.

Definition at line 118 of file imagedocument.cpp.

void ImageDocument::setEdited ( bool  value)

Change the edited value.

Parameters
valueThe new value.

Definition at line 103 of file imagedocument.cpp.

void ImageDocument::undo ( )

Undo the last edit on the images.

Definition at line 53 of file imagedocument.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Oct 16 2021 23:07:50 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.