API reference - Class QSvgWidget

Notation used in Ruby API documentation

Module: QtSvg

Description: Binding of QSvgWidget

Class hierarchy: QSvgWidget » QWidget » QObject

Public constructors

new QSvgWidgetnew(QWidget ptr parent = 0)Constructor QSvgWidget::QSvgWidget(QWidget *parent)
new QSvgWidgetnew(string file,
QWidget ptr parent = 0)
Constructor QSvgWidget::QSvgWidget(const QString &file, QWidget *parent)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSvgWidget::eventFilter(QObject *, QEvent *)
[const]boolhasHeightForWidthVirtual method bool QSvgWidget::hasHeightForWidth()
[const]intheightForWidth(int arg1)Virtual method int QSvgWidget::heightForWidth(int)
[const]variantinputMethodQuery(const Qt_InputMethodQuery arg1)Virtual method QVariant QSvgWidget::inputMethodQuery(Qt::InputMethodQuery)
voidload(string file)Method void QSvgWidget::load(const QString &file)
voidload(bytes contents)Method void QSvgWidget::load(const QByteArray &contents)
[const]QSizeminimumSizeHintVirtual method QSize QSvgWidget::minimumSizeHint()
[const]QPaintEngine ptrpaintEngineVirtual method QPaintEngine *QSvgWidget::paintEngine()
[const]QSvgRenderer ptrrendererMethod QSvgRenderer *QSvgWidget::renderer()
voidsetVisible(bool visible)Virtual method void QSvgWidget::setVisible(bool visible)
[const]QSizesizeHintVirtual method QSize QSvgWidget::sizeHint()

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QSvgWidget::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QSvgWidget::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidactionEvent(QActionEvent ptr arg1)Virtual method void QSvgWidget::actionEvent(QActionEvent *)
voidchangeEvent(QEvent ptr arg1)Virtual method void QSvgWidget::changeEvent(QEvent *)
voidchildEvent(QChildEvent ptr arg1)Virtual method void QSvgWidget::childEvent(QChildEvent *)
voidcloseEvent(QCloseEvent ptr arg1)Virtual method void QSvgWidget::closeEvent(QCloseEvent *)
voidcontextMenuEvent(QContextMenuEvent ptr arg1)Virtual method void QSvgWidget::contextMenuEvent(QContextMenuEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QSvgWidget::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QSvgWidget::disconnectNotify(const QMetaMethod &signal)
voiddragEnterEvent(QDragEnterEvent ptr arg1)Virtual method void QSvgWidget::dragEnterEvent(QDragEnterEvent *)
voiddragLeaveEvent(QDragLeaveEvent ptr arg1)Virtual method void QSvgWidget::dragLeaveEvent(QDragLeaveEvent *)
voiddragMoveEvent(QDragMoveEvent ptr arg1)Virtual method void QSvgWidget::dragMoveEvent(QDragMoveEvent *)
voiddropEvent(QDropEvent ptr arg1)Virtual method void QSvgWidget::dropEvent(QDropEvent *)
voidenterEvent(QEvent ptr arg1)Virtual method void QSvgWidget::enterEvent(QEvent *)
boolevent(QEvent ptr arg1)Virtual method bool QSvgWidget::event(QEvent *)
voidfocusInEvent(QFocusEvent ptr arg1)Virtual method void QSvgWidget::focusInEvent(QFocusEvent *)
boolfocusNextChildMethod bool QSvgWidget::focusNextChild()
boolfocusNextPrevChild(bool next)Virtual method bool QSvgWidget::focusNextPrevChild(bool next)
voidfocusOutEvent(QFocusEvent ptr arg1)Virtual method void QSvgWidget::focusOutEvent(QFocusEvent *)
boolfocusPreviousChildMethod bool QSvgWidget::focusPreviousChild()
voidhideEvent(QHideEvent ptr arg1)Virtual method void QSvgWidget::hideEvent(QHideEvent *)
[const]voidinitPainter(QPainter ptr painter)Virtual method void QSvgWidget::initPainter(QPainter *painter)
voidinputMethodEvent(QInputMethodEvent ptr arg1)Virtual method void QSvgWidget::inputMethodEvent(QInputMethodEvent *)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QSvgWidget::isSignalConnected(const QMetaMethod &signal)
voidkeyPressEvent(QKeyEvent ptr arg1)Virtual method void QSvgWidget::keyPressEvent(QKeyEvent *)
voidkeyReleaseEvent(QKeyEvent ptr arg1)Virtual method void QSvgWidget::keyReleaseEvent(QKeyEvent *)
voidleaveEvent(QEvent ptr arg1)Virtual method void QSvgWidget::leaveEvent(QEvent *)
[const]intmetric(const QPaintDevice_PaintDeviceMetric arg1)Virtual method int QSvgWidget::metric(QPaintDevice::PaintDeviceMetric)
voidmouseDoubleClickEvent(QMouseEvent ptr arg1)Virtual method void QSvgWidget::mouseDoubleClickEvent(QMouseEvent *)
voidmouseMoveEvent(QMouseEvent ptr arg1)Virtual method void QSvgWidget::mouseMoveEvent(QMouseEvent *)
voidmousePressEvent(QMouseEvent ptr arg1)Virtual method void QSvgWidget::mousePressEvent(QMouseEvent *)
voidmouseReleaseEvent(QMouseEvent ptr arg1)Virtual method void QSvgWidget::mouseReleaseEvent(QMouseEvent *)
voidmoveEvent(QMoveEvent ptr arg1)Virtual method void QSvgWidget::moveEvent(QMoveEvent *)
boolnativeEvent(bytes eventType,
void * message,
long ptr result)
Virtual method bool QSvgWidget::nativeEvent(const QByteArray &eventType, void *message, long int *result)
voidpaintEvent(QPaintEvent ptr event)Virtual method void QSvgWidget::paintEvent(QPaintEvent *event)
voidqt_create(unsigned long long arg1 = 0,
bool initializeWindow = true,
bool destroyOldWindow = true)
Method void QSvgWidget::create(WId, bool initializeWindow, bool destroyOldWindow)
voidqt_destroy(bool destroyWindow = true,
bool destroySubWindows = true)
Method void QSvgWidget::destroy(bool destroyWindow, bool destroySubWindows)
[const]intreceivers(string signal)Method int QSvgWidget::receivers(const char *signal)
[const]QPaintDevice ptrredirected(QPoint ptr offset)Virtual method QPaintDevice *QSvgWidget::redirected(QPoint *offset)
voidresizeEvent(QResizeEvent ptr arg1)Virtual method void QSvgWidget::resizeEvent(QResizeEvent *)
[const]QObject ptrsenderMethod QObject *QSvgWidget::sender()
[const]intsenderSignalIndexMethod int QSvgWidget::senderSignalIndex()
[const]QPainter ptrsharedPainterVirtual method QPainter *QSvgWidget::sharedPainter()
voidshowEvent(QShowEvent ptr arg1)Virtual method void QSvgWidget::showEvent(QShowEvent *)
voidtabletEvent(QTabletEvent ptr arg1)Virtual method void QSvgWidget::tabletEvent(QTabletEvent *)
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSvgWidget::timerEvent(QTimerEvent *)
voidupdateMicroFocusMethod void QSvgWidget::updateMicroFocus()
voidwheelEvent(QWheelEvent ptr arg1)Virtual method void QSvgWidget::wheelEvent(QWheelEvent *)

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

actionEvent

Signature: void actionEvent (QActionEvent ptr arg1)

Description: Virtual method void QSvgWidget::actionEvent(QActionEvent *)

This method can be reimplemented in a derived class.

changeEvent

Signature: void changeEvent (QEvent ptr arg1)

Description: Virtual method void QSvgWidget::changeEvent(QEvent *)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QSvgWidget::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

closeEvent

Signature: void closeEvent (QCloseEvent ptr arg1)

Description: Virtual method void QSvgWidget::closeEvent(QCloseEvent *)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QContextMenuEvent ptr arg1)

