Struct QAttribute

#[repr(C)]
pub struct QAttribute { /* private fields */ }

Defines an attribute and how data should be read from a QBuffer.

C++ class: Qt3DRender::QAttribute.

C++ documentation:

Defines an attribute and how data should be read from a QBuffer.

There are 3 types of attributes.

• VertexAttribute: used to define data to be read on a per vertex basis
• IndexAttribute: used to define vertex indices when indexed draw calls are to be used
• DrawIndirectAttribute: used to specify the DrawIndirect buffer to be used when indirect draw calls are to be used

Note: when an attribute is of type DrawIndirectAttribute, only count, stride and offset are relevant.

When providing your own attributes, it may make sense to name your attribute using helpers such as QAttribute::defaultPositionAttributeName() as that will ensure your geometry will be compatible with picking and the various materials provided in the Qt3DExtras module.

Implementations

impl QAttribute

pub fn slot_set_buffer(&self) -> Receiver<(*mut QBuffer,)>

Holds the buffer.

Returns a built-in Qt slot Qt3DRender::QAttribute::setBuffer that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the buffer.

Access functions:

QBuffer *	buffer() const
void	setBuffer(QBuffer *buffer)

Notifier signal:

void	bufferChanged(QBuffer *buffer)

pub fn slot_set_name(&self) -> Receiver<(*const QString,)>

Holds the name.

Returns a built-in Qt slot Qt3DRender::QAttribute::setName that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the name.

Access functions:

QString	name() const
void	setName(const QString &name)

Notifier signal:

void	nameChanged(const QString &name)

pub fn slot_set_vertex_base_type(&self) -> Receiver<(VertexBaseType,)>

Holds the data type.

Returns a built-in Qt slot Qt3DRender::QAttribute::setVertexBaseType that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the data type.

Access functions:

VertexBaseType	vertexBaseType() const
void	setVertexBaseType(VertexBaseType type)

Notifier signal:

void	vertexBaseTypeChanged(VertexBaseType vertexBaseType)

pub fn slot_set_vertex_size(&self) -> Receiver<(c_uint,)>

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Returns a built-in Qt slot Qt3DRender::QAttribute::setVertexSize that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Access functions:

uint	vertexSize() const
void	setVertexSize(uint size)

Notifier signal:

void	vertexSizeChanged(uint vertexSize)

pub fn slot_set_data_type(&self) -> Receiver<(VertexBaseType,)>

This function is deprecated.

Returns a built-in Qt slot Qt3DRender::QAttribute::setDataType that can be passed to qt_core::Signal::connect.

C++ documentation:

This function is deprecated.

pub fn slot_set_data_size(&self) -> Receiver<(c_uint,)>

This function is deprecated.

Returns a built-in Qt slot Qt3DRender::QAttribute::setDataSize that can be passed to qt_core::Signal::connect.

C++ documentation:

This function is deprecated.

pub fn slot_set_count(&self) -> Receiver<(c_uint,)>

Holds the count.

Returns a built-in Qt slot Qt3DRender::QAttribute::setCount that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the count.

Access functions:

uint	count() const
void	setCount(uint count)

Notifier signal:

void	countChanged(uint count)

pub fn slot_set_byte_stride(&self) -> Receiver<(c_uint,)>

Holds the byte stride.

Returns a built-in Qt slot Qt3DRender::QAttribute::setByteStride that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the byte stride.

Access functions:

uint	byteStride() const
void	setByteStride(uint byteStride)

Notifier signal:

void	byteStrideChanged(uint byteStride)

pub fn slot_set_byte_offset(&self) -> Receiver<(c_uint,)>

Holds the byte offset.

Returns a built-in Qt slot Qt3DRender::QAttribute::setByteOffset that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the byte offset.

Access functions:

uint	byteOffset() const
void	setByteOffset(uint byteOffset)

Notifier signal:

void	byteOffsetChanged(uint byteOffset)

pub fn slot_set_divisor(&self) -> Receiver<(c_uint,)>

Holds the divisor.

Returns a built-in Qt slot Qt3DRender::QAttribute::setDivisor that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the divisor.

Access functions:

uint	divisor() const
void	setDivisor(uint divisor)

Notifier signal:

void	divisorChanged(uint divisor)

pub fn slot_set_attribute_type(&self) -> Receiver<(AttributeType,)>

Holds the attribute type.

Returns a built-in Qt slot Qt3DRender::QAttribute::setAttributeType that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the attribute type.

Access functions:

AttributeType	attributeType() const
void	setAttributeType(AttributeType attributeType)

Notifier signal:

void	attributeTypeChanged(AttributeType attributeType)

pub fn buffer_changed(&self) -> Signal<(*mut QBuffer,)>

Holds the buffer.

Returns a built-in Qt signal Qt3DRender::QAttribute::bufferChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the buffer.

Access functions:

QBuffer *	buffer() const
void	setBuffer(QBuffer *buffer)

Notifier signal:

void	bufferChanged(QBuffer *buffer)

pub fn name_changed(&self) -> Signal<(*const QString,)>

Holds the name.

Returns a built-in Qt signal Qt3DRender::QAttribute::nameChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the name.

Access functions:

QString	name() const
void	setName(const QString &name)

Notifier signal:

void	nameChanged(const QString &name)

pub fn vertex_base_type_changed(&self) -> Signal<(VertexBaseType,)>

Holds the data type.

Returns a built-in Qt signal Qt3DRender::QAttribute::vertexBaseTypeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the data type.

Access functions:

VertexBaseType	vertexBaseType() const
void	setVertexBaseType(VertexBaseType type)

Notifier signal:

void	vertexBaseTypeChanged(VertexBaseType vertexBaseType)

pub fn vertex_size_changed(&self) -> Signal<(c_uint,)>

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Returns a built-in Qt signal Qt3DRender::QAttribute::vertexSizeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Access functions:

uint	vertexSize() const
void	setVertexSize(uint size)

Notifier signal:

void	vertexSizeChanged(uint vertexSize)

pub fn data_type_changed(&self) -> Signal<(VertexBaseType,)>

The signal is emitted with vertexBaseType when the dataType changed.

Returns a built-in Qt signal Qt3DRender::QAttribute::dataTypeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

The signal is emitted with vertexBaseType when the dataType changed.

pub fn data_size_changed(&self) -> Signal<(c_uint,)>

