KLayout Manual: Main Index » Class Index » API reference - Class QAction

API reference - Class QAction

Notation used in Ruby API documentation

Description: Binding of QAction

Class hierarchy: QAction » QObject

Sub-classes: ActionEvent, MenuRole, Priority, SoftKeyRole

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QAction_MenuRole ptr AboutQtRole

Description: Enum constant QAction::AboutQtRole

[static,const] new QAction_MenuRole ptr AboutRole

Description: Enum constant QAction::AboutRole

[static,const] new QAction_MenuRole ptr ApplicationSpecificRole

Description: Enum constant QAction::ApplicationSpecificRole

[static,const] new QAction_Priority ptr HighPriority

Description: Enum constant QAction::HighPriority

[static,const] new QAction_ActionEvent ptr Hover

Description: Enum constant QAction::Hover

[static,const] new QAction_Priority ptr LowPriority

Description: Enum constant QAction::LowPriority

[static,const] new QAction_SoftKeyRole ptr NegativeSoftKey

Description: Enum constant QAction::NegativeSoftKey

[static,const] new QAction_MenuRole ptr NoRole

Description: Enum constant QAction::NoRole

[static,const] new QAction_SoftKeyRole ptr NoSoftKey

Description: Enum constant QAction::NoSoftKey

[static,const] new QAction_Priority ptr NormalPriority

Description: Enum constant QAction::NormalPriority

[static,const] new QAction_SoftKeyRole ptr PositiveSoftKey

Description: Enum constant QAction::PositiveSoftKey

[static,const] new QAction_MenuRole ptr PreferencesRole

Description: Enum constant QAction::PreferencesRole

[static,const] new QAction_MenuRole ptr QuitRole

Description: Enum constant QAction::QuitRole

[static,const] new QAction_SoftKeyRole ptr SelectSoftKey

Description: Enum constant QAction::SelectSoftKey

[static,const] new QAction_MenuRole ptr TextHeuristicRole

Description: Enum constant QAction::TextHeuristicRole

[static,const] new QAction_ActionEvent ptr Trigger

Description: Enum constant QAction::Trigger

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.

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.

