Struct qt_gui::QStyleHints

source ·
#[repr(C)]
pub struct QStyleHints { /* private fields */ }
Expand description

The QStyleHints class contains platform specific hints and settings.

C++ class: QStyleHints.

C++ documentation:

The QStyleHints class contains platform specific hints and settings.

An object of this class, obtained from QGuiApplication, provides access to certain global user interface parameters of the current platform.

Access is read only; typically the platform itself provides the user a way to tune these parameters.

Access to these parameters are useful when implementing custom user interface components, in that they allow the components to exhibit the same behaviour and feel as other components.

Implementations§

source§

impl QStyleHints

source

pub fn cursor_flash_time_changed(&self) -> Signal<(c_int,)>

This property holds the text cursor's flash (blink) time in milliseconds.

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

C++ documentation:

This property holds the text cursor’s flash (blink) time in milliseconds.

The flash time is the time used to display, invert and restore the caret display. Usually the text cursor is displayed for half the cursor flash time, then hidden for the same amount of time.

Access functions:

int cursorFlashTime() const

Notifier signal:

void cursorFlashTimeChanged(int cursorFlashTime)
source

pub fn keyboard_input_interval_changed(&self) -> Signal<(c_int,)>

This property holds the time limit, in milliseconds, that distinguishes a key press from two consecutive key presses.

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

C++ documentation:

This property holds the time limit, in milliseconds, that distinguishes a key press from two consecutive key presses.

Access functions:

int keyboardInputInterval() const

Notifier signal:

void keyboardInputIntervalChanged(int keyboardInputInterval)
source

pub fn mouse_double_click_interval_changed(&self) -> Signal<(c_int,)>

This property holds the time limit in milliseconds that distinguishes a double click from two consecutive mouse clicks.

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

C++ documentation:

This property holds the time limit in milliseconds that distinguishes a double click from two consecutive mouse clicks.

Access functions:

int mouseDoubleClickInterval() const

Notifier signal:

void mouseDoubleClickIntervalChanged(int mouseDoubleClickInterval)
source

pub fn mouse_press_and_hold_interval_changed(&self) -> Signal<(c_int,)>

This property holds the time limit in milliseconds that activates a press and hold.

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

C++ documentation:

This property holds the time limit in milliseconds that activates a press and hold.

This property was introduced in Qt 5.3.

Access functions:

int mousePressAndHoldInterval() const

Notifier signal:

void mousePressAndHoldIntervalChanged(int mousePressAndHoldInterval)
source

pub fn start_drag_distance_changed(&self) -> Signal<(c_int,)>

This property holds the distance, in pixels, that the mouse must be moved with a button held down before a drag and drop operation will begin.

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

C++ documentation:

This property holds the distance, in pixels, that the mouse must be moved with a button held down before a drag and drop operation will begin.

If you support drag and drop in your application, and want to start a drag and drop operation after the user has moved the cursor a certain distance with a button held down, you should use this property's value as the minimum distance required.

For example, if the mouse position of the click is stored in startPos and the current position (e.g. in the mouse move event) is currentPos, you can find out if a drag should be started with code like this:

if ((startPos - currentPos).manhattanLength() >= QApplication::startDragDistance()) startTheDrag();

Access functions:

int startDragDistance() const

Notifier signal:

void startDragDistanceChanged(int startDragDistance)

See also startDragTime, QPoint::manhattanLength(), and Drag and Drop.

source

pub fn start_drag_time_changed(&self) -> Signal<(c_int,)>

This property holds the time, in milliseconds, that a mouse button must be held down before a drag and drop operation will begin.

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

C++ documentation:

This property holds the time, in milliseconds, that a mouse button must be held down before a drag and drop operation will begin.

If you support drag and drop in your application, and want to start a drag and drop operation after the user has held down a mouse button for a certain amount of time, you should use this property's value as the delay.

Access functions:

int startDragTime() const

Notifier signal:

void startDragTimeChanged(int startDragTime)

See also startDragDistance and Drag and Drop.

source