The signal is emitted with vertexSize when the dataSize changes.

Returns a built-in Qt signal Qt3DRender::QAttribute::dataSizeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

The signal is emitted with vertexSize when the dataSize changes.

pub fn count_changed(&self) -> Signal<(c_uint,)>

Holds the count.

Returns a built-in Qt signal Qt3DRender::QAttribute::countChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the count.

Access functions:

uint	count() const
void	setCount(uint count)

Notifier signal:

void	countChanged(uint count)

pub fn byte_stride_changed(&self) -> Signal<(c_uint,)>

Holds the byte stride.

Returns a built-in Qt signal Qt3DRender::QAttribute::byteStrideChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the byte stride.

Access functions:

uint	byteStride() const
void	setByteStride(uint byteStride)

Notifier signal:

void	byteStrideChanged(uint byteStride)

pub fn byte_offset_changed(&self) -> Signal<(c_uint,)>

Holds the byte offset.

Returns a built-in Qt signal Qt3DRender::QAttribute::byteOffsetChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the byte offset.

Access functions:

uint	byteOffset() const
void	setByteOffset(uint byteOffset)

Notifier signal:

void	byteOffsetChanged(uint byteOffset)

pub fn divisor_changed(&self) -> Signal<(c_uint,)>

Holds the divisor.

Returns a built-in Qt signal Qt3DRender::QAttribute::divisorChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the divisor.

Access functions:

uint	divisor() const
void	setDivisor(uint divisor)

Notifier signal:

void	divisorChanged(uint divisor)

pub fn attribute_type_changed(&self) -> Signal<(AttributeType,)>

Holds the attribute type.

Returns a built-in Qt signal Qt3DRender::QAttribute::attributeTypeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the attribute type.

Access functions:

AttributeType	attributeType() const
void	setAttributeType(AttributeType attributeType)

Notifier signal:

void	attributeTypeChanged(AttributeType attributeType)

pub unsafe fn attribute_type(&self) -> AttributeType

Holds the attribute type.

Calls C++ function: Qt3DRender::QAttribute::AttributeType Qt3DRender::QAttribute::attributeType() const.

C++ documentation:

Holds the attribute type.

Access functions:

AttributeType	attributeType() const
void	setAttributeType(AttributeType attributeType)

Notifier signal:

void	attributeTypeChanged(AttributeType attributeType)

pub unsafe fn buffer(&self) -> QPtr<QBuffer>

Holds the buffer.

Calls C++ function: Qt3DRender::QBuffer* Qt3DRender::QAttribute::buffer() const.

C++ documentation:

Holds the buffer.

Access functions:

QBuffer *	buffer() const
void	setBuffer(QBuffer *buffer)

Notifier signal:

void	bufferChanged(QBuffer *buffer)

pub unsafe fn byte_offset(&self) -> c_uint

Holds the byte offset.

Calls C++ function: unsigned int Qt3DRender::QAttribute::byteOffset() const.

C++ documentation:

Holds the byte offset.

Access functions:

uint	byteOffset() const
void	setByteOffset(uint byteOffset)

Notifier signal:

void	byteOffsetChanged(uint byteOffset)

pub unsafe fn byte_stride(&self) -> c_uint

Holds the byte stride.

Calls C++ function: unsigned int Qt3DRender::QAttribute::byteStride() const.

C++ documentation:

Holds the byte stride.

Access functions:

uint	byteStride() const
void	setByteStride(uint byteStride)

Notifier signal:

void	byteStrideChanged(uint byteStride)

pub unsafe fn count(&self) -> c_uint

Holds the count.

Calls C++ function: unsigned int Qt3DRender::QAttribute::count() const.

C++ documentation:

Holds the count.

Access functions:

uint	count() const
void	setCount(uint count)

Notifier signal:

void	countChanged(uint count)

pub unsafe fn default_color_attribute_name() -> CppBox<QString>

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultColorAttributeName().

C++ documentation:

Access functions:

QString

defaultColorAttributeName()

pub unsafe fn default_joint_indices_attribute_name() -> CppBox<QString>

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultJointIndicesAttributeName().

C++ documentation:

Access functions:

QString

defaultJointIndicesAttributeName()

pub unsafe fn default_joint_weights_attribute_name() -> CppBox<QString>

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultJointWeightsAttributeName().

C++ documentation:

Access functions:

QString

defaultJointWeightsAttributeName()

pub unsafe fn default_normal_attribute_name() -> CppBox<QString>

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultNormalAttributeName().

C++ documentation:

Access functions:

QString

defaultNormalAttributeName()

pub unsafe fn default_position_attribute_name() -> CppBox<QString>

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultPositionAttributeName().

C++ documentation:

Access functions:

QString

defaultPositionAttributeName()

pub unsafe fn default_tangent_attribute_name() -> CppBox<QString>

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultTangentAttributeName().

C++ documentation:

Access functions:

QString

defaultTangentAttributeName()

pub unsafe fn default_texture_coordinate1_attribute_name() -> CppBox<QString>

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultTextureCoordinate1AttributeName().

C++ documentation:

Access functions:

QString

defaultTextureCoordinate1AttributeName()

pub unsafe fn default_texture_coordinate2_attribute_name() -> CppBox<QString>

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultTextureCoordinate2AttributeName().

C++ documentation:

Access functions:

QString

defaultTextureCoordinate2AttributeName()

pub unsafe fn default_texture_coordinate_attribute_name() -> CppBox<QString>

Access functions:

Calls C++ function: static QString Qt3DRender::QAttribute::defaultTextureCoordinateAttributeName().

C++ documentation:

Access functions:

QString

defaultTextureCoordinateAttributeName()

pub unsafe fn divisor(&self) -> c_uint

Holds the divisor.

Calls C++ function: unsigned int Qt3DRender::QAttribute::divisor() const.

C++ documentation:

Holds the divisor.

Access functions:

uint	divisor() const
void	setDivisor(uint divisor)

Notifier signal:

void	divisorChanged(uint divisor)

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DRender::QAttribute::metaObject() const.

pub unsafe fn name(&self) -> CppBox<QString>

Holds the name.

Calls C++ function: QString Qt3DRender::QAttribute::name() const.

C++ documentation:

Holds the name.

Access functions:

QString	name() const
void	setName(const QString &name)

