API reference - Class QToolButton

DelayedPopup

Signature: [static,const] QToolButton_ToolButtonPopupMode DelayedPopup

Description: Enum constant QToolButton::DelayedPopup

Python specific notes:
The object exposes a readable attribute 'DelayedPopup'. This is the getter.

InstantPopup

Signature: [static,const] QToolButton_ToolButtonPopupMode InstantPopup

Description: Enum constant QToolButton::InstantPopup

Python specific notes:
The object exposes a readable attribute 'InstantPopup'. This is the getter.

MenuButtonPopup

Signature: [static,const] QToolButton_ToolButtonPopupMode MenuButtonPopup

Description: Enum constant QToolButton::MenuButtonPopup

Python specific notes:
The object exposes a readable attribute 'MenuButtonPopup'. This is the getter.

_const_cast

Signature: [const] QToolButton ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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 QToolButton::actionEvent(QActionEvent *)

This method can be reimplemented in a derived class.

arrowType

Signature: [const] Qt_ArrowType arrowType

Description: Method Qt::ArrowType QToolButton::arrowType()

Python specific notes:
The object exposes a readable attribute 'arrowType'. This is the getter.

arrowType=

Signature: void arrowType= (const Qt_ArrowType type)

Description: Method void QToolButton::setArrowType(Qt::ArrowType type)

Python specific notes:
The object exposes a writable attribute 'arrowType'. This is the setter.

autoRaise

Signature: [const] bool autoRaise

Description: Method bool QToolButton::autoRaise()

Python specific notes:
The object exposes a readable attribute 'autoRaise'. This is the getter.

autoRaise=

Signature: void autoRaise= (bool enable)

Description: Method void QToolButton::setAutoRaise(bool enable)

Python specific notes:
The object exposes a writable attribute 'autoRaise'. This is the setter.

changeEvent

Signature: void changeEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

checkStateSet

Signature: void checkStateSet

Description: Virtual method void QToolButton::checkStateSet()

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QToolButton::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

clicked

Signature: [signal] void clicked (bool checked)

Description: Signal declaration for QToolButton::clicked(bool checked)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'clicked'. This is the getter.
The object exposes a writable attribute 'clicked'. This is the setter.

closeEvent

Signature: void closeEvent (QCloseEvent ptr event)

Description: Virtual method void QToolButton::closeEvent(QCloseEvent *event)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QContextMenuEvent ptr event)

Description: Virtual method void QToolButton::contextMenuEvent(QContextMenuEvent *event)

This method can be reimplemented in a derived class.

create

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

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

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

customContextMenuRequested

Signature: [signal] void customContextMenuRequested (const QPoint pos)

Description: Signal declaration for QToolButton::customContextMenuRequested(const QPoint &pos)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'customContextMenuRequested'. This is the getter.
The object exposes a writable attribute 'customContextMenuRequested'. This is the setter.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QToolButton::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

defaultAction

Signature: [const] QAction ptr defaultAction

Description: Method QAction *QToolButton::defaultAction()

Python specific notes:
The object exposes a readable attribute 'defaultAction'. This is the getter.

defaultAction=

Signature: void defaultAction= (QAction ptr arg1)

Description: Method void QToolButton::setDefaultAction(QAction *)

Python specific notes:
The object exposes a writable attribute 'defaultAction'. This is the setter.

destroy

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

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

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

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QToolButton::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

dragEnterEvent

Signature: void dragEnterEvent (QDragEnterEvent ptr event)

Description: Virtual method void QToolButton::dragEnterEvent(QDragEnterEvent *event)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QDragLeaveEvent ptr event)

Description: Virtual method void QToolButton::dragLeaveEvent(QDragLeaveEvent *event)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QDragMoveEvent ptr event)

Description: Virtual method void QToolButton::dragMoveEvent(QDragMoveEvent *event)

This method can be reimplemented in a derived class.

dropEvent

Signature: void dropEvent (QDropEvent ptr event)

Description: Virtual method void QToolButton::dropEvent(QDropEvent *event)

This method can be reimplemented in a derived class.

emit_clicked

Signature: void emit_clicked (bool checked = false)

Description: Emitter for signal void QToolButton::clicked(bool checked)

Call this method to emit this signal.

emit_customContextMenuRequested

Signature: void emit_customContextMenuRequested (const QPoint pos)

Description: Emitter for signal void QToolButton::customContextMenuRequested(const QPoint &pos)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QToolButton::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QToolButton::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_pressed

Signature: void emit_pressed

Description: Emitter for signal void QToolButton::pressed()

Call this method to emit this signal.

emit_released

Signature: void emit_released

Description: Emitter for signal void QToolButton::released()

Call this method to emit this signal.

emit_toggled

Signature: void emit_toggled (bool checked)

Description: Emitter for signal void QToolButton::toggled(bool checked)

Call this method to emit this signal.

emit_triggered

