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

API reference - Class QLoggingCategory

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QLoggingCategory

Public constructors

new QLoggingCategorynew(string category)Constructor QLoggingCategory::QLoggingCategory(const char *category)
new QLoggingCategorynew(string category,
const QtMsgType severityLevel)
Constructor QLoggingCategory::QLoggingCategory(const char *category, QtMsgType severityLevel)

Public methods

QLoggingCategory()Method QLoggingCategory &QLoggingCategory::operator()()
[const]QLoggingCategory()Method const QLoggingCategory &QLoggingCategory::operator()()
[const]QLoggingCategory 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.
[const]stringcategoryNameMethod const char *QLoggingCategory::categoryName()
[const]boolisCriticalEnabled?Method bool QLoggingCategory::isCriticalEnabled()
[const]boolisDebugEnabled?Method bool QLoggingCategory::isDebugEnabled()
[const]boolisEnabled?(const QtMsgType type)Method bool QLoggingCategory::isEnabled(QtMsgType type)
[const]boolisInfoEnabled?Method bool QLoggingCategory::isInfoEnabled()
[const]boolisWarningEnabled?Method bool QLoggingCategory::isWarningEnabled()
voidsetEnabled(const QtMsgType type,
bool enable)
Method void QLoggingCategory::setEnabled(QtMsgType type, bool enable)

Public static methods and constants

QLoggingCategory ptrdefaultCategoryStatic method QLoggingCategory *QLoggingCategory::defaultCategory()
voidsetFilterRules(string rules)Static method void QLoggingCategory::setFilterRules(const QString &rules)

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: QLoggingCategory ()

Description: Method QLoggingCategory &QLoggingCategory::operator()()

(2) Signature: [const] QLoggingCategory ()

Description: Method const QLoggingCategory &QLoggingCategory::operator()()

_const_cast

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

categoryName

Signature: [const] string categoryName

Description: Method const char *QLoggingCategory::categoryName()

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.

defaultCategory

Signature: [static] QLoggingCategory ptr defaultCategory

Description: Static method QLoggingCategory *QLoggingCategory::defaultCategory()

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

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.

isCriticalEnabled?

Signature: [const] bool isCriticalEnabled?

Description: Method bool QLoggingCategory::isCriticalEnabled()

isDebugEnabled?

Signature: [const] bool isDebugEnabled?

Description: Method bool QLoggingCategory::isDebugEnabled()

isEnabled?

Signature: [const] bool isEnabled? (const QtMsgType type)

Description: Method bool QLoggingCategory::isEnabled(QtMsgType type)

isInfoEnabled?

Signature: [const] bool isInfoEnabled?

Description: Method bool QLoggingCategory::isInfoEnabled()

isWarningEnabled?

Signature: [const] bool isWarningEnabled?

Description: Method bool QLoggingCategory::isWarningEnabled()

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 QLoggingCategory new (string category)

Description: Constructor QLoggingCategory::QLoggingCategory(const char *category)

This method creates an object of class QLoggingCategory.

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

(2) Signature: [static] new QLoggingCategory new (string category, const QtMsgType severityLevel)

Description: Constructor QLoggingCategory::QLoggingCategory(const char *category, QtMsgType severityLevel)

This method creates an object of class QLoggingCategory.

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

setEnabled

Signature: void setEnabled (const QtMsgType type, bool enable)

Description: Method void QLoggingCategory::setEnabled(QtMsgType type, bool enable)

setFilterRules

Signature: [static] void setFilterRules (string rules)

Description: Static method void QLoggingCategory::setFilterRules(const QString &rules)

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