Notifier signal:

void	nameChanged(const QString &name)

pub unsafe fn from_q_node(parent: impl CastInto<Ptr<QNode>>) -> QBox<QAttribute>

Constructs a new QAttribute with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DCore::QNode* parent = …).

C++ documentation:

Constructs a new QAttribute with parent.

pub unsafe fn from_q_buffer_vertex_base_type4_uint_q_node( buf: impl CastInto<Ptr<QBuffer>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, offset: c_uint, stride: c_uint, parent: impl CastInto<Ptr<QNode>>, ) -> QBox<QAttribute>

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count, unsigned int offset = …, unsigned int stride = …, Qt3DCore::QNode* parent = …).

C++ documentation:

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn from_q_buffer_q_string_vertex_base_type4_uint_q_node( buf: impl CastInto<Ptr<QBuffer>>, name: impl CastInto<Ref<QString>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, offset: c_uint, stride: c_uint, parent: impl CastInto<Ptr<QNode>>, ) -> QBox<QAttribute>

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, const QString& name, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count, unsigned int offset = …, unsigned int stride = …, Qt3DCore::QNode* parent = …).

C++ documentation:

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn new() -> QBox<QAttribute>

Defines an attribute and how data should be read from a QBuffer.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute().

C++ documentation:

Defines an attribute and how data should be read from a QBuffer.

There are 3 types of attributes.

• VertexAttribute: used to define data to be read on a per vertex basis
• IndexAttribute: used to define vertex indices when indexed draw calls are to be used
• DrawIndirectAttribute: used to specify the DrawIndirect buffer to be used when indirect draw calls are to be used

Note: when an attribute is of type DrawIndirectAttribute, only count, stride and offset are relevant.

When providing your own attributes, it may make sense to name your attribute using helpers such as QAttribute::defaultPositionAttributeName() as that will ensure your geometry will be compatible with picking and the various materials provided in the Qt3DExtras module.

pub unsafe fn from_q_buffer_vertex_base_type4_uint( buf: impl CastInto<Ptr<QBuffer>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, offset: c_uint, stride: c_uint, ) -> QBox<QAttribute>

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count, unsigned int offset = …, unsigned int stride = …).

C++ documentation:

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn from_q_buffer_vertex_base_type3_uint( buf: impl CastInto<Ptr<QBuffer>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, offset: c_uint, ) -> QBox<QAttribute>

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count, unsigned int offset = …).

C++ documentation:

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn from_q_buffer_vertex_base_type2_uint( buf: impl CastInto<Ptr<QBuffer>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, ) -> QBox<QAttribute>

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count).

C++ documentation:

Constructs a new QAttribute from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn from_q_buffer_q_string_vertex_base_type4_uint( buf: impl CastInto<Ptr<QBuffer>>, name: impl CastInto<Ref<QString>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, offset: c_uint, stride: c_uint, ) -> QBox<QAttribute>

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, const QString& name, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count, unsigned int offset = …, unsigned int stride = …).

C++ documentation:

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn from_q_buffer_q_string_vertex_base_type3_uint( buf: impl CastInto<Ptr<QBuffer>>, name: impl CastInto<Ref<QString>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, offset: c_uint, ) -> QBox<QAttribute>

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, const QString& name, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count, unsigned int offset = …).

C++ documentation:

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn from_q_buffer_q_string_vertex_base_type2_uint( buf: impl CastInto<Ptr<QBuffer>>, name: impl CastInto<Ref<QString>>, vertex_base_type: VertexBaseType, vertex_size: c_uint, count: c_uint, ) -> QBox<QAttribute>

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

Calls C++ function: [constructor] void Qt3DRender::QAttribute::QAttribute(Qt3DRender::QBuffer* buf, const QString& name, Qt3DRender::QAttribute::VertexBaseType vertexBaseType, unsigned int vertexSize, unsigned int count).

C++ documentation:

Constructs a new QAttribute named name from buf of type, dataSize, count, offset, and stride with parent.

pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void, ) -> c_int

Calls C++ function: virtual int Qt3DRender::QAttribute::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* Qt3DRender::QAttribute::qt_metacast(const char* arg1).

pub unsafe fn set_attribute_type(&self, attribute_type: AttributeType)

Holds the attribute type.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setAttributeType(Qt3DRender::QAttribute::AttributeType attributeType).

C++ documentation:

Holds the attribute type.

Access functions:

AttributeType	attributeType() const
void	setAttributeType(AttributeType attributeType)

Notifier signal:

void	attributeTypeChanged(AttributeType attributeType)

pub unsafe fn set_buffer(&self, buffer: impl CastInto<Ptr<QBuffer>>)

Holds the buffer.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setBuffer(Qt3DRender::QBuffer* buffer).

C++ documentation:

Holds the buffer.

Access functions:

QBuffer *	buffer() const
void	setBuffer(QBuffer *buffer)

Notifier signal:

void	bufferChanged(QBuffer *buffer)

pub unsafe fn set_byte_offset(&self, byte_offset: c_uint)

Holds the byte offset.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setByteOffset(unsigned int byteOffset).

C++ documentation:

Holds the byte offset.

Access functions:

uint	byteOffset() const
void	setByteOffset(uint byteOffset)

Notifier signal:

void	byteOffsetChanged(uint byteOffset)

pub unsafe fn set_byte_stride(&self, byte_stride: c_uint)

Holds the byte stride.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setByteStride(unsigned int byteStride).

C++ documentation:

Holds the byte stride.

Access functions:

uint	byteStride() const
void	setByteStride(uint byteStride)

Notifier signal:

void	byteStrideChanged(uint byteStride)

pub unsafe fn set_count(&self, count: c_uint)

Holds the count.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setCount(unsigned int count).

C++ documentation:

Holds the count.

Access functions:

uint	count() const
void	setCount(uint count)

Notifier signal:

void	countChanged(uint count)

pub unsafe fn set_data_size(&self, size: c_uint)

This function is deprecated.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setDataSize(unsigned int size).

C++ documentation:

This function is deprecated.

pub unsafe fn set_data_type(&self, type_: VertexBaseType)

This function is deprecated.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setDataType(Qt3DRender::QAttribute::VertexBaseType type).

C++ documentation:

This function is deprecated.

pub unsafe fn set_divisor(&self, divisor: c_uint)

