Struct qt_gui::QOpenGLDebugLogger
source · #[repr(C)]pub struct QOpenGLDebugLogger { /* private fields */ }
Expand description
The QOpenGLDebugLogger enables logging of OpenGL debugging messages.
C++ class: QOpenGLDebugLogger
.
The QOpenGLDebugLogger enables logging of OpenGL debugging messages.
Implementations§
source§impl QOpenGLDebugLogger
impl QOpenGLDebugLogger
sourcepub fn slot_log_message(&self) -> Receiver<(*const QOpenGLDebugMessage,)>
pub fn slot_log_message(&self) -> Receiver<(*const QOpenGLDebugMessage,)>
Inserts the message debugMessage into the OpenGL debug log. This provides a way for applications or libraries to insert custom messages that can ease the debugging of OpenGL applications.
Returns a built-in Qt slot QOpenGLDebugLogger::logMessage
that can be passed to qt_core::Signal::connect
.
Inserts the message debugMessage into the OpenGL debug log. This provides a way for applications or libraries to insert custom messages that can ease the debugging of OpenGL applications.
Note: debugMessage must have QOpenGLDebugMessage::ApplicationSource or QOpenGLDebugMessage::ThirdPartySource as its source, and a valid type and severity, otherwise it will not be inserted into the log.
Note: The object must be initialized before logging can happen.
See also initialize().
sourcepub fn slot_start_logging(&self) -> Receiver<(LoggingMode,)>
pub fn slot_start_logging(&self) -> Receiver<(LoggingMode,)>
Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.
Returns a built-in Qt slot QOpenGLDebugLogger::startLogging
that can be passed to qt_core::Signal::connect
.
Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.
loggingMode specifies whether the logging must be asynchronous (the default) or synchronous.
QOpenGLDebugLogger will record the values of GL_DEBUG_OUTPUT
and GL_DEBUG_OUTPUT_SYNCHRONOUS
when logging is started, and set them back when logging is stopped. Moreover, any user-defined OpenGL debug callback installed when this function is invoked will be restored when logging is stopped; QOpenGLDebugLogger will ensure that the pre-existing callback will still be invoked when logging.
Note: It's not possible to change the logging mode without stopping and starting logging again. This might change in a future version of Qt.
Note: The object must be initialized before logging can happen.
See also stopLogging() and initialize().
sourcepub fn slot_stop_logging(&self) -> Receiver<()>
pub fn slot_stop_logging(&self) -> Receiver<()>
Stops logging messages from the OpenGL server.
Returns a built-in Qt slot QOpenGLDebugLogger::stopLogging
that can be passed to qt_core::Signal::connect
.
Stops logging messages from the OpenGL server.
See also startLogging().
sourcepub fn message_logged(&self) -> Signal<(*const QOpenGLDebugMessage,)>
pub fn message_logged(&self) -> Signal<(*const QOpenGLDebugMessage,)>
This signal is emitted when a debug message (wrapped by the debugMessage argument) is logged from the OpenGL server.
Returns a built-in Qt signal QOpenGLDebugLogger::messageLogged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when a debug message (wrapped by the debugMessage argument) is logged from the OpenGL server.
Depending on the OpenGL implementation, this signal can be emitted from other threads than the one(s) the receiver(s) lives in, and even different from the thread the QOpenGLContext in which this object has been initialized lives in. Moreover, the signal could be emitted from multiple threads at the same time. This is normally not a problem, as Qt will utilize a queued connection for cross-thread signal emissions, but if you force the connection type to Direct then you must be aware of the potential races in the slots connected to this signal.
If logging have been started in SynchronousLogging mode, OpenGL guarantees that this signal will be emitted from the same thread the QOpenGLContext has been bound to, and no concurrent invocations will ever happen.
Note: Logging must have been started, or this signal will not be emitted.
See also startLogging().
sourcepub unsafe fn disable_messages_q_flags_source_q_flags_type_q_flags_severity(
&self,
sources: QFlags<Source>,
types: QFlags<Type>,
severities: QFlags<Severity>
)
pub unsafe fn disable_messages_q_flags_source_q_flags_type_q_flags_severity( &self, sources: QFlags<Source>, types: QFlags<Type>, severities: QFlags<Severity> )
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::disableMessages(QFlags<QOpenGLDebugMessage::Source> sources = …, QFlags<QOpenGLDebugMessage::Type> types = …, QFlags<QOpenGLDebugMessage::Severity> severities = …)
.
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn disable_messages_q_vector_of_u32_q_flags_source_q_flags_type(
&self,
ids: impl CastInto<Ref<QVectorOfU32>>,
sources: QFlags<Source>,
types: QFlags<Type>
)
pub unsafe fn disable_messages_q_vector_of_u32_q_flags_source_q_flags_type( &self, ids: impl CastInto<Ref<QVectorOfU32>>, sources: QFlags<Source>, types: QFlags<Type> )
Disables the logging of messages with the given ids, from the given sources and of the given types and any severity.
Calls C++ function: void QOpenGLDebugLogger::disableMessages(const QVector<GLuint>& ids, QFlags<QOpenGLDebugMessage::Source> sources = …, QFlags<QOpenGLDebugMessage::Type> types = …)
.
Disables the logging of messages with the given ids, from the given sources and of the given types and any severity.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn disable_messages_q_flags_source_q_flags_type(
&self,
sources: QFlags<Source>,
types: QFlags<Type>
)
pub unsafe fn disable_messages_q_flags_source_q_flags_type( &self, sources: QFlags<Source>, types: QFlags<Type> )
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::disableMessages(QFlags<QOpenGLDebugMessage::Source> sources = …, QFlags<QOpenGLDebugMessage::Type> types = …)
.
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn disable_messages_q_flags_source(&self, sources: QFlags<Source>)
pub unsafe fn disable_messages_q_flags_source(&self, sources: QFlags<Source>)
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::disableMessages(QFlags<QOpenGLDebugMessage::Source> sources = …)
.
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn disable_messages(&self)
pub unsafe fn disable_messages(&self)
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::disableMessages()
.
Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn disable_messages_q_vector_of_u32_q_flags_source(
&self,
ids: impl CastInto<Ref<QVectorOfU32>>,
sources: QFlags<Source>
)
pub unsafe fn disable_messages_q_vector_of_u32_q_flags_source( &self, ids: impl CastInto<Ref<QVectorOfU32>>, sources: QFlags<Source> )
Disables the logging of messages with the given ids, from the given sources and of the given types and any severity.
Calls C++ function: void QOpenGLDebugLogger::disableMessages(const QVector<GLuint>& ids, QFlags<QOpenGLDebugMessage::Source> sources = …)
.
Disables the logging of messages with the given ids, from the given sources and of the given types and any severity.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn disable_messages_q_vector_of_u32(
&self,
ids: impl CastInto<Ref<QVectorOfU32>>
)
pub unsafe fn disable_messages_q_vector_of_u32( &self, ids: impl CastInto<Ref<QVectorOfU32>> )
Disables the logging of messages with the given ids, from the given sources and of the given types and any severity.
Calls C++ function: void QOpenGLDebugLogger::disableMessages(const QVector<GLuint>& ids)
.
Disables the logging of messages with the given ids, from the given sources and of the given types and any severity.
The logging will be disabled in the current control group.
See also enableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages_q_flags_source_q_flags_type_q_flags_severity(
&self,
sources: QFlags<Source>,
types: QFlags<Type>,
severities: QFlags<Severity>
)
pub unsafe fn enable_messages_q_flags_source_q_flags_type_q_flags_severity( &self, sources: QFlags<Source>, types: QFlags<Type>, severities: QFlags<Severity> )
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::enableMessages(QFlags<QOpenGLDebugMessage::Source> sources = …, QFlags<QOpenGLDebugMessage::Type> types = …, QFlags<QOpenGLDebugMessage::Severity> severities = …)
.
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages_q_vector_of_u32_q_flags_source_q_flags_type(
&self,
ids: impl CastInto<Ref<QVectorOfU32>>,
sources: QFlags<Source>,
types: QFlags<Type>
)
pub unsafe fn enable_messages_q_vector_of_u32_q_flags_source_q_flags_type( &self, ids: impl CastInto<Ref<QVectorOfU32>>, sources: QFlags<Source>, types: QFlags<Type> )
Enables the logging of messages with the given ids, from the given sources and of the given types and any severity.
Calls C++ function: void QOpenGLDebugLogger::enableMessages(const QVector<GLuint>& ids, QFlags<QOpenGLDebugMessage::Source> sources = …, QFlags<QOpenGLDebugMessage::Type> types = …)
.
Enables the logging of messages with the given ids, from the given sources and of the given types and any severity.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages_q_flags_source_q_flags_type(
&self,
sources: QFlags<Source>,
types: QFlags<Type>
)
pub unsafe fn enable_messages_q_flags_source_q_flags_type( &self, sources: QFlags<Source>, types: QFlags<Type> )
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::enableMessages(QFlags<QOpenGLDebugMessage::Source> sources = …, QFlags<QOpenGLDebugMessage::Type> types = …)
.
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages_q_flags_source(&self, sources: QFlags<Source>)
pub unsafe fn enable_messages_q_flags_source(&self, sources: QFlags<Source>)
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::enableMessages(QFlags<QOpenGLDebugMessage::Source> sources = …)
.
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages(&self)
pub unsafe fn enable_messages(&self)
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
Calls C++ function: void QOpenGLDebugLogger::enableMessages()
.
Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages_q_vector_of_u32_q_flags_source(
&self,
ids: impl CastInto<Ref<QVectorOfU32>>,
sources: QFlags<Source>
)
pub unsafe fn enable_messages_q_vector_of_u32_q_flags_source( &self, ids: impl CastInto<Ref<QVectorOfU32>>, sources: QFlags<Source> )
Enables the logging of messages with the given ids, from the given sources and of the given types and any severity.
Calls C++ function: void QOpenGLDebugLogger::enableMessages(const QVector<GLuint>& ids, QFlags<QOpenGLDebugMessage::Source> sources = …)
.
Enables the logging of messages with the given ids, from the given sources and of the given types and any severity.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn enable_messages_q_vector_of_u32(
&self,
ids: impl CastInto<Ref<QVectorOfU32>>
)
pub unsafe fn enable_messages_q_vector_of_u32( &self, ids: impl CastInto<Ref<QVectorOfU32>> )
Enables the logging of messages with the given ids, from the given sources and of the given types and any severity.
Calls C++ function: void QOpenGLDebugLogger::enableMessages(const QVector<GLuint>& ids)
.
Enables the logging of messages with the given ids, from the given sources and of the given types and any severity.
The logging will be enabled in the current control group.
See also disableMessages(), pushGroup(), and popGroup().
sourcepub unsafe fn initialize(&self) -> bool
pub unsafe fn initialize(&self) -> bool
Initializes the object in the current OpenGL context. The context must support the GL_KHR_debug
extension for the initialization to succeed. The object must be initialized before any logging can happen.
Calls C++ function: bool QOpenGLDebugLogger::initialize()
.
Initializes the object in the current OpenGL context. The context must support the GL_KHR_debug
extension for the initialization to succeed. The object must be initialized before any logging can happen.
It is safe to call this function multiple times from the same context.
This function can also be used to change the context of a previously initialized object; note that in this case the object must not be logging when you call this function.
Returns true
if the logger is successfully initialized; false otherwise.
See also QOpenGLContext.
sourcepub unsafe fn is_logging(&self) -> bool
pub unsafe fn is_logging(&self) -> bool
Returns true
if this object is currently logging, false otherwise.
Calls C++ function: bool QOpenGLDebugLogger::isLogging() const
.
Returns true
if this object is currently logging, false otherwise.
See also startLogging().
sourcepub unsafe fn log_message(
&self,
debug_message: impl CastInto<Ref<QOpenGLDebugMessage>>
)
pub unsafe fn log_message( &self, debug_message: impl CastInto<Ref<QOpenGLDebugMessage>> )
Inserts the message debugMessage into the OpenGL debug log. This provides a way for applications or libraries to insert custom messages that can ease the debugging of OpenGL applications.
Calls C++ function: [slot] void QOpenGLDebugLogger::logMessage(const QOpenGLDebugMessage& debugMessage)
.
Inserts the message debugMessage into the OpenGL debug log. This provides a way for applications or libraries to insert custom messages that can ease the debugging of OpenGL applications.
Note: debugMessage must have QOpenGLDebugMessage::ApplicationSource or QOpenGLDebugMessage::ThirdPartySource as its source, and a valid type and severity, otherwise it will not be inserted into the log.
Note: The object must be initialized before logging can happen.
See also initialize().
sourcepub unsafe fn logged_messages(&self) -> CppBox<QListOfQOpenglDebugMessage>
pub unsafe fn logged_messages(&self) -> CppBox<QListOfQOpenglDebugMessage>
Reads all the available messages in the OpenGL internal debug log and returns them. Moreover, this function will clear the internal debug log, so that subsequent invocations will not return messages that were already returned.
Calls C++ function: QList<QOpenGLDebugMessage> QOpenGLDebugLogger::loggedMessages() const
.
Reads all the available messages in the OpenGL internal debug log and returns them. Moreover, this function will clear the internal debug log, so that subsequent invocations will not return messages that were already returned.
See also startLogging().
sourcepub unsafe fn logging_mode(&self) -> LoggingMode
pub unsafe fn logging_mode(&self) -> LoggingMode
This property holds the logging mode passed to startLogging().
Calls C++ function: QOpenGLDebugLogger::LoggingMode QOpenGLDebugLogger::loggingMode() const
.
This property holds the logging mode passed to startLogging().
Note that logging must have been started or the value of this property will be meaningless.
Access functions:
LoggingMode | loggingMode() const |
See also startLogging() and isLogging().
sourcepub unsafe fn maximum_message_length(&self) -> i64
pub unsafe fn maximum_message_length(&self) -> i64
Returns the maximum supported length, in bytes, for the text of the messages passed to logMessage(). This is also the maximum length of a debug group name, as pushing or popping groups will automatically log a message with the debug group name as the message text.
Calls C++ function: qint64 QOpenGLDebugLogger::maximumMessageLength() const
.
Returns the maximum supported length, in bytes, for the text of the messages passed to logMessage(). This is also the maximum length of a debug group name, as pushing or popping groups will automatically log a message with the debug group name as the message text.
If a message text is too long, it will be automatically truncated by QOpenGLDebugLogger.
Note: Message texts are encoded in UTF-8 when they get passed to OpenGL, so their size in bytes does not usually match the amount of UTF-16 code units, as returned f.i. by QString::length(). (It does if the message contains 7-bit ASCII only data, which is typical for debug messages.)
sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QOpenGLDebugLogger::metaObject() const
.
sourcepub unsafe fn new_1a(
parent: impl CastInto<Ptr<QObject>>
) -> QBox<QOpenGLDebugLogger>
pub unsafe fn new_1a( parent: impl CastInto<Ptr<QObject>> ) -> QBox<QOpenGLDebugLogger>
Constructs a new logger object with the given parent.
Calls C++ function: [constructor] void QOpenGLDebugLogger::QOpenGLDebugLogger(QObject* parent = …)
.
Constructs a new logger object with the given parent.
Note: The object must be initialized before logging can happen.
See also initialize().
sourcepub unsafe fn new_0a() -> QBox<QOpenGLDebugLogger>
pub unsafe fn new_0a() -> QBox<QOpenGLDebugLogger>
The QOpenGLDebugLogger enables logging of OpenGL debugging messages.
Calls C++ function: [constructor] void QOpenGLDebugLogger::QOpenGLDebugLogger()
.
The QOpenGLDebugLogger enables logging of OpenGL debugging messages.
sourcepub unsafe fn pop_group(&self)
pub unsafe fn pop_group(&self)
Pops the topmost debug group from the debug groups stack. If the group is successfully popped, OpenGL will automatically log a message with message, id and source matching those of the popped group, type QOpenGLDebugMessage::GroupPopType and severity QOpenGLDebugMessage::NotificationSeverity.
Calls C++ function: void QOpenGLDebugLogger::popGroup()
.
Pops the topmost debug group from the debug groups stack. If the group is successfully popped, OpenGL will automatically log a message with message, id and source matching those of the popped group, type QOpenGLDebugMessage::GroupPopType and severity QOpenGLDebugMessage::NotificationSeverity.
Popping a debug group will restore the message filtering settings of the group that becomes the top of the debug groups stack.
Note: The object must be initialized before managing debug groups.
See also pushGroup().
sourcepub unsafe fn push_group_3a(
&self,
name: impl CastInto<Ref<QString>>,
id: u32,
source: Source
)
pub unsafe fn push_group_3a( &self, name: impl CastInto<Ref<QString>>, id: u32, source: Source )
Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type QOpenGLDebugMessage::GroupPushType and severity QOpenGLDebugMessage::NotificationSeverity.
Calls C++ function: void QOpenGLDebugLogger::pushGroup(const QString& name, GLuint id = …, QOpenGLDebugMessage::Source source = …)
.
Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type QOpenGLDebugMessage::GroupPushType and severity QOpenGLDebugMessage::NotificationSeverity.
The newly pushed group will inherit the same filtering settings of the group that was on the top of the stack; that is, the filtering will not be changed by pushing a new group.
Note: The source must either be QOpenGLDebugMessage::ApplicationSource or QOpenGLDebugMessage::ThirdPartySource, otherwise the group will not be pushed.
Note: The object must be initialized before managing debug groups.
See also popGroup(), enableMessages(), and disableMessages().
sourcepub unsafe fn push_group_2a(&self, name: impl CastInto<Ref<QString>>, id: u32)
pub unsafe fn push_group_2a(&self, name: impl CastInto<Ref<QString>>, id: u32)
Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type QOpenGLDebugMessage::GroupPushType and severity QOpenGLDebugMessage::NotificationSeverity.
Calls C++ function: void QOpenGLDebugLogger::pushGroup(const QString& name, GLuint id = …)
.
Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type QOpenGLDebugMessage::GroupPushType and severity QOpenGLDebugMessage::NotificationSeverity.
The newly pushed group will inherit the same filtering settings of the group that was on the top of the stack; that is, the filtering will not be changed by pushing a new group.
Note: The source must either be QOpenGLDebugMessage::ApplicationSource or QOpenGLDebugMessage::ThirdPartySource, otherwise the group will not be pushed.
Note: The object must be initialized before managing debug groups.
See also popGroup(), enableMessages(), and disableMessages().
sourcepub unsafe fn push_group_1a(&self, name: impl CastInto<Ref<QString>>)
pub unsafe fn push_group_1a(&self, name: impl CastInto<Ref<QString>>)
Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type QOpenGLDebugMessage::GroupPushType and severity QOpenGLDebugMessage::NotificationSeverity.
Calls C++ function: void QOpenGLDebugLogger::pushGroup(const QString& name)
.
Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type QOpenGLDebugMessage::GroupPushType and severity QOpenGLDebugMessage::NotificationSeverity.
The newly pushed group will inherit the same filtering settings of the group that was on the top of the stack; that is, the filtering will not be changed by pushing a new group.
Note: The source must either be QOpenGLDebugMessage::ApplicationSource or QOpenGLDebugMessage::ThirdPartySource, otherwise the group will not be pushed.
Note: The object must be initialized before managing debug groups.
See also popGroup(), enableMessages(), and disableMessages().
sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void ) -> c_int
Calls C++ function: virtual int QOpenGLDebugLogger::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QOpenGLDebugLogger::qt_metacast(const char* arg1)
.
sourcepub unsafe fn start_logging_1a(&self, logging_mode: LoggingMode)
pub unsafe fn start_logging_1a(&self, logging_mode: LoggingMode)
Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.
Calls C++ function: [slot] void QOpenGLDebugLogger::startLogging(QOpenGLDebugLogger::LoggingMode loggingMode = …)
.
Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.
loggingMode specifies whether the logging must be asynchronous (the default) or synchronous.
QOpenGLDebugLogger will record the values of GL_DEBUG_OUTPUT
and GL_DEBUG_OUTPUT_SYNCHRONOUS
when logging is started, and set them back when logging is stopped. Moreover, any user-defined OpenGL debug callback installed when this function is invoked will be restored when logging is stopped; QOpenGLDebugLogger will ensure that the pre-existing callback will still be invoked when logging.
Note: It's not possible to change the logging mode without stopping and starting logging again. This might change in a future version of Qt.
Note: The object must be initialized before logging can happen.
See also stopLogging() and initialize().
sourcepub unsafe fn start_logging_0a(&self)
pub unsafe fn start_logging_0a(&self)
Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.
Calls C++ function: [slot] void QOpenGLDebugLogger::startLogging()
.
Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.
loggingMode specifies whether the logging must be asynchronous (the default) or synchronous.
QOpenGLDebugLogger will record the values of GL_DEBUG_OUTPUT
and GL_DEBUG_OUTPUT_SYNCHRONOUS
when logging is started, and set them back when logging is stopped. Moreover, any user-defined OpenGL debug callback installed when this function is invoked will be restored when logging is stopped; QOpenGLDebugLogger will ensure that the pre-existing callback will still be invoked when logging.
Note: It's not possible to change the logging mode without stopping and starting logging again. This might change in a future version of Qt.
Note: The object must be initialized before logging can happen.
See also stopLogging() and initialize().
sourcepub unsafe fn static_meta_object() -> Ref<QMetaObject>
pub unsafe fn static_meta_object() -> Ref<QMetaObject>
Returns a reference to the staticMetaObject
field.
sourcepub unsafe fn stop_logging(&self)
pub unsafe fn stop_logging(&self)
Stops logging messages from the OpenGL server.
Calls C++ function: [slot] void QOpenGLDebugLogger::stopLogging()
.
Stops logging messages from the OpenGL server.
See also startLogging().
Methods from Deref<Target = QObject>§
sourcepub unsafe fn find_child<T>(
&self,
name: &str
) -> Result<QPtr<T>, FindChildError>
pub unsafe fn find_child<T>( &self, name: &str ) -> Result<QPtr<T>, FindChildError>
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
.
sourcepub fn destroyed(&self) -> Signal<(*mut QObject,)>
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
.
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.
sourcepub fn object_name_changed(&self) -> Signal<(*const QString,)>
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
.
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.
sourcepub fn slot_delete_later(&self) -> Receiver<()>
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
.
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.
sourcepub unsafe fn block_signals(&self, b: bool) -> bool
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)
.
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.
sourcepub unsafe fn children(&self) -> Ref<QListOfQObject>
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
.
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().
sourcepub unsafe fn delete_later(&self)
pub unsafe fn delete_later(&self)
Schedules this object for deletion.
Calls C++ function: [slot] void QObject::deleteLater()
.
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.
sourcepub unsafe fn disconnect_char_q_object_char(
&self,
signal: *const i8,
receiver: impl CastInto<Ptr<QObject>>,
member: *const i8
) -> bool
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
.
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.
sourcepub unsafe fn disconnect_q_object_char(
&self,
receiver: impl CastInto<Ptr<QObject>>,
member: *const i8
) -> bool
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
.
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.
sourcepub unsafe fn disconnect_char_q_object(
&self,
signal: *const i8,
receiver: impl CastInto<Ptr<QObject>>
) -> bool
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
.
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.
sourcepub unsafe fn disconnect_char(&self, signal: *const i8) -> bool
pub unsafe fn disconnect_char(&self, signal: *const i8) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …) const
.
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.
sourcepub unsafe fn disconnect(&self) -> bool
pub unsafe fn disconnect(&self) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect() const
.
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.
sourcepub unsafe fn disconnect_q_object(
&self,
receiver: impl CastInto<Ptr<QObject>>
) -> bool
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
.
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.
sourcepub unsafe fn dump_object_info_mut(&self)
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()
.
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().
sourcepub unsafe fn dump_object_info(&self)
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
.
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().
sourcepub unsafe fn dump_object_tree_mut(&self)
pub unsafe fn dump_object_tree_mut(&self)
Dumps a tree of children to the debug output.
Calls C++ function: void QObject::dumpObjectTree()
.
Dumps a tree of children to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectInfo().
sourcepub unsafe fn dump_object_tree(&self)
pub unsafe fn dump_object_tree(&self)
Dumps a tree of children to the debug output.
Calls C++ function: void QObject::dumpObjectTree() const
.
Dumps a tree of children to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectInfo().
sourcepub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>
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
.
Returns the names of all properties that were dynamically added to the object using setProperty().
This function was introduced in Qt 4.2.
sourcepub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool
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
.
sourcepub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool
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)
.
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().
sourcepub unsafe fn event_filter(
&self,
watched: impl CastInto<Ptr<QObject>>,
event: impl CastInto<Ptr<QEvent>>
) -> bool
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)
.
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().
sourcepub unsafe fn find_child_q_object_2a(
&self,
a_name: impl CastInto<Ref<QString>>,
options: QFlags<FindChildOption>
) -> QPtr<QObject>
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
.
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().
sourcepub unsafe fn find_child_q_object_1a(
&self,
a_name: impl CastInto<Ref<QString>>
) -> QPtr<QObject>
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
.
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().
sourcepub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>
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
.
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().
sourcepub 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>
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
.
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 QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
sourcepub 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>
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
.
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.
sourcepub 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>
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
.
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.
sourcepub unsafe fn find_children_q_object_q_string(
&self,
a_name: impl CastInto<Ref<QString>>
) -> CppBox<QListOfQObject>
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
.
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 QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
sourcepub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>
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
.
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 QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
sourcepub unsafe fn find_children_q_object_q_reg_exp(
&self,
re: impl CastInto<Ref<QRegExp>>
) -> CppBox<QListOfQObject>
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
.
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.
sourcepub unsafe fn find_children_q_object_q_regular_expression(
&self,
re: impl CastInto<Ref<QRegularExpression>>
) -> CppBox<QListOfQObject>
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
.
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.
sourcepub unsafe fn inherits(&self, classname: *const i8) -> bool
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
.
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().
sourcepub unsafe fn install_event_filter(
&self,
filter_obj: impl CastInto<Ptr<QObject>>
)
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)
.
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().
sourcepub unsafe fn is_widget_type(&self) -> bool
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
.
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.
sourcepub unsafe fn is_window_type(&self) -> bool
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
.
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.
sourcepub unsafe fn kill_timer(&self, id: i32)
pub unsafe fn kill_timer(&self, id: i32)
Kills the timer with timer identifier, id.
Calls C++ function: void QObject::killTimer(int id)
.
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().
sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
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
.
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.
sourcepub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)
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)
.
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().
sourcepub unsafe fn object_name(&self) -> CppBox<QString>
pub unsafe fn object_name(&self) -> CppBox<QString>
This property holds the name of this object
Calls C++ function: QString QObject::objectName() const
.
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().
sourcepub unsafe fn parent(&self) -> QPtr<QObject>
pub unsafe fn parent(&self) -> QPtr<QObject>
Returns a pointer to the parent object.
Calls C++ function: QObject* QObject::parent() const
.
sourcepub unsafe fn property(&self, name: *const i8) -> CppBox<QVariant>
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
.
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().
sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: i32,
arg3: *mut *mut c_void
) -> i32
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)
.
sourcepub unsafe fn qt_metacast(&self, arg1: *const i8) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const i8) -> *mut c_void
Calls C++ function: virtual void* QObject::qt_metacast(const char* arg1)
.
sourcepub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)
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)
.
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().
sourcepub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)
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)
.
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().
sourcepub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)
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)
.
sourcepub unsafe fn set_property(
&self,
name: *const i8,
value: impl CastInto<Ref<QVariant>>
) -> bool
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)
.
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().
sourcepub unsafe fn signals_blocked(&self) -> bool
pub unsafe fn signals_blocked(&self) -> bool
Returns true
if signals are blocked; otherwise returns false
.
Calls C++ function: bool QObject::signalsBlocked() const
.
Returns true
if signals are blocked; otherwise returns false
.
Signals are not blocked by default.
See also blockSignals() and QSignalBlocker.
sourcepub unsafe fn start_timer_2a(&self, interval: i32, timer_type: TimerType) -> i32
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 = …)
.
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().
sourcepub unsafe fn start_timer_1a(&self, interval: i32) -> i32
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)
.
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().
sourcepub unsafe fn thread(&self) -> QPtr<QThread>
pub unsafe fn thread(&self) -> QPtr<QThread>
Returns the thread in which the object lives.
Calls C++ function: QThread* QObject::thread() const
.
Returns the thread in which the object lives.
See also moveToThread().
Trait Implementations§
source§impl CppDeletable for QOpenGLDebugLogger
impl CppDeletable for QOpenGLDebugLogger
source§impl Deref for QOpenGLDebugLogger
impl Deref for QOpenGLDebugLogger
source§impl DynamicCast<QOpenGLDebugLogger> for QObject
impl DynamicCast<QOpenGLDebugLogger> for QObject
source§unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QOpenGLDebugLogger>
unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QOpenGLDebugLogger>
Calls C++ function: QOpenGLDebugLogger* dynamic_cast<QOpenGLDebugLogger*>(QObject* ptr)
.
source§impl StaticDowncast<QOpenGLDebugLogger> for QObject
impl StaticDowncast<QOpenGLDebugLogger> for QObject
source§unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QOpenGLDebugLogger>
unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QOpenGLDebugLogger>
Calls C++ function: QOpenGLDebugLogger* static_cast<QOpenGLDebugLogger*>(QObject* ptr)
.
source§impl StaticUpcast<QObject> for QOpenGLDebugLogger
impl StaticUpcast<QObject> for QOpenGLDebugLogger
source§unsafe fn static_upcast(ptr: Ptr<QOpenGLDebugLogger>) -> Ptr<QObject>
unsafe fn static_upcast(ptr: Ptr<QOpenGLDebugLogger>) -> Ptr<QObject>
Calls C++ function: QObject* static_cast<QObject*>(QOpenGLDebugLogger* ptr)
.