pub fn tab_focus_behavior_changed(&self) -> Signal<(TabFocusBehavior,)>

This property holds the focus behavior on press of the tab key.

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

C++ documentation:

This property holds the focus behavior on press of the tab key.

Note: Do not bind this value in QML because the change notifier signal is not implemented yet.

This property was introduced in Qt 5.5.

Access functions:

Qt::TabFocusBehavior tabFocusBehavior() const

Notifier signal:

void tabFocusBehaviorChanged(Qt::TabFocusBehavior tabFocusBehavior)
source

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

This property holds whether UI elements use hover effects.

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

C++ documentation:

This property holds whether UI elements use hover effects.

This property is true if UI elements should use hover effects. This is the standard behavior on desktop platforms with a mouse pointer, whereas on touch platforms the overhead of hover event delivery can be avoided.

This property was introduced in Qt 5.8.

Access functions:

bool useHoverEffects() const
void setUseHoverEffects(bool useHoverEffects)

Notifier signal:

void useHoverEffectsChanged(bool useHoverEffects)
source

pub fn wheel_scroll_lines_changed(&self) -> Signal<(c_int,)>

Number of lines to scroll by default for each wheel click.

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

C++ documentation:

Number of lines to scroll by default for each wheel click.

This property was introduced in Qt 5.9.

Access functions:

int wheelScrollLines() const

Notifier signal:

void wheelScrollLinesChanged(int scrollLines)
source

pub unsafe fn cursor_flash_time(&self) -> c_int

This property holds the text cursor's flash (blink) time in milliseconds.

Calls C++ function: int QStyleHints::cursorFlashTime() const.

C++ documentation:

This property holds the text cursor’s flash (blink) time in milliseconds.

The flash time is the time used to display, invert and restore the caret display. Usually the text cursor is displayed for half the cursor flash time, then hidden for the same amount of time.

Access functions:

int cursorFlashTime() const

Notifier signal:

void cursorFlashTimeChanged(int cursorFlashTime)
source

pub unsafe fn font_smoothing_gamma(&self) -> c_double

This property holds the gamma value used in font smoothing.

Calls C++ function: double QStyleHints::fontSmoothingGamma() const.

C++ documentation:

This property holds the gamma value used in font smoothing.

Access functions:

qreal fontSmoothingGamma() const
source

pub unsafe fn keyboard_auto_repeat_rate(&self) -> c_int

This property holds the rate, in events per second, in which additional repeated key presses will automatically be generated if a key is being held down.

Calls C++ function: int QStyleHints::keyboardAutoRepeatRate() const.

C++ documentation:

This property holds the rate, in events per second, in which additional repeated key presses will automatically be generated if a key is being held down.

Access functions:

int keyboardAutoRepeatRate() const
source

pub unsafe fn keyboard_input_interval(&self) -> c_int

This property holds the time limit, in milliseconds, that distinguishes a key press from two consecutive key presses.

Calls C++ function: int QStyleHints::keyboardInputInterval() const.

C++ documentation:

This property holds the time limit, in milliseconds, that distinguishes a key press from two consecutive key presses.

Access functions:

int keyboardInputInterval() const

Notifier signal:

void keyboardInputIntervalChanged(int keyboardInputInterval)
source

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

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

source

pub unsafe fn mouse_double_click_distance(&self) -> c_int

Available on cpp_lib_version="5.14.0" only.

This property holds the maximum distance, in pixels, that the mouse can be moved between two consecutive mouse clicks and still have it detected as a double-click

Calls C++ function: int QStyleHints::mouseDoubleClickDistance() const.

C++ documentation:

This property holds the maximum distance, in pixels, that the mouse can be moved between two consecutive mouse clicks and still have it detected as a double-click

This property was introduced in Qt 5.14.

Access functions:

int mouseDoubleClickDistance() const
source

pub unsafe fn mouse_double_click_interval(&self) -> c_int

This property holds the time limit in milliseconds that distinguishes a double click from two consecutive mouse clicks.

Calls C++ function: int QStyleHints::mouseDoubleClickInterval() const.