Description: Virtual method void QSvgWidget::contextMenuEvent(QContextMenuEvent *)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QSvgWidget::customEvent(QEvent *)

This method can be reimplemented in a derived class.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSvgWidget::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

dragEnterEvent

Signature: void dragEnterEvent (QDragEnterEvent ptr arg1)

Description: Virtual method void QSvgWidget::dragEnterEvent(QDragEnterEvent *)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QDragLeaveEvent ptr arg1)

Description: Virtual method void QSvgWidget::dragLeaveEvent(QDragLeaveEvent *)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QDragMoveEvent ptr arg1)

Description: Virtual method void QSvgWidget::dragMoveEvent(QDragMoveEvent *)

This method can be reimplemented in a derived class.

dropEvent

Signature: void dropEvent (QDropEvent ptr arg1)

Description: Virtual method void QSvgWidget::dropEvent(QDropEvent *)

This method can be reimplemented in a derived class.

enterEvent

Signature: void enterEvent (QEvent ptr arg1)

Description: Virtual method void QSvgWidget::enterEvent(QEvent *)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QSvgWidget::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QSvgWidget::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr arg1)

Description: Virtual method void QSvgWidget::focusInEvent(QFocusEvent *)

This method can be reimplemented in a derived class.

focusNextChild

Signature: bool focusNextChild

Description: Method bool QSvgWidget::focusNextChild()

This method is protected and can only be called from inside a derived class.

focusNextPrevChild

Signature: bool focusNextPrevChild (bool next)

Description: Virtual method bool QSvgWidget::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr arg1)

Description: Virtual method void QSvgWidget::focusOutEvent(QFocusEvent *)

This method can be reimplemented in a derived class.

focusPreviousChild

Signature: bool focusPreviousChild

Description: Method bool QSvgWidget::focusPreviousChild()

This method is protected and can only be called from inside a derived class.

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QSvgWidget::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

Description: Virtual method int QSvgWidget::heightForWidth(int)