Holds the divisor.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setDivisor(unsigned int divisor).

C++ documentation:

Holds the divisor.

Access functions:

uint	divisor() const
void	setDivisor(uint divisor)

Notifier signal:

void	divisorChanged(uint divisor)

pub unsafe fn set_name(&self, name: impl CastInto<Ref<QString>>)

Holds the name.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setName(const QString& name).

C++ documentation:

Holds the name.

Access functions:

QString	name() const
void	setName(const QString &name)

Notifier signal:

void	nameChanged(const QString &name)

pub unsafe fn set_vertex_base_type(&self, type_: VertexBaseType)

Holds the data type.

Calls C++ function: [slot] void Qt3DRender::QAttribute::setVertexBaseType(Qt3DRender::QAttribute::VertexBaseType type).

C++ documentation:

Holds the data type.

Access functions:

VertexBaseType	vertexBaseType() const
void	setVertexBaseType(VertexBaseType type)

Notifier signal:

void	vertexBaseTypeChanged(VertexBaseType vertexBaseType)

pub unsafe fn set_vertex_size(&self, size: c_uint)

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Calls C++ function: [slot] void Qt3DRender::QAttribute::setVertexSize(unsigned int size).

C++ documentation:

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Access functions:

uint	vertexSize() const
void	setVertexSize(uint size)

Notifier signal:

void	vertexSizeChanged(uint vertexSize)

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr( s: *const c_char, c: *const c_char, n: c_int, ) -> CppBox<QString>

Calls C++ function: static QString Qt3DRender::QAttribute::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8( s: *const c_char, c: *const c_char, n: c_int, ) -> CppBox<QString>

Calls C++ function: static QString Qt3DRender::QAttribute::trUtf8(const char* s, const char* c, int n).

pub unsafe fn vertex_base_type(&self) -> VertexBaseType

Holds the data type.

Calls C++ function: Qt3DRender::QAttribute::VertexBaseType Qt3DRender::QAttribute::vertexBaseType() const.

C++ documentation:

Holds the data type.

Access functions:

VertexBaseType	vertexBaseType() const
void	setVertexBaseType(VertexBaseType type)

Notifier signal:

void	vertexBaseTypeChanged(VertexBaseType vertexBaseType)

pub unsafe fn vertex_size(&self) -> c_uint

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Calls C++ function: unsigned int Qt3DRender::QAttribute::vertexSize() const.

C++ documentation:

Holds the data size, it can only be 1 to 4 units (scalars and vectors), 9 units (3x3 matrices) or 16 units (4x4 matrices).

Access functions:

uint	vertexSize() const
void	setVertexSize(uint size)

Notifier signal:

void	vertexSizeChanged(uint vertexSize)

Methods from Deref<Target = QNode>

pub fn slot_set_parent(&self) -> Receiver<(*mut QNode,)>

Holds the immediate QNode parent, or null if the node has no parent.

Returns a built-in Qt slot Qt3DCore::QNode::setParent that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub fn slot_set_enabled(&self) -> Receiver<(bool,)>

Holds the QNode enabled flag. By default a QNode is always enabled.

Returns a built-in Qt slot Qt3DCore::QNode::setEnabled that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub fn slot_set_default_property_tracking_mode( &self, ) -> Receiver<(PropertyTrackingMode,)>

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Returns a built-in Qt slot Qt3DCore::QNode::setDefaultPropertyTrackingMode that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub fn parent_changed(&self) -> Signal<(*mut QObject,)>

Holds the immediate QNode parent, or null if the node has no parent.

Returns a built-in Qt signal Qt3DCore::QNode::parentChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub fn enabled_changed(&self) -> Signal<(bool,)>

Holds the QNode enabled flag. By default a QNode is always enabled.

Returns a built-in Qt signal Qt3DCore::QNode::enabledChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub fn default_property_tracking_mode_changed( &self, ) -> Signal<(PropertyTrackingMode,)>

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Returns a built-in Qt signal Qt3DCore::QNode::defaultPropertyTrackingModeChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub fn node_destroyed(&self) -> Signal<()>

emitted when the node is destroyed.

Returns a built-in Qt signal Qt3DCore::QNode::nodeDestroyed that can be passed to qt_core::Signal::connect.

C++ documentation:

emitted when the node is destroyed.

pub unsafe fn block_notifications(&self, block: bool) -> bool

If block is true, property change notifications sent by this object to aspects are blocked. If block is false, no such blocking will occur.

Calls C++ function: bool Qt3DCore::QNode::blockNotifications(bool block).

C++ documentation:

If block is true, property change notifications sent by this object to aspects are blocked. If block is false, no such blocking will occur.

The return value is the previous value of notificationsBlocked().

Note that the other notification types will be sent even if the notifications for this object have been blocked.

See also notificationsBlocked().

pub unsafe fn child_nodes(&self) -> CppBox<QVectorOfQNode>

Returns a list filled with the QNode children of the current QNode instance.

Calls C++ function: QVector<Qt3DCore::QNode*> Qt3DCore::QNode::childNodes() const.

C++ documentation:

Returns a list filled with the QNode children of the current QNode instance.

pub unsafe fn clear_property_tracking( &self, property_name: impl CastInto<Ref<QString>>, )

Clears the tracking property called propertyName.

Calls C++ function: void Qt3DCore::QNode::clearPropertyTracking(const QString& propertyName).

C++ documentation:

Clears the tracking property called propertyName.

pub unsafe fn clear_property_trackings(&self)

Erases all values that have been saved by the property tracking.

Calls C++ function: void Qt3DCore::QNode::clearPropertyTrackings().

C++ documentation:

Erases all values that have been saved by the property tracking.

pub unsafe fn default_property_tracking_mode(&self) -> PropertyTrackingMode

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Calls C++ function: Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::defaultPropertyTrackingMode() const.

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub unsafe fn id(&self) -> CppBox<QNodeId>

Returns the id that uniquely identifies the QNode instance.

Calls C++ function: Qt3DCore::QNodeId Qt3DCore::QNode::id() const.

C++ documentation:

Returns the id that uniquely identifies the QNode instance.

pub unsafe fn is_enabled(&self) -> bool

Holds the QNode enabled flag. By default a QNode is always enabled.

Calls C++ function: bool Qt3DCore::QNode::isEnabled() const.

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DCore::QNode::metaObject() const.