Signature: void emit_triggered (QAction ptr arg1)

Description: Emitter for signal void QToolButton::triggered(QAction *)

Call this method to emit this signal.

emit_windowIconChanged

Signature: void emit_windowIconChanged (const QIcon icon)

Description: Emitter for signal void QToolButton::windowIconChanged(const QIcon &icon)

Call this method to emit this signal.

emit_windowIconTextChanged

Signature: void emit_windowIconTextChanged (string iconText)

Description: Emitter for signal void QToolButton::windowIconTextChanged(const QString &iconText)

Call this method to emit this signal.

emit_windowTitleChanged

Signature: void emit_windowTitleChanged (string title)

Description: Emitter for signal void QToolButton::windowTitleChanged(const QString &title)

Call this method to emit this signal.

enterEvent

Signature: void enterEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr e)

Description: Virtual method bool QToolButton::event(QEvent *e)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QToolButton::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr e)

Description: Virtual method void QToolButton::focusInEvent(QFocusEvent *e)

This method can be reimplemented in a derived class.

focusNextChild

Signature: bool focusNextChild

Description: Method bool QToolButton::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 QToolButton::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr e)

Description: Virtual method void QToolButton::focusOutEvent(QFocusEvent *e)

This method can be reimplemented in a derived class.

focusPreviousChild

Signature: bool focusPreviousChild

Description: Method bool QToolButton::focusPreviousChild()

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

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QToolButton::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

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

This method can be reimplemented in a derived class.

hideEvent

Signature: void hideEvent (QHideEvent ptr event)

Description: Virtual method void QToolButton::hideEvent(QHideEvent *event)

This method can be reimplemented in a derived class.

hitButton

Signature: [const] bool hitButton (const QPoint pos)

Description: Virtual method bool QToolButton::hitButton(const QPoint &pos)

This method can be reimplemented in a derived class.

initPainter

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

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

This method can be reimplemented in a derived class.

initStyleOption

Signature: [const] void initStyleOption (QStyleOptionToolButton ptr option)

Description: Method void QToolButton::initStyleOption(QStyleOptionToolButton *option)

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

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr arg1)

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

This method can be reimplemented in a derived class.

inputMethodQuery

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

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

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr e)

Description: Virtual method void QToolButton::keyPressEvent(QKeyEvent *e)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr e)

Description: Virtual method void QToolButton::keyReleaseEvent(QKeyEvent *e)

This method can be reimplemented in a derived class.

leaveEvent

Signature: void leaveEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

menu

Signature: [const] QMenu ptr menu

Description: Method QMenu *QToolButton::menu()

Python specific notes:
The object exposes a readable attribute 'menu'. This is the getter.

menu=

Signature: void menu= (QMenu ptr menu)

Description: Method void QToolButton::setMenu(QMenu *menu)

Python specific notes:
The object exposes a writable attribute 'menu'. This is the setter.

metric

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

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

This method can be reimplemented in a derived class.

minimumSizeHint

Signature: [const] QSize minimumSizeHint

Description: Virtual method QSize QToolButton::minimumSizeHint()

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QMouseEvent ptr event)

Description: Virtual method void QToolButton::mouseDoubleClickEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QMouseEvent ptr e)

Description: Virtual method void QToolButton::mouseMoveEvent(QMouseEvent *e)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QMouseEvent ptr arg1)

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

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QMouseEvent ptr arg1)

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

This method can be reimplemented in a derived class.

moveEvent

Signature: void moveEvent (QMoveEvent ptr event)

Description: Virtual method void QToolButton::moveEvent(QMoveEvent *event)

This method can be reimplemented in a derived class.

nativeEvent

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

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

This method can be reimplemented in a derived class.

new

Signature: [static] new QToolButton new (QWidget ptr parent = nullptr)

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

This method creates an object of class QToolButton.

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

nextCheckState

Signature: void nextCheckState

Description: Virtual method void QToolButton::nextCheckState()

This method can be reimplemented in a derived class.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QToolButton::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

paintEvent

Signature: void paintEvent (QPaintEvent ptr arg1)

Description: Virtual method void QToolButton::paintEvent(QPaintEvent *)

This method can be reimplemented in a derived class.

popupMode

Signature: [const] QToolButton_ToolButtonPopupMode popupMode

Description: Method QToolButton::ToolButtonPopupMode QToolButton::popupMode()

Python specific notes:
The object exposes a readable attribute 'popupMode'. This is the getter.

popupMode=

Signature: void popupMode= (const QToolButton_ToolButtonPopupMode mode)

Description: Method void QToolButton::setPopupMode(QToolButton::ToolButtonPopupMode mode)

Python specific notes:
The object exposes a writable attribute 'popupMode'. This is the setter.

pressed

Signature: [signal] void pressed

Description: Signal declaration for QToolButton::pressed()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'pressed'. This is the getter.
The object exposes a writable attribute 'pressed'. This is the setter.

