API reference - Class QCollator

()

Signature: [const] bool () (string s1, string s2)

Description: Method bool QCollator::operator()(const QString &s1, const QString &s2)

_assign

Signature: void _assign (const QCollator other)

Description: Assigns another object to self

_const_cast

Signature: [const] QCollator 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: QCollator assign (const QCollator arg1)

Description: Method QCollator &QCollator::operator=(const QCollator &)

caseSensitivity

Signature: [const] Qt_CaseSensitivity caseSensitivity

Description: Method Qt::CaseSensitivity QCollator::caseSensitivity()

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

caseSensitivity=

Signature: void caseSensitivity= (const Qt_CaseSensitivity cs)

Description: Method void QCollator::setCaseSensitivity(Qt::CaseSensitivity cs)

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

compare

(1) Signature: [const] int compare (string s1, string s2)

Description: Method int QCollator::compare(const QString &s1, const QString &s2)

(2) Signature: [const] int compare (unsigned int ptr s1, int len1, unsigned int ptr s2, int len2)

Description: Method int QCollator::compare(const QChar *s1, int len1, const QChar *s2, int len2)

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 QCollator ptr dup

Description: Creates a copy of self

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

ignorePunctuation

Signature: [const] bool ignorePunctuation

Description: Method bool QCollator::ignorePunctuation()

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

ignorePunctuation=

Signature: void ignorePunctuation= (bool on)

Description: Method void QCollator::setIgnorePunctuation(bool on)

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

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.

locale

Signature: [const] QLocale locale

Description: Method QLocale QCollator::locale()

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

locale=

Signature: void locale= (const QLocale locale)

Description: Method void QCollator::setLocale(const QLocale &locale)

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

new

(1) Signature: [static] new QCollator new (const QLocale locale = QLocale())

Description: Constructor QCollator::QCollator(const QLocale &locale)

This method creates an object of class QCollator.

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

(2) Signature: [static] new QCollator new (const QCollator arg1)

Description: Constructor QCollator::QCollator(const QCollator &)

This method creates an object of class QCollator.

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

numericMode

Signature: [const] bool numericMode

Description: Method bool QCollator::numericMode()

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

numericMode=

Signature: void numericMode= (bool on)

Description: Method void QCollator::setNumericMode(bool on)

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

setCaseSensitivity

Signature: void setCaseSensitivity (const Qt_CaseSensitivity cs)

Description: Method void QCollator::setCaseSensitivity(Qt::CaseSensitivity cs)

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

setIgnorePunctuation

Signature: void setIgnorePunctuation (bool on)

Description: Method void QCollator::setIgnorePunctuation(bool on)

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

setLocale

Signature: void setLocale (const QLocale locale)

Description: Method void QCollator::setLocale(const QLocale &locale)

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

setNumericMode

Signature: void setNumericMode (bool on)

Description: Method void QCollator::setNumericMode(bool on)

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

sortKey

Signature: [const] QCollatorSortKey sortKey (string string)

Description: Method QCollatorSortKey QCollator::sortKey(const QString &string)

swap

Signature: void swap (QCollator other)

Description: Method void QCollator::swap(QCollator &other)