API reference - Class Qt_InputMethodQuery

Notation used in Ruby API documentation

Module: QtCore

Description: This class represents the Qt::InputMethodQuery enum

This class is equivalent to the class Qt::InputMethodQuery

Public constructors

new Qt_InputMethodQuery ptrnew(int i)Creates an enum from an integer value
new Qt_InputMethodQuery ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const Qt_InputMethodQuery other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const Qt_InputMethodQuery other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const Qt_InputMethodQuery other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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 Qt_InputMethodQuery other)Assigns another object to self
[const]new Qt_InputMethodQuery ptrdupCreates a copy of self
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]Qt_QFlags_InputMethodQuery|(const Qt_InputMethodQuery other)Creates a flag set by combining the two flags
[const]Qt_QFlags_InputMethodQuery|(const Qt_QFlags_InputMethodQuery other)Combines the flag and the flag set

Public static methods and constants

[static,const]Qt_InputMethodQueryImAbsolutePositionEnum constant Qt::ImAbsolutePosition
[static,const]Qt_InputMethodQueryImAnchorPositionEnum constant Qt::ImAnchorPosition
[static,const]Qt_InputMethodQueryImCurrentSelectionEnum constant Qt::ImCurrentSelection
[static,const]Qt_InputMethodQueryImCursorPositionEnum constant Qt::ImCursorPosition
[static,const]Qt_InputMethodQueryImCursorRectangleEnum constant Qt::ImCursorRectangle
[static,const]Qt_InputMethodQueryImEnabledEnum constant Qt::ImEnabled
[static,const]Qt_InputMethodQueryImFontEnum constant Qt::ImFont
[static,const]Qt_InputMethodQueryImHintsEnum constant Qt::ImHints
[static,const]Qt_InputMethodQueryImMaximumTextLengthEnum constant Qt::ImMaximumTextLength
[static,const]Qt_InputMethodQueryImMicroFocusEnum constant Qt::ImMicroFocus
[static,const]Qt_InputMethodQueryImPlatformDataEnum constant Qt::ImPlatformData
[static,const]Qt_InputMethodQueryImPreferredLanguageEnum constant Qt::ImPreferredLanguage
[static,const]Qt_InputMethodQueryImQueryAllEnum constant Qt::ImQueryAll
[static,const]Qt_InputMethodQueryImQueryInputEnum constant Qt::ImQueryInput
[static,const]Qt_InputMethodQueryImSurroundingTextEnum constant Qt::ImSurroundingText
[static,const]Qt_InputMethodQueryImTextAfterCursorEnum constant Qt::ImTextAfterCursor
[static,const]Qt_InputMethodQueryImTextBeforeCursorEnum constant Qt::ImTextBeforeCursor

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

!=

(1) Signature: [const] bool != (const Qt_InputMethodQuery other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const Qt_InputMethodQuery other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const Qt_InputMethodQuery other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

ImAbsolutePosition

Signature: [static,const] Qt_InputMethodQuery ImAbsolutePosition

Description: Enum constant Qt::ImAbsolutePosition

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

ImAnchorPosition

Signature: [static,const] Qt_InputMethodQuery ImAnchorPosition

Description: Enum constant Qt::ImAnchorPosition

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

ImCurrentSelection

Signature: [static,const] Qt_InputMethodQuery ImCurrentSelection

Description: Enum constant Qt::ImCurrentSelection

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

ImCursorPosition

Signature: [static,const] Qt_InputMethodQuery ImCursorPosition

Description: Enum constant Qt::ImCursorPosition

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

ImCursorRectangle

Signature: [static,const] Qt_InputMethodQuery ImCursorRectangle

Description: Enum constant Qt::ImCursorRectangle

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

ImEnabled

Signature: [static,const] Qt_InputMethodQuery ImEnabled

Description: Enum constant Qt::ImEnabled

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

ImFont

Signature: [static,const] Qt_InputMethodQuery ImFont

Description: Enum constant Qt::ImFont

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

ImHints

Signature: [static,const] Qt_InputMethodQuery ImHints

Description: Enum constant Qt::ImHints

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

ImMaximumTextLength

Signature: [static,const] Qt_InputMethodQuery ImMaximumTextLength

Description: Enum constant Qt::ImMaximumTextLength

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

ImMicroFocus

Signature: [static,const] Qt_InputMethodQuery ImMicroFocus

Description: Enum constant Qt::ImMicroFocus

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

ImPlatformData

Signature: [static,const] Qt_InputMethodQuery ImPlatformData

Description: Enum constant Qt::ImPlatformData

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

ImPreferredLanguage

Signature: [static,const] Qt_InputMethodQuery ImPreferredLanguage

Description: Enum constant Qt::ImPreferredLanguage

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

ImQueryAll

Signature: [static,const] Qt_InputMethodQuery ImQueryAll

Description: Enum constant Qt::ImQueryAll

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

ImQueryInput

Signature: [static,const] Qt_InputMethodQuery ImQueryInput

Description: Enum constant Qt::ImQueryInput

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

ImSurroundingText

Signature: [static,const] Qt_InputMethodQuery ImSurroundingText

Description: Enum constant Qt::ImSurroundingText

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

ImTextAfterCursor

Signature: [static,const] Qt_InputMethodQuery ImTextAfterCursor

Description: Enum constant Qt::ImTextAfterCursor

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

ImTextBeforeCursor

Signature: [static,const] Qt_InputMethodQuery ImTextBeforeCursor

Description: Enum constant Qt::ImTextBeforeCursor

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

_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 Qt_InputMethodQuery 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 Qt_InputMethodQuery ptr dup

Description: Creates a copy of self

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

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

(1) Signature: [static] new Qt_InputMethodQuery ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new Qt_InputMethodQuery ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.

|

(1) Signature: [const] Qt_QFlags_InputMethodQuery | (const Qt_InputMethodQuery other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] Qt_QFlags_InputMethodQuery | (const Qt_QFlags_InputMethodQuery other)

Description: Combines the flag and the flag set