This method can be reimplemented in a derived class.

hideEvent

Signature: void hideEvent (QHideEvent ptr arg1)

Description: Virtual method void QSvgWidget::hideEvent(QHideEvent *)

This method can be reimplemented in a derived class.

initPainter

Signature: [const] void initPainter (QPainter ptr painter)

Description: Virtual method void QSvgWidget::initPainter(QPainter *painter)

This method can be reimplemented in a derived class.

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr arg1)

Description: Virtual method void QSvgWidget::inputMethodEvent(QInputMethodEvent *)

This method can be reimplemented in a derived class.

inputMethodQuery

Signature: [const] variant inputMethodQuery (const Qt_InputMethodQuery arg1)

Description: Virtual method QVariant QSvgWidget::inputMethodQuery(Qt::InputMethodQuery)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSvgWidget::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr arg1)

Description: Virtual method void QSvgWidget::keyPressEvent(QKeyEvent *)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr arg1)

Description: Virtual method void QSvgWidget::keyReleaseEvent(QKeyEvent *)

This method can be reimplemented in a derived class.

leaveEvent

Signature: void leaveEvent (QEvent ptr arg1)

Description: Virtual method void QSvgWidget::leaveEvent(QEvent *)

This method can be reimplemented in a derived class.

load

(1) Signature: void load (string file)

Description: Method void QSvgWidget::load(const QString &file)

(2) Signature: void load (bytes contents)

Description: Method void QSvgWidget::load(const QByteArray &contents)

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QSvgWidget::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

minimumSizeHint

Signature: [const] QSize minimumSizeHint

Description: Virtual method QSize QSvgWidget::minimumSizeHint()

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QMouseEvent ptr arg1)

Description: Virtual method void QSvgWidget::mouseDoubleClickEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QMouseEvent ptr arg1)

Description: Virtual method void QSvgWidget::mouseMoveEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QMouseEvent ptr arg1)

Description: Virtual method void QSvgWidget::mousePressEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QMouseEvent ptr arg1)

Description: Virtual method void QSvgWidget::mouseReleaseEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

moveEvent

Signature: void moveEvent (QMoveEvent ptr arg1)

Description: Virtual method void QSvgWidget::moveEvent(QMoveEvent *)

This method can be reimplemented in a derived class.

nativeEvent

Signature: bool nativeEvent (bytes eventType, void * message, long ptr result)

Description: Virtual method bool QSvgWidget::nativeEvent(const QByteArray &eventType, void *message, long int *result)

This method can be reimplemented in a derived class.

new

(1) Signature: [static] new QSvgWidget new (QWidget ptr parent = 0)

Description: Constructor QSvgWidget::QSvgWidget(QWidget *parent)

This method creates an object of class QSvgWidget.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSvgWidget new (string file, QWidget ptr parent = 0)

Description: Constructor QSvgWidget::QSvgWidget(const QString &file, QWidget *parent)

This method creates an object of class QSvgWidget.

Python specific notes:
This method is the default initializer of the object.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QSvgWidget::paintEngine()

This method can be reimplemented in a derived class.

paintEvent

Signature: void paintEvent (QPaintEvent ptr event)

Description: Virtual method void QSvgWidget::paintEvent(QPaintEvent *event)

This method can be reimplemented in a derived class.

qt_create

Signature: void qt_create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QSvgWidget::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

qt_destroy

Signature: void qt_destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QSvgWidget::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSvgWidget::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

redirected

Signature: [const] QPaintDevice ptr redirected (QPoint ptr offset)

Description: Virtual method QPaintDevice *QSvgWidget::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

renderer

Signature: [const] QSvgRenderer ptr renderer

Description: Method QSvgRenderer *QSvgWidget::renderer()

resizeEvent

Signature: void resizeEvent (QResizeEvent ptr arg1)

Description: Virtual method void QSvgWidget::resizeEvent(QResizeEvent *)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSvgWidget::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSvgWidget::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setVisible

Signature: void setVisible (bool visible)

Description: Virtual method void QSvgWidget::setVisible(bool visible)

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

Description: Virtual method QPainter *QSvgWidget::sharedPainter()

This method can be reimplemented in a derived class.

showEvent

Signature: void showEvent (QShowEvent ptr arg1)

Description: Virtual method void QSvgWidget::showEvent(QShowEvent *)

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QSvgWidget::sizeHint()

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tabletEvent

Signature: void tabletEvent (QTabletEvent ptr arg1)

Description: Virtual method void QSvgWidget::tabletEvent(QTabletEvent *)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QSvgWidget::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QSvgWidget::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QSvgWidget::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

updateMicroFocus

Signature: void updateMicroFocus

Description: Method void QSvgWidget::updateMicroFocus()

This method is protected and can only be called from inside a derived class.

wheelEvent

Signature: void wheelEvent (QWheelEvent ptr arg1)

Description: Virtual method void QSvgWidget::wheelEvent(QWheelEvent *)

This method can be reimplemented in a derived class.