C++ documentation:

This property holds the time limit in milliseconds that distinguishes a double click from two consecutive mouse clicks.

Access functions:

int mouseDoubleClickInterval() const

Notifier signal:

void mouseDoubleClickIntervalChanged(int mouseDoubleClickInterval)
source

pub unsafe fn mouse_press_and_hold_interval(&self) -> c_int

This property holds the time limit in milliseconds that activates a press and hold.

Calls C++ function: int QStyleHints::mousePressAndHoldInterval() const.

C++ documentation:

This property holds the time limit in milliseconds that activates a press and hold.

This property was introduced in Qt 5.3.

Access functions:

int mousePressAndHoldInterval() const

Notifier signal:

void mousePressAndHoldIntervalChanged(int mousePressAndHoldInterval)
source

pub unsafe fn mouse_quick_selection_threshold(&self) -> c_int

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.

Quick selection mouse threshold in QLineEdit.

Calls C++ function: int QStyleHints::mouseQuickSelectionThreshold() const.

C++ documentation:

Quick selection mouse threshold in QLineEdit.

This property defines how much the mouse cursor should be moved along the y axis to trigger a quick selection during a normal QLineEdit text selection.

If the property value is less than or equal to 0, the quick selection feature is disabled.

This property was introduced in Qt 5.11.

Access functions:

int mouseQuickSelectionThreshold() const

Notifier signal:

void mouseQuickSelectionThresholdChanged(int threshold)
source

pub unsafe fn mouse_quick_selection_threshold_changed(&self, threshold: c_int)

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.

Quick selection mouse threshold in QLineEdit.

Calls C++ function: void QStyleHints::mouseQuickSelectionThresholdChanged(int threshold).

C++ documentation:

Quick selection mouse threshold in QLineEdit.

This property defines how much the mouse cursor should be moved along the y axis to trigger a quick selection during a normal QLineEdit text selection.

If the property value is less than or equal to 0, the quick selection feature is disabled.

This property was introduced in Qt 5.11.

Access functions:

int mouseQuickSelectionThreshold() const

Notifier signal:

void mouseQuickSelectionThresholdChanged(int threshold)
source

pub unsafe fn password_mask_character(&self) -> CppBox<QChar>

This property holds the character used to mask the characters typed into text input fields in password mode.

Calls C++ function: QChar QStyleHints::passwordMaskCharacter() const.

C++ documentation:

This property holds the character used to mask the characters typed into text input fields in password mode.

Access functions:

QChar passwordMaskCharacter() const
source

pub unsafe fn password_mask_delay(&self) -> c_int

This property holds the time, in milliseconds, a typed letter is displayed unshrouded in a text input field in password mode.

Calls C++ function: int QStyleHints::passwordMaskDelay() const.

C++ documentation:

This property holds the time, in milliseconds, a typed letter is displayed unshrouded in a text input field in password mode.

Access functions:

int passwordMaskDelay() const
source

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

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

source

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

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

source

pub unsafe fn set_cursor_flash_time(&self, cursor_flash_time: c_int)

Calls C++ function: void QStyleHints::setCursorFlashTime(int cursorFlashTime).

source

pub unsafe fn set_focus_on_touch_release(&self) -> bool

This property holds the event that should set input focus on focus objects.

Calls C++ function: bool QStyleHints::setFocusOnTouchRelease() const.

C++ documentation:

This property holds the event that should set input focus on focus objects.

This property is true if focus objects (line edits etc) should receive input focus after a touch/mouse release. This is normal behavior on touch platforms. On desktop platforms, the standard is to set focus already on touch/mouse press.

Access functions:

bool setFocusOnTouchRelease() const
source

pub unsafe fn set_keyboard_input_interval(&self, keyboard_input_interval: c_int)

Calls C++ function: void QStyleHints::setKeyboardInputInterval(int keyboardInputInterval).

source

pub unsafe fn set_mouse_double_click_interval( &self, mouse_double_click_interval: c_int )