qt_create

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

Description: Method void QToolButton::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 QToolButton::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 QToolButton::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 *QToolButton::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

released

Signature: [signal] void released

Description: Signal declaration for QToolButton::released()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'released'. This is the getter.
The object exposes a writable attribute 'released'. This is the setter.

resizeEvent

Signature: void resizeEvent (QResizeEvent ptr event)

Description: Virtual method void QToolButton::resizeEvent(QResizeEvent *event)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QToolButton::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QToolButton::senderSignalIndex()

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

setArrowType

Signature: void setArrowType (const Qt_ArrowType type)

Description: Method void QToolButton::setArrowType(Qt::ArrowType type)

Python specific notes:
The object exposes a writable attribute 'arrowType'. This is the setter.

setAutoRaise

Signature: void setAutoRaise (bool enable)

Description: Method void QToolButton::setAutoRaise(bool enable)

Python specific notes:
The object exposes a writable attribute 'autoRaise'. This is the setter.

setDefaultAction

Signature: void setDefaultAction (QAction ptr arg1)

Description: Method void QToolButton::setDefaultAction(QAction *)

Python specific notes:
The object exposes a writable attribute 'defaultAction'. This is the setter.

setMenu

Signature: void setMenu (QMenu ptr menu)

Description: Method void QToolButton::setMenu(QMenu *menu)

Python specific notes:
The object exposes a writable attribute 'menu'. This is the setter.

setPopupMode

Signature: void setPopupMode (const QToolButton_ToolButtonPopupMode mode)

Description: Method void QToolButton::setPopupMode(QToolButton::ToolButtonPopupMode mode)

Python specific notes:
The object exposes a writable attribute 'popupMode'. This is the setter.

setToolButtonStyle

Signature: void setToolButtonStyle (const Qt_ToolButtonStyle style)

Description: Method void QToolButton::setToolButtonStyle(Qt::ToolButtonStyle style)

Python specific notes:
The object exposes a writable attribute 'toolButtonStyle'. This is the setter.

setVisible

Signature: void setVisible (bool visible)

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

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

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

This method can be reimplemented in a derived class.

showEvent

Signature: void showEvent (QShowEvent ptr event)

Description: Virtual method void QToolButton::showEvent(QShowEvent *event)

This method can be reimplemented in a derived class.

showMenu

Signature: void showMenu

Description: Method void QToolButton::showMenu()

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QToolButton::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 event)

Description: Virtual method void QToolButton::tabletEvent(QTabletEvent *event)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

toggled

Signature: [signal] void toggled (bool checked)

Description: Signal declaration for QToolButton::toggled(bool checked)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'toggled'. This is the getter.
The object exposes a writable attribute 'toggled'. This is the setter.

toolButtonStyle

Signature: [const] Qt_ToolButtonStyle toolButtonStyle

Description: Method Qt::ToolButtonStyle QToolButton::toolButtonStyle()

Python specific notes:
The object exposes a readable attribute 'toolButtonStyle'. This is the getter.

toolButtonStyle=

Signature: void toolButtonStyle= (const Qt_ToolButtonStyle style)

Description: Method void QToolButton::setToolButtonStyle(Qt::ToolButtonStyle style)

Python specific notes:
The object exposes a writable attribute 'toolButtonStyle'. This is the setter.

tr

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

Description: Static method QString QToolButton::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 QToolButton::trUtf8(const char *s, const char *c, int n)

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

triggered

Signature: [signal] void triggered (QAction ptr arg1)

Description: Signal declaration for QToolButton::triggered(QAction *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'triggered'. This is the getter.
The object exposes a writable attribute 'triggered'. This is the setter.

updateMicroFocus

Signature: void updateMicroFocus

Description: Method void QToolButton::updateMicroFocus()

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

wheelEvent

Signature: void wheelEvent (QWheelEvent ptr event)

Description: Virtual method void QToolButton::wheelEvent(QWheelEvent *event)

This method can be reimplemented in a derived class.

windowIconChanged

Signature: [signal] void windowIconChanged (const QIcon icon)

Description: Signal declaration for QToolButton::windowIconChanged(const QIcon &icon)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowIconChanged'. This is the getter.
The object exposes a writable attribute 'windowIconChanged'. This is the setter.

windowIconTextChanged

Signature: [signal] void windowIconTextChanged (string iconText)

Description: Signal declaration for QToolButton::windowIconTextChanged(const QString &iconText)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowIconTextChanged'. This is the getter.
The object exposes a writable attribute 'windowIconTextChanged'. This is the setter.

windowTitleChanged

Signature: [signal] void windowTitleChanged (string title)

Description: Signal declaration for QToolButton::windowTitleChanged(const QString &title)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowTitleChanged'. This is the getter.
The object exposes a writable attribute 'windowTitleChanged'. This is the setter.