pub unsafe fn notifications_blocked(&self) -> bool

Returns true if aspect notifications are blocked; otherwise returns false. By default, notifications are not blocked.

Calls C++ function: bool Qt3DCore::QNode::notificationsBlocked() const.

C++ documentation:

Returns true if aspect notifications are blocked; otherwise returns false. By default, notifications are not blocked.

See also blockNotifications().

pub unsafe fn parent_node(&self) -> QPtr<QNode>

Holds the immediate QNode parent, or null if the node has no parent.

Calls C++ function: Qt3DCore::QNode* Qt3DCore::QNode::parentNode() const.

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub unsafe fn property_tracking( &self, property_name: impl CastInto<Ref<QString>>, ) -> PropertyTrackingMode

See also setPropertyTracking().

Calls C++ function: Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::propertyTracking(const QString& propertyName) const.

C++ documentation:

See also setPropertyTracking().

pub unsafe fn qt_metacall( &self, arg1: Call, arg2: i32, arg3: *mut *mut c_void, ) -> i32

Calls C++ function: virtual int Qt3DCore::QNode::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const i8) -> *mut c_void

Calls C++ function: virtual void* Qt3DCore::QNode::qt_metacast(const char* arg1).

pub unsafe fn send_command_3a( &self, name: impl CastInto<Ref<QString>>, data: impl CastInto<Ref<QVariant>>, reply_to: u64, ) -> u64

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Sends a command messages to the backend node

Calls C++ function: unsigned long long Qt3DCore::QNode::sendCommand(const QString& name, const QVariant& data = …, unsigned long long replyTo = …).

C++ documentation:

Sends a command messages to the backend node

Creates a QNodeCommand message and dispatches it to the backend node. The command is given and a name and some data which can be used in the backend node to performe various operations. This returns a CommandId which can be used to identify the initial command when receiving a message in reply. If the command message is to be sent in reply to another command, replyTo contains the id of that command.

See also QNodeCommand and QNode::sendReply.

pub unsafe fn send_command_2a( &self, name: impl CastInto<Ref<QString>>, data: impl CastInto<Ref<QVariant>>, ) -> u64

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Sends a command messages to the backend node

Calls C++ function: unsigned long long Qt3DCore::QNode::sendCommand(const QString& name, const QVariant& data = …).

C++ documentation:

Sends a command messages to the backend node

Creates a QNodeCommand message and dispatches it to the backend node. The command is given and a name and some data which can be used in the backend node to performe various operations. This returns a CommandId which can be used to identify the initial command when receiving a message in reply. If the command message is to be sent in reply to another command, replyTo contains the id of that command.

See also QNodeCommand and QNode::sendReply.

pub unsafe fn send_command_1a(&self, name: impl CastInto<Ref<QString>>) -> u64

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Sends a command messages to the backend node

Calls C++ function: unsigned long long Qt3DCore::QNode::sendCommand(const QString& name).

C++ documentation:

Sends a command messages to the backend node

Creates a QNodeCommand message and dispatches it to the backend node. The command is given and a name and some data which can be used in the backend node to performe various operations. This returns a CommandId which can be used to identify the initial command when receiving a message in reply. If the command message is to be sent in reply to another command, replyTo contains the id of that command.

See also QNodeCommand and QNode::sendReply.

pub unsafe fn set_default_property_tracking_mode( &self, mode: PropertyTrackingMode, )

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven't been overridden by a call to setPropertyTracking.

Calls C++ function: [slot] void Qt3DCore::QNode::setDefaultPropertyTrackingMode(Qt3DCore::QNode::PropertyTrackingMode mode).

C++ documentation:

Holds the default property tracking mode which determines whether a QNode should be listening for property updates. This only applies to properties which haven’t been overridden by a call to setPropertyTracking.

By default it is set to QNode::TrackFinalValues

Access functions:

PropertyTrackingMode	defaultPropertyTrackingMode() const
void	setDefaultPropertyTrackingMode(PropertyTrackingMode mode)

Notifier signal:

void	defaultPropertyTrackingModeChanged(PropertyTrackingMode mode)

pub unsafe fn set_enabled(&self, is_enabled: bool)

Holds the QNode enabled flag. By default a QNode is always enabled.

Calls C++ function: [slot] void Qt3DCore::QNode::setEnabled(bool isEnabled).

C++ documentation:

Holds the QNode enabled flag. By default a QNode is always enabled.

Note: the interpretation of what enabled means is aspect-dependent. Even if enabled is set to false, some aspects may still consider the node in some manner. This is documented on a class by class basis.

Access functions:

bool	isEnabled() const
void	setEnabled(bool isEnabled)

Notifier signal:

void	enabledChanged(bool enabled)

pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QNode>>)

Holds the immediate QNode parent, or null if the node has no parent.

Calls C++ function: [slot] void Qt3DCore::QNode::setParent(Qt3DCore::QNode* parent).

C++ documentation:

Holds the immediate QNode parent, or null if the node has no parent.

Setting the parent will notify the backend aspects about current QNode instance's parent change.

Note: if parent happens to be null, this will actually notify that the current QNode instance was removed from the scene.

Access functions:

QNode *	parentNode() const
void	setParent(QNode *parent)

Notifier signal:

void	parentChanged(QObject *parent)

pub unsafe fn set_property_tracking( &self, property_name: impl CastInto<Ref<QString>>, track_mode: PropertyTrackingMode, )

See also propertyTracking().

Calls C++ function: void Qt3DCore::QNode::setPropertyTracking(const QString& propertyName, Qt3DCore::QNode::PropertyTrackingMode trackMode).

C++ documentation:

See also propertyTracking().

Methods from Deref<Target = QObject>

pub unsafe fn find_child<T>( &self, name: &str, ) -> Result<QPtr<T>, FindChildError>

where QObject: DynamicCast<T>, T: StaticUpcast<QObject>,

Finds a child of self with the specified object name and casts it to type T.

The search is performed recursively. If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned.

Returns an error if there is no child object with object name name or the found object cannot be cast to T.

pub fn destroyed(&self) -> Signal<(*mut QObject,)>

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

Returns a built-in Qt signal QObject::destroyed that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

All the objects's children are destroyed immediately after this signal is emitted.

See also deleteLater() and QPointer.

