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

API reference - Class QInputMethodEvent

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QInputMethodEvent

Class hierarchy: QInputMethodEvent » QEvent

Sub-classes: AttributeType, QFlags_AttributeType, Attribute

Public constructors

new QInputMethodEventnewConstructor QInputMethodEvent::QInputMethodEvent()
new QInputMethodEventnew(string preeditText,
QInputMethodEvent_Attribute[] attributes)
Constructor QInputMethodEvent::QInputMethodEvent(const QString &preeditText, const QList<QInputMethodEvent::Attribute> &attributes)
new QInputMethodEventnew(const QInputMethodEvent other)Constructor QInputMethodEvent::QInputMethodEvent(const QInputMethodEvent &other)

Public methods

void_assign(const QInputMethodEvent other)Assigns another object to self
[const]QInputMethodEvent 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]new QInputMethodEvent ptr_dupCreates a copy of self
[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.
[const]QInputMethodEvent_Attribute[]attributesMethod const QList<QInputMethodEvent::Attribute> &QInputMethodEvent::attributes()
[const]stringcommitStringMethod const QString &QInputMethodEvent::commitString()
[const]stringpreeditStringMethod const QString &QInputMethodEvent::preeditString()
[const]intreplacementLengthMethod int QInputMethodEvent::replacementLength()
[const]intreplacementStartMethod int QInputMethodEvent::replacementStart()
voidsetCommitString(string commitString,
int replaceFrom = 0,
int replaceLength = 0)
Method void QInputMethodEvent::setCommitString(const QString &commitString, int replaceFrom, int replaceLength)

Public static methods and constants

[static,const]QInputMethodEvent_AttributeTypeCursorEnum constant QInputMethodEvent::Cursor
[static,const]QInputMethodEvent_AttributeTypeLanguageEnum constant QInputMethodEvent::Language
[static,const]QInputMethodEvent_AttributeTypeRubyEnum constant QInputMethodEvent::Ruby
[static,const]QInputMethodEvent_AttributeTypeSelectionEnum constant QInputMethodEvent::Selection
[static,const]QInputMethodEvent_AttributeTypeTextFormatEnum constant QInputMethodEvent::TextFormat

Detailed description

Cursor

Signature: [static,const] QInputMethodEvent_AttributeType Cursor

Description: Enum constant QInputMethodEvent::Cursor

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

Language

Signature: [static,const] QInputMethodEvent_AttributeType Language

Description: Enum constant QInputMethodEvent::Language

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

Ruby

Signature: [static,const] QInputMethodEvent_AttributeType Ruby

Description: Enum constant QInputMethodEvent::Ruby

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

Selection

Signature: [static,const] QInputMethodEvent_AttributeType Selection

Description: Enum constant QInputMethodEvent::Selection

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

TextFormat

Signature: [static,const] QInputMethodEvent_AttributeType TextFormat

Description: Enum constant QInputMethodEvent::TextFormat

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

_assign

Signature: void _assign (const QInputMethodEvent other)

Description: Assigns another object to self

_const_cast

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

_dup

Signature: [const] new QInputMethodEvent ptr _dup

Description: Creates a copy of self

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

attributes

Signature: [const] QInputMethodEvent_Attribute[] attributes

Description: Method const QList<QInputMethodEvent::Attribute> &QInputMethodEvent::attributes()

commitString

Signature: [const] string commitString

Description: Method const QString &QInputMethodEvent::commitString()

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

new

(1) Signature: [static] new QInputMethodEvent new

Description: Constructor QInputMethodEvent::QInputMethodEvent()

This method creates an object of class QInputMethodEvent.

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

(2) Signature: [static] new QInputMethodEvent new (string preeditText, QInputMethodEvent_Attribute[] attributes)

Description: Constructor QInputMethodEvent::QInputMethodEvent(const QString &preeditText, const QList<QInputMethodEvent::Attribute> &attributes)

This method creates an object of class QInputMethodEvent.

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

(3) Signature: [static] new QInputMethodEvent new (const QInputMethodEvent other)

Description: Constructor QInputMethodEvent::QInputMethodEvent(const QInputMethodEvent &other)

This method creates an object of class QInputMethodEvent.

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

preeditString

Signature: [const] string preeditString

Description: Method const QString &QInputMethodEvent::preeditString()

replacementLength

Signature: [const] int replacementLength

Description: Method int QInputMethodEvent::replacementLength()

replacementStart

Signature: [const] int replacementStart

Description: Method int QInputMethodEvent::replacementStart()

setCommitString

Signature: void setCommitString (string commitString, int replaceFrom = 0, int replaceLength = 0)

Description: Method void QInputMethodEvent::setCommitString(const QString &commitString, int replaceFrom, int replaceLength)