Calls C++ function: void QStyleHints::setMouseDoubleClickInterval(int mouseDoubleClickInterval).

source

pub unsafe fn set_mouse_press_and_hold_interval( &self, mouse_press_and_hold_interval: c_int )

Calls C++ function: void QStyleHints::setMousePressAndHoldInterval(int mousePressAndHoldInterval).

source

pub unsafe fn set_mouse_quick_selection_threshold(&self, threshold: c_int)

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.

Calls C++ function: void QStyleHints::setMouseQuickSelectionThreshold(int threshold).

source

pub unsafe fn set_show_shortcuts_in_context_menus( &self, show_shortcuts_in_context_menus: bool )

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

true if the platform normally shows shortcut key sequences in context menus, otherwise false.

Calls C++ function: void QStyleHints::setShowShortcutsInContextMenus(bool showShortcutsInContextMenus).

C++ documentation:

true if the platform normally shows shortcut key sequences in context menus, otherwise false.

Since Qt 5.13, the setShowShortcutsInContextMenus() function can be used to override the platform default.

This property was introduced in Qt 5.10.

Access functions:

bool showShortcutsInContextMenus() const
void setShowShortcutsInContextMenus(bool showShortcutsInContextMenus)

Notifier signal:

void showShortcutsInContextMenusChanged(bool)
source

pub unsafe fn set_start_drag_distance(&self, start_drag_distance: c_int)

Calls C++ function: void QStyleHints::setStartDragDistance(int startDragDistance).

source

pub unsafe fn set_start_drag_time(&self, start_drag_time: c_int)

Calls C++ function: void QStyleHints::setStartDragTime(int startDragTime).

source

pub unsafe fn set_tab_focus_behavior( &self, tab_focus_behavior: TabFocusBehavior )

Calls C++ function: void QStyleHints::setTabFocusBehavior(Qt::TabFocusBehavior tabFocusBehavior).

source

pub unsafe fn set_use_hover_effects(&self, use_hover_effects: bool)

This property holds whether UI elements use hover effects.

Calls C++ function: void QStyleHints::setUseHoverEffects(bool useHoverEffects).

C++ documentation:

This property holds whether UI elements use hover effects.

This property is true if UI elements should use hover effects. This is the standard behavior on desktop platforms with a mouse pointer, whereas on touch platforms the overhead of hover event delivery can be avoided.

This property was introduced in Qt 5.8.

Access functions:

bool useHoverEffects() const
void setUseHoverEffects(bool useHoverEffects)

Notifier signal:

void useHoverEffectsChanged(bool useHoverEffects)
source

pub unsafe fn set_wheel_scroll_lines(&self, scroll_lines: c_int)

Calls C++ function: void QStyleHints::setWheelScrollLines(int scrollLines).

source

pub unsafe fn show_is_full_screen(&self) -> bool

This property holds whether the platform defaults to fullscreen windows.

Calls C++ function: bool QStyleHints::showIsFullScreen() const.

C++ documentation:

This property holds whether the platform defaults to fullscreen windows.

This property is true if the platform defaults to windows being fullscreen, otherwise false.

Note: The platform may still choose to show certain windows non-fullscreen, such as popups or dialogs. This property only reports the default behavior.

Access functions:

bool showIsFullScreen() const

See also QWindow::show() and showIsMaximized().

source

pub unsafe fn show_is_maximized(&self) -> bool

This property holds whether the platform defaults to maximized windows.

Calls C++ function: bool QStyleHints::showIsMaximized() const.

C++ documentation:

This property holds whether the platform defaults to maximized windows.

This property is true if the platform defaults to windows being maximized, otherwise false.

Note: The platform may still choose to show certain windows non-maximized, such as popups or dialogs. This property only reports the default behavior.

This property was introduced in Qt 5.6.

Access functions:

bool showIsMaximized() const

See also QWindow::show() and showIsFullScreen().

source

pub unsafe fn show_shortcuts_in_context_menus(&self) -> bool

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.

true if the platform normally shows shortcut key sequences in context menus, otherwise false.