pub fn object_name_changed(&self) -> Signal<(*const QString,)>

This signal is emitted after the object's name has been changed. The new object name is passed as objectName.

Returns a built-in Qt signal QObject::objectNameChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted after the object’s name has been changed. The new object name is passed as objectName.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property objectName.

See also QObject::objectName.

pub fn slot_delete_later(&self) -> Receiver<()>

Schedules this object for deletion.

Returns a built-in Qt slot QObject::deleteLater that can be passed to qt_core::Signal::connect.

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

pub unsafe fn block_signals(&self, b: bool) -> bool

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

Calls C++ function: bool QObject::blockSignals(bool b).

C++ documentation:

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

The return value is the previous value of signalsBlocked().

Note that the destroyed() signal will be emitted even if the signals for this object have been blocked.

Signals emitted while being blocked are not buffered.

See also signalsBlocked() and QSignalBlocker.

pub unsafe fn children(&self) -> Ref<QListOfQObject>

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

Calls C++ function: const QList<QObject*>& QObject::children() const.

C++ documentation:

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

  typedef QList<QObject*> QObjectList;

The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end.

Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list.

See also findChild(), findChildren(), parent(), and setParent().

pub unsafe fn delete_later(&self)

Schedules this object for deletion.

Calls C++ function: [slot] void QObject::deleteLater().

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