[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.

[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.

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.

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.

[const] QActionGroup ptr actionGroup

Description: Method QActionGroup *QAction::actionGroup()

Python specific notes:

The object exposes a readable attribute 'actionGroup'. This is the getter.

void actionGroup=(QActionGroup ptr group)

Description: Method void QAction::setActionGroup(QActionGroup *group)

Python specific notes:

The object exposes a writable attribute 'actionGroup'. This is the setter.

void activate(const QAction_ActionEvent event)

Description: Method void QAction::activate(QAction::ActionEvent event)

[const] QGraphicsWidget ptr[] associatedGraphicsWidgets

Description: Method QList<QGraphicsWidget *> QAction::associatedGraphicsWidgets()

[const] QWidget ptr[] associatedWidgets

Description: Method QList<QWidget *> QAction::associatedWidgets()

[const] bool autoRepeat

Description: Method bool QAction::autoRepeat()

Python specific notes:

The object exposes a readable attribute 'autoRepeat'. This is the getter.

void autoRepeat=(bool arg1)

Description: Method void QAction::setAutoRepeat(bool)

Python specific notes:

The object exposes a writable attribute 'autoRepeat'. This is the setter.

[event] void changed

Description: Signal declaration for QAction::changed()

You can bind a procedure to this signal.

[const] bool checkable

Description: Method bool QAction::isCheckable()

Python specific notes:

The object exposes a readable attribute 'checkable'. This is the getter.

void checkable=(bool arg1)

Description: Method void QAction::setCheckable(bool)

Python specific notes:

The object exposes a writable attribute 'checkable'. This is the setter.

[const] bool checked

Description: Method bool QAction::isChecked()

Python specific notes:

The object exposes a readable attribute 'checked'. This is the getter.

void checked=(bool arg1)

Description: Method void QAction::setChecked(bool)

Python specific notes:

The object exposes a writable attribute 'checked'. This is the setter.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QVariant data

Description: Method QVariant QAction::data()

Python specific notes:

The object exposes a readable attribute 'data'. This is the getter.

void data=(const QVariant var)

Description: Method void QAction::setData(const QVariant &var)

Python specific notes:

The object exposes a writable attribute 'data'. This is the setter.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QAction::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[const] bool enabled

Description: Method bool QAction::isEnabled()

Python specific notes:

The object exposes a readable attribute 'enabled'. This is the getter.

void enabled=(bool arg1)

Description: Method void QAction::setEnabled(bool)

Python specific notes:

The object exposes a writable attribute 'enabled'. This is the setter.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[const] QFont font

Description: Method QFont QAction::font()

Python specific notes:

The object exposes a readable attribute 'font'. This is the getter.

void font=(const QFont font)

Description: Method void QAction::setFont(const QFont &font)

Python specific notes:

The object exposes a writable attribute 'font'. This is the setter.

void hover

Description: Method void QAction::hover()

[event] void hovered

Description: Signal declaration for QAction::hovered()

You can bind a procedure to this signal.

[const] QIcon icon

Description: Method QIcon QAction::icon()

Python specific notes:

The object exposes a readable attribute 'icon'. This is the getter.

void icon=(const QIcon icon)

Description: Method void QAction::setIcon(const QIcon &icon)

Python specific notes:

The object exposes a writable attribute 'icon'. This is the setter.

[const] string iconText

Description: Method QString QAction::iconText()

Python specific notes:

The object exposes a readable attribute 'iconText'. This is the getter.

void iconText=(string text)

Description: Method void QAction::setIconText(const QString &text)

Python specific notes:

The object exposes a writable attribute 'iconText'. This is the setter.

[const] bool iconVisibleInMenu

Description: Method bool QAction::isIconVisibleInMenu()

Python specific notes:

The object exposes a readable attribute 'iconVisibleInMenu'. This is the getter.

void iconVisibleInMenu=(bool visible)

Description: Method void QAction::setIconVisibleInMenu(bool visible)

Python specific notes:

The object exposes a writable attribute 'iconVisibleInMenu'. This is the setter.

[const] bool isCheckable?

Description: Method bool QAction::isCheckable()

Python specific notes:

The object exposes a readable attribute 'checkable'. This is the getter.

[const] bool isChecked?

Description: Method bool QAction::isChecked()

Python specific notes:

The object exposes a readable attribute 'checked'. This is the getter.

[const] bool isEnabled?

Description: Method bool QAction::isEnabled()

Python specific notes:

The object exposes a readable attribute 'enabled'. This is the getter.

[const] bool isIconVisibleInMenu?

Description: Method bool QAction::isIconVisibleInMenu()

Python specific notes:

The object exposes a readable attribute 'iconVisibleInMenu'. This is the getter.

[const] bool isSeparator?

Description: Method bool QAction::isSeparator()

Python specific notes:

The object exposes a readable attribute 'separator'. This is the getter.

[const] bool isVisible?

Description: Method bool QAction::isVisible()

Python specific notes:

The object exposes a readable attribute 'visible'. This is the getter.

[const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

[const] QMenu ptr menu

Description: Method QMenu *QAction::menu()

Python specific notes:

The object exposes a readable attribute 'menu'. This is the getter.

void menu=(QMenu ptr menu)

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

Python specific notes:

The object exposes a writable attribute 'menu'. This is the setter.

[const] QAction_MenuRole menuRole

Description: Method QAction::MenuRole QAction::menuRole()

Python specific notes:

The object exposes a readable attribute 'menuRole'. This is the getter.

void menuRole=(const QAction_MenuRole menuRole)

Description: Method void QAction::setMenuRole(QAction::MenuRole menuRole)

Python specific notes:

The object exposes a writable attribute 'menuRole'. This is the setter.

[static] new QAction new(QObject ptr parent)

Description: Constructor QAction::QAction(QObject *parent)

This method creates an object of class QAction.

Python specific notes:

This method is the default initializer of the object

[static] new QAction new(string text,QObject ptr parent)

Description: Constructor QAction::QAction(const QString &text, QObject *parent)

This method creates an object of class QAction.

Python specific notes:

This method is the default initializer of the object

[static] new QAction new(const QIcon icon,string text,QObject ptr parent)

Description: Constructor QAction::QAction(const QIcon &icon, const QString &text, QObject *parent)

This method creates an object of class QAction.

Python specific notes:

This method is the default initializer of the object

[const] QWidget ptr parentWidget

Description: Method QWidget *QAction::parentWidget()

[const] QAction_Priority priority

Description: Method QAction::Priority QAction::priority()

Python specific notes:

The object exposes a readable attribute 'priority'. This is the getter.

void priority=(const QAction_Priority priority)

Description: Method void QAction::setPriority(QAction::Priority priority)

Python specific notes:

The object exposes a writable attribute 'priority'. This is the setter.

[const] int receivers(string signal)

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

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

[const] QObject ptr sender

Description: Method QObject *QAction::sender()

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

[const] bool separator

Description: Method bool QAction::isSeparator()

Python specific notes:

The object exposes a readable attribute 'separator'. This is the getter.

void separator=(bool b)

Description: Method void QAction::setSeparator(bool b)

Python specific notes:

The object exposes a writable attribute 'separator'. This is the setter.

void setActionGroup(QActionGroup ptr group)

Description: Method void QAction::setActionGroup(QActionGroup *group)

Python specific notes:

The object exposes a writable attribute 'actionGroup'. This is the setter.

void setAutoRepeat(bool arg1)

Description: Method void QAction::setAutoRepeat(bool)

Python specific notes:

The object exposes a writable attribute 'autoRepeat'. This is the setter.

void setCheckable(bool arg1)

Description: Method void QAction::setCheckable(bool)

Python specific notes:

The object exposes a writable attribute 'checkable'. This is the setter.

void setChecked(bool arg1)

Description: Method void QAction::setChecked(bool)

Python specific notes:

The object exposes a writable attribute 'checked'. This is the setter.

void setData(const QVariant var)

Description: Method void QAction::setData(const QVariant &var)

Python specific notes:

The object exposes a writable attribute 'data'. This is the setter.

void setDisabled(bool b)

Description: Method void QAction::setDisabled(bool b)

void setEnabled(bool arg1)

Description: Method void QAction::setEnabled(bool)

Python specific notes:

The object exposes a writable attribute 'enabled'. This is the setter.

void setFont(const QFont font)

Description: Method void QAction::setFont(const QFont &font)

Python specific notes:

The object exposes a writable attribute 'font'. This is the setter.

void setIcon(const QIcon icon)

Description: Method void QAction::setIcon(const QIcon &icon)

Python specific notes:

The object exposes a writable attribute 'icon'. This is the setter.

void setIconText(string text)

Description: Method void QAction::setIconText(const QString &text)

Python specific notes:

The object exposes a writable attribute 'iconText'. This is the setter.

void setIconVisibleInMenu(bool visible)

Description: Method void QAction::setIconVisibleInMenu(bool visible)

Python specific notes:

The object exposes a writable attribute 'iconVisibleInMenu'. This is the setter.

void setMenu(QMenu ptr menu)

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

Python specific notes:

The object exposes a writable attribute 'menu'. This is the setter.

void setMenuRole(const QAction_MenuRole menuRole)

Description: Method void QAction::setMenuRole(QAction::MenuRole menuRole)

Python specific notes:

The object exposes a writable attribute 'menuRole'. This is the setter.

void setPriority(const QAction_Priority priority)

Description: Method void QAction::setPriority(QAction::Priority priority)

Python specific notes:

The object exposes a writable attribute 'priority'. This is the setter.

void setSeparator(bool b)

Description: Method void QAction::setSeparator(bool b)

Python specific notes:

The object exposes a writable attribute 'separator'. This is the setter.

void setShortcut(const QKeySequence shortcut)

Description: Method void QAction::setShortcut(const QKeySequence &shortcut)

Python specific notes:

The object exposes a writable attribute 'shortcut'. This is the setter.

void setShortcutContext(const Qt_ShortcutContext context)

Description: Method void QAction::setShortcutContext(Qt::ShortcutContext context)

Python specific notes:

The object exposes a writable attribute 'shortcutContext'. This is the setter.

void setShortcuts(QKeySequence[] shortcuts)

Description: Method void QAction::setShortcuts(const QList<QKeySequence> &shortcuts)

Python specific notes:

The object exposes a writable attribute 'shortcuts'. This is the setter.

void setShortcuts(const QKeySequence_StandardKey arg1)

Description: Method void QAction::setShortcuts(QKeySequence::StandardKey)

Python specific notes:

The object exposes a writable attribute 'shortcuts'. This is the setter.

void setSoftKeyRole(const QAction_SoftKeyRole softKeyRole)

Description: Method void QAction::setSoftKeyRole(QAction::SoftKeyRole softKeyRole)

Python specific notes:

The object exposes a writable attribute 'softKeyRole'. This is the setter.

void setStatusTip(string statusTip)

Description: Method void QAction::setStatusTip(const QString &statusTip)

Python specific notes:

The object exposes a writable attribute 'statusTip'. This is the setter.

void setText(string text)

Description: Method void QAction::setText(const QString &text)

Python specific notes:

The object exposes a writable attribute 'text'. This is the setter.

void setToolTip(string tip)

Description: Method void QAction::setToolTip(const QString &tip)

Python specific notes:

The object exposes a writable attribute 'toolTip'. This is the setter.

void setVisible(bool arg1)

Description: Method void QAction::setVisible(bool)

Python specific notes:

The object exposes a writable attribute 'visible'. This is the setter.

void setWhatsThis(string what)

Description: Method void QAction::setWhatsThis(const QString &what)

Python specific notes:

The object exposes a writable attribute 'whatsThis'. This is the setter.

[const] QKeySequence shortcut

Description: Method QKeySequence QAction::shortcut()

Python specific notes:

The object exposes a readable attribute 'shortcut'. This is the getter.

void shortcut=(const QKeySequence shortcut)

Description: Method void QAction::setShortcut(const QKeySequence &shortcut)

Python specific notes:

The object exposes a writable attribute 'shortcut'. This is the setter.

[const] Qt_ShortcutContext shortcutContext

Description: Method Qt::ShortcutContext QAction::shortcutContext()

Python specific notes:

The object exposes a readable attribute 'shortcutContext'. This is the getter.

void shortcutContext=(const Qt_ShortcutContext context)

Description: Method void QAction::setShortcutContext(Qt::ShortcutContext context)

Python specific notes:

The object exposes a writable attribute 'shortcutContext'. This is the setter.

[const] QKeySequence[] shortcuts

Description: Method QList<QKeySequence> QAction::shortcuts()

Python specific notes:

The object exposes a readable attribute 'shortcuts'. This is the getter.

void shortcuts=(QKeySequence[] shortcuts)

Description: Method void QAction::setShortcuts(const QList<QKeySequence> &shortcuts)

Python specific notes:

The object exposes a writable attribute 'shortcuts'. This is the setter.

void shortcuts=(const QKeySequence_StandardKey arg1)

Description: Method void QAction::setShortcuts(QKeySequence::StandardKey)

Python specific notes:

The object exposes a writable attribute 'shortcuts'. This is the setter.

bool showStatusText(QWidget ptr widget = 0)

Description: Method bool QAction::showStatusText(QWidget *widget)

[const] QAction_SoftKeyRole softKeyRole

Description: Method QAction::SoftKeyRole QAction::softKeyRole()

Python specific notes:

The object exposes a readable attribute 'softKeyRole'. This is the getter.

void softKeyRole=(const QAction_SoftKeyRole softKeyRole)

Description: Method void QAction::setSoftKeyRole(QAction::SoftKeyRole softKeyRole)

Python specific notes:

The object exposes a writable attribute 'softKeyRole'. This is the setter.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] string statusTip

Description: Method QString QAction::statusTip()

Python specific notes:

The object exposes a readable attribute 'statusTip'. This is the getter.

void statusTip=(string statusTip)

Description: Method void QAction::setStatusTip(const QString &statusTip)

Python specific notes:

The object exposes a writable attribute 'statusTip'. This is the setter.

[const] string text

Description: Method QString QAction::text()

Python specific notes:

The object exposes a readable attribute 'text'. This is the getter.

void text=(string text)

Description: Method void QAction::setText(const QString &text)

Python specific notes:

The object exposes a writable attribute 'text'. This is the setter.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void toggle

Description: Method void QAction::toggle()

[event] void toggled(bool arg1)

Description: Signal declaration for QAction::toggled(bool)

You can bind a procedure to this signal.

[const] string toolTip

Description: Method QString QAction::toolTip()

Python specific notes:

The object exposes a readable attribute 'toolTip'. This is the getter.

void toolTip=(string tip)

Description: Method void QAction::setToolTip(const QString &tip)

Python specific notes:

The object exposes a writable attribute 'toolTip'. This is the setter.

[static] string tr(string s,string c = 0)

Description: Static method QString QAction::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

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

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

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QAction::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

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

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

void trigger

Description: Method void QAction::trigger()

[event] void triggered(bool checked)

Description: Signal declaration for QAction::triggered(bool checked)

You can bind a procedure to this signal.

[const] bool visible

Description: Method bool QAction::isVisible()

Python specific notes:

The object exposes a readable attribute 'visible'. This is the getter.

void visible=(bool arg1)

Description: Method void QAction::setVisible(bool)

Python specific notes:

The object exposes a writable attribute 'visible'. This is the setter.

[const] string whatsThis

Description: Method QString QAction::whatsThis()

Python specific notes:

The object exposes a readable attribute 'whatsThis'. This is the getter.

void whatsThis=(string what)

Description: Method void QAction::setWhatsThis(const QString &what)

Python specific notes:

The object exposes a writable attribute 'whatsThis'. This is the setter.