Calls C++ function: bool QStyleHints::showShortcutsInContextMenus() const.

C++ documentation:

true if the platform normally shows shortcut key sequences in context menus, otherwise false.

This property was introduced in Qt 5.10.

Access functions:

bool showShortcutsInContextMenus() const
source

pub unsafe fn show_shortcuts_in_context_menus_changed(&self, arg1: bool)

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

true if the platform normally shows shortcut key sequences in context menus, otherwise false.

Calls C++ function: void QStyleHints::showShortcutsInContextMenusChanged(bool arg1).

C++ documentation:

true if the platform normally shows shortcut key sequences in context menus, otherwise false.

Since Qt 5.13, the setShowShortcutsInContextMenus() function can be used to override the platform default.

This property was introduced in Qt 5.10.

Access functions:

bool showShortcutsInContextMenus() const
void setShowShortcutsInContextMenus(bool showShortcutsInContextMenus)

Notifier signal:

void showShortcutsInContextMenusChanged(bool)
source

pub unsafe fn single_click_activation(&self) -> bool

This property holds whether items are activated by single or double click.

Calls C++ function: bool QStyleHints::singleClickActivation() const.

C++ documentation:

This property holds whether items are activated by single or double click.

This property is true if items should be activated by single click, false if they should be activated by double click instead.

This property was introduced in Qt 5.5.

Access functions:

bool singleClickActivation() const
source

pub unsafe fn start_drag_distance(&self) -> c_int

This property holds the distance, in pixels, that the mouse must be moved with a button held down before a drag and drop operation will begin.

Calls C++ function: int QStyleHints::startDragDistance() const.

C++ documentation:

This property holds the distance, in pixels, that the mouse must be moved with a button held down before a drag and drop operation will begin.

If you support drag and drop in your application, and want to start a drag and drop operation after the user has moved the cursor a certain distance with a button held down, you should use this property's value as the minimum distance required.

For example, if the mouse position of the click is stored in startPos and the current position (e.g. in the mouse move event) is currentPos, you can find out if a drag should be started with code like this:

if ((startPos - currentPos).manhattanLength() >= QApplication::startDragDistance()) startTheDrag();

Access functions:

int startDragDistance() const

Notifier signal:

void startDragDistanceChanged(int startDragDistance)

See also startDragTime, QPoint::manhattanLength(), and Drag and Drop.

source

pub unsafe fn start_drag_time(&self) -> c_int

This property holds the time, in milliseconds, that a mouse button must be held down before a drag and drop operation will begin.

Calls C++ function: int QStyleHints::startDragTime() const.

C++ documentation:

This property holds the time, in milliseconds, that a mouse button must be held down before a drag and drop operation will begin.

If you support drag and drop in your application, and want to start a drag and drop operation after the user has held down a mouse button for a certain amount of time, you should use this property's value as the delay.

Access functions:

int startDragTime() const

Notifier signal:

void startDragTimeChanged(int startDragTime)

See also startDragDistance and Drag and Drop.

source

pub unsafe fn start_drag_velocity(&self) -> c_int

This property holds the limit for the velocity, in pixels per second, that the mouse may be moved, with a button held down, for a drag and drop operation to begin. A value of 0 means there is no such limit.

Calls C++ function: int QStyleHints::startDragVelocity() const.

C++ documentation:

This property holds the limit for the velocity, in pixels per second, that the mouse may be moved, with a button held down, for a drag and drop operation to begin. A value of 0 means there is no such limit.

Access functions:

int startDragVelocity() const

See also startDragDistance and Drag and Drop.

source

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

Returns a reference to the staticMetaObject field.

source

pub unsafe fn tab_focus_behavior(&self) -> TabFocusBehavior

This property holds the focus behavior on press of the tab key.

Calls C++ function: Qt::TabFocusBehavior QStyleHints::tabFocusBehavior() const.

C++ documentation:

This property holds the focus behavior on press of the tab key.

Note: Do not bind this value in QML because the change notifier signal is not implemented yet.

This property was introduced in Qt 5.5.