pub unsafe fn disconnect_char_q_object_char( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …, const char* member = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_q_object_char( &self, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const QObject* receiver, const char* member = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects all signals in this object from receiver's method.

A signal-slot connection is removed when either of the objects involved are destroyed.

pub unsafe fn disconnect_char_q_object( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_char(&self, signal: *const i8) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect(&self) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect() const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_q_object( &self, receiver: impl CastInto<Ptr<QObject>>, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const QObject* receiver) const.

C++ documentation:

This function overloads disconnect().

Disconnects all signals in this object from receiver's method.

A signal-slot connection is removed when either of the objects involved are destroyed.

pub unsafe fn dump_object_info_mut(&self)

Dumps information about signal connections, etc. for this object to the debug output.

Calls C++ function: void QObject::dumpObjectInfo().

C++ documentation:

Dumps information about signal connections, etc. for this object to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectTree().

pub unsafe fn dump_object_info(&self)

Dumps information about signal connections, etc. for this object to the debug output.

Calls C++ function: void QObject::dumpObjectInfo() const.

C++ documentation:

Dumps information about signal connections, etc. for this object to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectTree().

pub unsafe fn dump_object_tree_mut(&self)

Dumps a tree of children to the debug output.

Calls C++ function: void QObject::dumpObjectTree().

C++ documentation:

Dumps a tree of children to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectInfo().

pub unsafe fn dump_object_tree(&self)

Dumps a tree of children to the debug output.

Calls C++ function: void QObject::dumpObjectTree() const.

C++ documentation:

Dumps a tree of children to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectInfo().

pub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>

Returns the names of all properties that were dynamically added to the object using setProperty().

Calls C++ function: QList<QByteArray> QObject::dynamicPropertyNames() const.

C++ documentation:

Returns the names of all properties that were dynamically added to the object using setProperty().

This function was introduced in Qt 4.2.

pub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool

Returns true if c1 and c2 are the same Unicode character; otherwise returns false.

Calls C++ function: bool operator==(QObject* o, const QPointer<QObject>& p).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for bool operator==(QChar c1, QChar c2):

Returns true if c1 and c2 are the same Unicode character; otherwise returns false.

pub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool

This virtual function receives events to an object and should return true if the event e was recognized and processed.

Calls C++ function: virtual bool QObject::event(QEvent* event).

C++ documentation:

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
      Q_OBJECT
public:
      MyClass(QWidget *parent = 0);
      ~MyClass();
      bool event(QEvent* ev)
      {
          if (ev->type() == QEvent::PolishRequest) {
              // overwrite handling of PolishRequest if any
              doThings();
              return true;
          } else  if (ev->type() == QEvent::Show) {
              // complement handling of Show if any
              doThings2();
              QWidget::event(ev);
              return true;
          }
          // Make sure the rest of events are handled
          return QWidget::event(ev);
      }
};

See also installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), and QCoreApplication::postEvent().

pub unsafe fn event_filter( &self, watched: impl CastInto<Ptr<QObject>>, event: impl CastInto<Ptr<QEvent>>, ) -> bool

Filters events if this object has been installed as an event filter for the watched object.

Calls C++ function: virtual bool QObject::eventFilter(QObject* watched, QEvent* event).

C++ documentation:

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
      MainWindow();
protected:
      bool eventFilter(QObject obj, QEvent ev);
private:
      QTextEdit *textEdit;
};
MainWindow::MainWindow()
{
      textEdit = new QTextEdit;
      setCentralWidget(textEdit);
      textEdit->installEventFilter(this);
}
bool MainWindow::eventFilter(QObject obj, QEvent event)
{
      if (obj == textEdit) {
          if (event->type() == QEvent::KeyPress) {
              QKeyEvent keyEvent = static_cast<QKeyEvent>(event);
              qDebug() << “Ate key press” << keyEvent->key();
              return true;
          } else {
              return false;
          }
      } else {
          // pass the event on to the parent class
          return QMainWindow::eventFilter(obj, event);
      }
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also installEventFilter().

pub unsafe fn find_child_q_object_2a( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_child_q_object_1a( &self, a_name: impl CastInto<Ref<QString>>, ) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …) const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>() const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_children_q_object_q_string_q_flags_find_child_option( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegExp>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

pub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegularExpression>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

This function was introduced in Qt 5.0.

pub unsafe fn find_children_q_object_q_string( &self, a_name: impl CastInto<Ref<QString>>, ) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …) const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>() const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object_q_reg_exp( &self, re: impl CastInto<Ref<QRegExp>>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

pub unsafe fn find_children_q_object_q_regular_expression( &self, re: impl CastInto<Ref<QRegularExpression>>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

This function was introduced in Qt 5.0.

pub unsafe fn inherits(&self, classname: *const i8) -> bool

Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Calls C++ function: bool QObject::inherits(const char* classname) const.

C++ documentation:

Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

A class is considered to inherit itself.

Example:

QTimer *timer = new QTimer;         // QTimer inherits QObject
timer->inherits(“QTimer”);          // returns true
timer->inherits(“QObject”);         // returns true
timer->inherits(“QAbstractButton”); // returns false
// QVBoxLayout inherits QObject and QLayoutItem
QVBoxLayout *layout = new QVBoxLayout;
layout->inherits(“QObject”);        // returns true
layout->inherits(“QLayoutItem”);    // returns true (even though QLayoutItem is not a QObject)

If you need to determine whether an object is an instance of a particular class for the purpose of casting it, consider using qobject_cast<Type *>(object) instead.

See also metaObject() and qobject_cast().

pub unsafe fn install_event_filter( &self, filter_obj: impl CastInto<Ptr<QObject>>, )

Installs an event filter filterObj on this object. For example:

Calls C++ function: void QObject::installEventFilter(QObject* filterObj).

C++ documentation:

Installs an event filter filterObj on this object. For example:

  monitoredObj->installEventFilter(filterObj);

An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter filterObj receives events via its eventFilter() function. The eventFilter() function must return true if the event should be filtered, (i.e. stopped); otherwise it must return false.

If multiple event filters are installed on a single object, the filter that was installed last is activated first.

Here's a KeyPressEater class that eats the key presses of its monitored objects:

class KeyPressEater : public QObject
{
      Q_OBJECT
      ...
protected:
      bool eventFilter(QObject obj, QEvent event);
};
bool KeyPressEater::eventFilter(QObject obj, QEvent event)
{
      if (event->type() == QEvent::KeyPress) {
          QKeyEvent keyEvent = static_cast<QKeyEvent >(event);
          qDebug(“Ate key press %d”, keyEvent->key());
          return true;
      } else {
          // standard event processing
          return QObject::eventFilter(obj, event);
      }
}

And here's how to install it on two widgets:

KeyPressEater keyPressEater = new KeyPressEater(this);
QPushButton pushButton = new QPushButton(this);
QListView *listView = new QListView(this);
pushButton->installEventFilter(keyPressEater);
listView->installEventFilter(keyPressEater);

The QShortcut class, for example, uses this technique to intercept shortcut key presses.

Warning: If you delete the receiver object in your eventFilter() function, be sure to return true. If you return false, Qt sends the event to the deleted object and the program will crash.

Note that the filtering object must be in the same thread as this object. If filterObj is in a different thread, this function does nothing. If either filterObj or this object are moved to a different thread after calling this function, the event filter will not be called until both objects have the same thread affinity again (it is not removed).

See also removeEventFilter(), eventFilter(), and event().

pub unsafe fn is_widget_type(&self) -> bool

Returns true if the object is a widget; otherwise returns false.

Calls C++ function: bool QObject::isWidgetType() const.

C++ documentation:

Returns true if the object is a widget; otherwise returns false.

Calling this function is equivalent to calling inherits("QWidget"), except that it is much faster.

pub unsafe fn is_window_type(&self) -> bool

Returns true if the object is a window; otherwise returns false.

Calls C++ function: bool QObject::isWindowType() const.

C++ documentation:

Returns true if the object is a window; otherwise returns false.

Calling this function is equivalent to calling inherits("QWindow"), except that it is much faster.

pub unsafe fn kill_timer(&self, id: i32)

Kills the timer with timer identifier, id.

Calls C++ function: void QObject::killTimer(int id).

C++ documentation:

Kills the timer with timer identifier, id.

The timer identifier is returned by startTimer() when a timer event is started.

See also timerEvent() and startTimer().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Returns a pointer to the meta-object of this object.

Calls C++ function: virtual const QMetaObject* QObject::metaObject() const.

C++ documentation:

Returns a pointer to the meta-object of this object.

A meta-object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every QObject subclass that contains the Q_OBJECT macro will have a meta-object.

The meta-object information is required by the signal/slot connection mechanism and the property system. The inherits() function also makes use of the meta-object.

If you have no pointer to an actual object instance but still want to access the meta-object of a class, you can use staticMetaObject.

Example:

QObject *obj = new QPushButton;
obj->metaObject()->className();             // returns “QPushButton”
QPushButton::staticMetaObject.className();  // returns “QPushButton”

See also staticMetaObject.

pub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)

Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.

Calls C++ function: void QObject::moveToThread(QThread* thread).

C++ documentation:

Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.

To move an object to the main thread, use QApplication::instance() to retrieve a pointer to the current application, and then use QApplication::thread() to retrieve the thread in which the application lives. For example:

myObject->moveToThread(QApplication::instance()->thread());

If targetThread is zero, all event processing for this object and its children stops.

Note that all active timers for the object will be reset. The timers are first stopped in the current thread and restarted (with the same interval) in the targetThread. As a result, constantly moving an object between threads can postpone timer events indefinitely.

A QEvent::ThreadChange event is sent to this object just before the thread affinity is changed. You can handle this event to perform any special processing. Note that any new events that are posted to this object will be handled in the targetThread.

Warning: This function is not thread-safe; the current thread must be same as the current thread affinity. In other words, this function can only "push" an object from the current thread to another thread, it cannot "pull" an object from any arbitrary thread to the current thread.

See also thread().

pub unsafe fn object_name(&self) -> CppBox<QString>

This property holds the name of this object

Calls C++ function: QString QObject::objectName() const.

C++ documentation:

This property holds the name of this object

You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().

qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”,
         qPrintable(objectName()), newPrecision);

By default, this property contains an empty string.

Access functions:

QString	objectName() const
void	setObjectName(const QString &name)

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also metaObject() and QMetaObject::className().

pub unsafe fn parent(&self) -> QPtr<QObject>

Returns a pointer to the parent object.

Calls C++ function: QObject* QObject::parent() const.

C++ documentation:

Returns a pointer to the parent object.

See also setParent() and children().

pub unsafe fn property(&self, name: *const i8) -> CppBox<QVariant>

Returns the value of the object's name property.

Calls C++ function: QVariant QObject::property(const char* name) const.

C++ documentation:

Returns the value of the object’s name property.

If no such property exists, the returned variant is invalid.

Information about all available properties is provided through the metaObject() and dynamicPropertyNames().

See also setProperty(), QVariant::isValid(), metaObject(), and dynamicPropertyNames().

pub unsafe fn qt_metacall( &self, arg1: Call, arg2: i32, arg3: *mut *mut c_void, ) -> i32

Calls C++ function: virtual int QObject::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const i8) -> *mut c_void

