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

API reference - Class QWhatsThis

Notation used in Ruby API documentation

Description: Binding of QWhatsThis

Public methods

[const]voidassign(const QWhatsThis other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QWhatsThisdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference

Public static methods and constants

QAction ptrcreateActionStatic method QAction * QWhatsThis::createAction(QObject *parent)
QAction ptrcreateAction(QObject ptr parent)Static method QAction * QWhatsThis::createAction(QObject *parent)
voidenterWhatsThisModeStatic method void QWhatsThis::enterWhatsThisMode()
voidhideTextStatic method void QWhatsThis::hideText()
boolinWhatsThisModeStatic method bool QWhatsThis::inWhatsThisMode()
voidleaveWhatsThisModeStatic method void QWhatsThis::leaveWhatsThisMode()
voidshowText(const QPoint pos,
string text)
Static method void QWhatsThis::showText(const QPoint &pos, const QString &text, QWidget *w)
voidshowText(const QPoint pos,
string text,
QWidget ptr w)
Static method void QWhatsThis::showText(const QPoint &pos, const QString &text, QWidget *w)

Detailed description

[const] void assign(const QWhatsThis other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

[static] QAction ptr createAction

Description: Static method QAction * QWhatsThis::createAction(QObject *parent)

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

[static] QAction ptr createAction(QObject ptr parent)

Description: Static method QAction * QWhatsThis::createAction(QObject *parent)

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

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] QWhatsThis dup

Description: Creates a copy of self

[static] void enterWhatsThisMode

Description: Static method void QWhatsThis::enterWhatsThisMode()

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

[static] void hideText

Description: Static method void QWhatsThis::hideText()

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

[static] bool inWhatsThisMode

Description: Static method bool QWhatsThis::inWhatsThisMode()

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

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

[static] void leaveWhatsThisMode

Description: Static method void QWhatsThis::leaveWhatsThisMode()

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

[static] void showText(const QPoint pos,string text)

Description: Static method void QWhatsThis::showText(const QPoint &pos, const QString &text, QWidget *w)

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

[static] void showText(const QPoint pos,string text,QWidget ptr w)

Description: Static method void QWhatsThis::showText(const QPoint &pos, const QString &text, QWidget *w)

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