Access functions:

Qt::TabFocusBehavior tabFocusBehavior() const

Notifier signal:

void tabFocusBehaviorChanged(Qt::TabFocusBehavior tabFocusBehavior)
source

pub unsafe fn touch_double_tap_distance(&self) -> c_int

Available on cpp_lib_version="5.14.0" only.

This property holds the maximum distance, in pixels, that a finger can be moved between two consecutive taps and still have it detected as a double-tap

Calls C++ function: int QStyleHints::touchDoubleTapDistance() const.

C++ documentation:

This property holds the maximum distance, in pixels, that a finger can be moved between two consecutive taps and still have it detected as a double-tap

This property was introduced in Qt 5.14.

Access functions:

int touchDoubleTapDistance() const
source

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

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

source

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

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

source

pub unsafe fn use_hover_effects(&self) -> bool

This property holds whether UI elements use hover effects.

Calls C++ function: bool QStyleHints::useHoverEffects() const.

C++ documentation:

This property holds whether UI elements use hover effects.

This property is true if UI elements should use hover effects. This is the standard behavior on desktop platforms with a mouse pointer, whereas on touch platforms the overhead of hover event delivery can be avoided.

This property was introduced in Qt 5.8.

Access functions:

bool useHoverEffects() const
void setUseHoverEffects(bool useHoverEffects)

Notifier signal:

void useHoverEffectsChanged(bool useHoverEffects)
source

pub unsafe fn use_rtl_extensions(&self) -> bool

This property holds the writing direction.

Calls C++ function: bool QStyleHints::useRtlExtensions() const.

C++ documentation:

This property holds the writing direction.

This property is true if right-to-left writing direction is enabled, otherwise false.

Access functions:

bool useRtlExtensions() const
source

pub unsafe fn wheel_scroll_lines(&self) -> c_int

Number of lines to scroll by default for each wheel click.

Calls C++ function: int QStyleHints::wheelScrollLines() const.

C++ documentation:

Number of lines to scroll by default for each wheel click.

This property was introduced in Qt 5.9.

Access functions:

int wheelScrollLines() const

Notifier signal:

void wheelScrollLinesChanged(int scrollLines)

Methods from Deref<Target = QObject>§

source

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.

source

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.

source

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.

source

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.

source

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.

source

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().

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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().

source

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().

source

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().

source

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().

source

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.

source

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.

source

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().

source

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().

source

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().

source

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().

source

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().

source

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().

source

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.

source

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.

source

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().

source

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().

source

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.

source

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.

source

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().

source

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().

source

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.

source

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.

source

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().

source

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.

source

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().

source

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().

source

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().

source

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().

source

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).

source

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

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

source

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().

source

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().

source

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().

source

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().

source

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.

source

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().

source

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().

source

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§

source§

impl CppDeletable for QStyleHints

source§

unsafe fn delete(&self)

The QStyleHints class contains platform specific hints and settings.

Calls C++ function: [destructor] void QStyleHints::~QStyleHints().

C++ documentation:

The QStyleHints class contains platform specific hints and settings.

An object of this class, obtained from QGuiApplication, provides access to certain global user interface parameters of the current platform.

Access is read only; typically the platform itself provides the user a way to tune these parameters.

Access to these parameters are useful when implementing custom user interface components, in that they allow the components to exhibit the same behaviour and feel as other components.

source§

impl Deref for QStyleHints

source§

fn deref(&self) -> &QObject

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

§

type Target = QObject

The resulting type after dereferencing.
source§

impl DynamicCast<QStyleHints> for QObject

source§

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

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

source§

impl StaticDowncast<QStyleHints> for QObject

source§

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

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

source§

impl StaticUpcast<QObject> for QStyleHints

source§

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

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, U> CastInto<U> for T
where U: CastFrom<T>,

source§

unsafe fn cast_into(self) -> U

Performs the conversion. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> StaticUpcast<T> for T

source§

unsafe fn static_upcast(ptr: Ptr<T>) -> Ptr<T>

Convert type of a const pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.