Calls C++ function: virtual void* QObject::qt_metacast(const char* arg1).

pub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)

Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.

Calls C++ function: void QObject::removeEventFilter(QObject* obj).

C++ documentation:

Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.

All event filters for this object are automatically removed when this object is destroyed.

It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function).

See also installEventFilter(), eventFilter(), and event().

pub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)

This property holds the name of this object

Calls C++ function: void QObject::setObjectName(const QString& name).

C++ documentation:

This property holds the name of this object

You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().

qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”,
         qPrintable(objectName()), newPrecision);

By default, this property contains an empty string.

Access functions:

QString	objectName() const
void	setObjectName(const QString &name)

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also metaObject() and QMetaObject::className().

pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)

Makes the object a child of parent.

Calls C++ function: void QObject::setParent(QObject* parent).

C++ documentation:

Makes the object a child of parent.

See also parent() and children().

pub unsafe fn set_property( &self, name: *const i8, value: impl CastInto<Ref<QVariant>>, ) -> bool

Sets the value of the object's name property to value.

Calls C++ function: bool QObject::setProperty(const char* name, const QVariant& value).

C++ documentation:

Sets the value of the object’s name property to value.

If the property is defined in the class using Q_PROPERTY then true is returned on success and false otherwise. If the property is not defined using Q_PROPERTY, and therefore not listed in the meta-object, it is added as a dynamic property and false is returned.

Information about all available properties is provided through the metaObject() and dynamicPropertyNames().

Dynamic properties can be queried again using property() and can be removed by setting the property value to an invalid QVariant. Changing the value of a dynamic property causes a QDynamicPropertyChangeEvent to be sent to the object.

Note: Dynamic properties starting with "_q_" are reserved for internal purposes.

See also property(), metaObject(), dynamicPropertyNames(), and QMetaProperty::write().

pub unsafe fn signals_blocked(&self) -> bool

Returns true if signals are blocked; otherwise returns false.

Calls C++ function: bool QObject::signalsBlocked() const.

C++ documentation:

Returns true if signals are blocked; otherwise returns false.

Signals are not blocked by default.

See also blockSignals() and QSignalBlocker.

pub unsafe fn start_timer_2a(&self, interval: i32, timer_type: TimerType) -> i32

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

Calls C++ function: int QObject::startTimer(int interval, Qt::TimerType timerType = …).

C++ documentation:

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.

The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.

If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.

Example:

class MyObject : public QObject
{
      Q_OBJECT
public:
      MyObject(QObject *parent = 0);
protected:
      void timerEvent(QTimerEvent *event);
};
MyObject::MyObject(QObject *parent)
      : QObject(parent)
{
      startTimer(50);     // 50-millisecond timer
      startTimer(1000);   // 1-second timer
      startTimer(60000);  // 1-minute timer
      using namespace std::chrono;
      startTimer(milliseconds(50));
      startTimer(seconds(1));
      startTimer(minutes(1));
      // since C++14 we can use std::chrono::duration literals, e.g.:
      startTimer(100ms);
      startTimer(5s);
      startTimer(2min);
      startTimer(1h);
}
void MyObject::timerEvent(QTimerEvent *event)
{
      qDebug() << “Timer ID:” << event->timerId();
}

Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.

The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.

See also timerEvent(), killTimer(), and QTimer::singleShot().

pub unsafe fn start_timer_1a(&self, interval: i32) -> i32

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

Calls C++ function: int QObject::startTimer(int interval).

C++ documentation:

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.

The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.

If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.

Example:

class MyObject : public QObject
{
      Q_OBJECT
public:
      MyObject(QObject *parent = 0);
protected:
      void timerEvent(QTimerEvent *event);
};
MyObject::MyObject(QObject *parent)
      : QObject(parent)
{
      startTimer(50);     // 50-millisecond timer
      startTimer(1000);   // 1-second timer
      startTimer(60000);  // 1-minute timer
      using namespace std::chrono;
      startTimer(milliseconds(50));
      startTimer(seconds(1));
      startTimer(minutes(1));
      // since C++14 we can use std::chrono::duration literals, e.g.:
      startTimer(100ms);
      startTimer(5s);
      startTimer(2min);
      startTimer(1h);
}
void MyObject::timerEvent(QTimerEvent *event)
{
      qDebug() << “Timer ID:” << event->timerId();
}

Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.

The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.

See also timerEvent(), killTimer(), and QTimer::singleShot().

pub unsafe fn thread(&self) -> QPtr<QThread>

Returns the thread in which the object lives.

Calls C++ function: QThread* QObject::thread() const.

C++ documentation:

Returns the thread in which the object lives.

See also moveToThread().

Trait Implementations

impl CppDeletable for QAttribute

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void Qt3DRender::QAttribute::~QAttribute().

impl Deref for QAttribute

fn deref(&self) -> &QNode

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DRender::QAttribute* ptr).

type Target = QNode

The resulting type after dereferencing.

impl DynamicCast<QAttribute> for QNode

unsafe fn dynamic_cast(ptr: Ptr<QNode>) -> Ptr<QAttribute>

Calls C++ function: Qt3DRender::QAttribute* dynamic_cast<Qt3DRender::QAttribute*>(Qt3DCore::QNode* ptr).

impl DynamicCast<QAttribute> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QAttribute>

Calls C++ function: Qt3DRender::QAttribute* dynamic_cast<Qt3DRender::QAttribute*>(QObject* ptr).

impl StaticDowncast<QAttribute> for QNode

unsafe fn static_downcast(ptr: Ptr<QNode>) -> Ptr<QAttribute>

Calls C++ function: Qt3DRender::QAttribute* static_cast<Qt3DRender::QAttribute*>(Qt3DCore::QNode* ptr).

impl StaticDowncast<QAttribute> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QAttribute>

Calls C++ function: Qt3DRender::QAttribute* static_cast<Qt3DRender::QAttribute*>(QObject* ptr).

impl StaticUpcast<QNode> for QAttribute

unsafe fn static_upcast(ptr: Ptr<QAttribute>) -> Ptr<QNode>

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DRender::QAttribute* ptr).

impl StaticUpcast<QObject> for QAttribute

unsafe fn static_upcast(ptr: Ptr<QAttribute>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(Qt3DRender::QAttribute* ptr).