KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QToolTip

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QToolTip

Public constructors

new QToolTip ptrnewCreates a new object of this class

Public methods

[const]QToolTip ptr_const_castReturns a non-const reference to self.
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.
voidassign(const QToolTip other)Assigns another object to self
[const]new QToolTip ptrdupCreates a copy of self

Public static methods and constants

QFontfontStatic method QFont QToolTip::font()
voidfont=(const QFont arg1)Static method void QToolTip::setFont(const QFont &)
voidhideTextStatic method void QToolTip::hideText()
boolisVisible?Static method bool QToolTip::isVisible()
QPalettepaletteStatic method QPalette QToolTip::palette()
voidpalette=(const QPalette arg1)Static method void QToolTip::setPalette(const QPalette &)
voidsetFont(const QFont arg1)Static method void QToolTip::setFont(const QFont &)
voidsetPalette(const QPalette arg1)Static method void QToolTip::setPalette(const QPalette &)
voidshowText(const QPoint pos,
string text,
QWidget ptr w = nullptr)
Static method void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w)
voidshowText(const QPoint pos,
string text,
QWidget ptr w,
const QRect rect)
Static method void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect)
voidshowText(const QPoint pos,
string text,
QWidget ptr w,
const QRect rect,
int msecShowTime)
Static method void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect, int msecShowTime)
stringtextStatic method QString QToolTip::text()

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_const_cast

Signature: [const] QToolTip 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.

assign

Signature: void assign (const QToolTip other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QToolTip ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

font

Signature: [static] QFont font

Description: Static method QFont QToolTip::font()

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

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

font=

Signature: [static] void font= (const QFont arg1)

Description: Static method void QToolTip::setFont(const QFont &)

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

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

hideText

Signature: [static] void hideText

Description: Static method void QToolTip::hideText()

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

isVisible?

Signature: [static] bool isVisible?

Description: Static method bool QToolTip::isVisible()

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

is_const_object?

Signature: [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

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

new

Signature: [static] new QToolTip ptr new

Description: Creates a new object of this class

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

palette

Signature: [static] QPalette palette

Description: Static method QPalette QToolTip::palette()

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

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

palette=

Signature: [static] void palette= (const QPalette arg1)

Description: Static method void QToolTip::setPalette(const QPalette &)

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

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

setFont

Signature: [static] void setFont (const QFont arg1)

Description: Static method void QToolTip::setFont(const QFont &)

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

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

setPalette

Signature: [static] void setPalette (const QPalette arg1)

Description: Static method void QToolTip::setPalette(const QPalette &)

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

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

showText

(1) Signature: [static] void showText (const QPoint pos, string text, QWidget ptr w = nullptr)

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

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

(2) Signature: [static] void showText (const QPoint pos, string text, QWidget ptr w, const QRect rect)

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

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

(3) Signature: [static] void showText (const QPoint pos, string text, QWidget ptr w, const QRect rect, int msecShowTime)

Description: Static method void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w, const QRect &rect, int msecShowTime)

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

text

Signature: [static] string text

Description: Static method QString QToolTip::text()

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