API reference - Class QHelpEvent

Notation used in Ruby API documentation

Description: Binding of QHelpEvent

Class hierarchy: QHelpEvent » QEvent

Public constructors

new QHelpEventnew(const QEvent_Type type,
const QPoint pos,
const QPoint globalPos)
Constructor QHelpEvent::QHelpEvent(QEvent::Type type, const QPoint &pos, const QPoint &globalPos)

Public methods

[const]voidassign(const QHelpEvent 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]QHelpEventdupCreates a copy of self
[const]QPointglobalPosMethod const QPoint &QHelpEvent::globalPos()
[const]intglobalXMethod int QHelpEvent::globalX()
[const]intglobalYMethod int QHelpEvent::globalY()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]QPointposMethod const QPoint &QHelpEvent::pos()
[const]intxMethod int QHelpEvent::x()
[const]intyMethod int QHelpEvent::y()

Detailed description

[const] void assign(const QHelpEvent 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.

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] QHelpEvent dup

Description: Creates a copy of self

[const] QPoint globalPos

Description: Method const QPoint &QHelpEvent::globalPos()

[const] int globalX

Description: Method int QHelpEvent::globalX()

[const] int globalY

Description: Method int QHelpEvent::globalY()

[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] new QHelpEvent new(const QEvent_Type type,const QPoint pos,const QPoint globalPos)

Description: Constructor QHelpEvent::QHelpEvent(QEvent::Type type, const QPoint &pos, const QPoint &globalPos)

This method creates an object of class QHelpEvent.

[const] QPoint pos

Description: Method const QPoint &QHelpEvent::pos()

[const] int x

Description: Method int QHelpEvent::x()

[const] int y

Description: Method int QHelpEvent::y()