Struct QListWidget

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

The QListWidget class provides an item-based list widget.

C++ class: QListWidget.

C++ documentation:

The QListWidget class provides an item-based list widget.

QListWidget is a convenience class that provides a list view similar to the one supplied by QListView, but with a classic item-based interface for adding and removing items. QListWidget uses an internal model to manage each QListWidgetItem in the list.

For a more flexible list view widget, use the QListView class with a standard model.

List widgets are constructed in the same way as other widgets:

      QListWidget *listWidget = new QListWidget(this);

The selectionMode() of a list widget determines how many of the items in the list can be selected at the same time, and whether complex selections of items can be created. This can be set with the setSelectionMode() function.

There are two ways to add items to the list: they can be constructed with the list widget as their parent widget, or they can be constructed with no parent widget and added to the list later. If a list widget already exists when the items are constructed, the first method is easier to use:

      new QListWidgetItem(tr(“Oak”), listWidget);
      new QListWidgetItem(tr(“Fir”), listWidget);
      new QListWidgetItem(tr(“Pine”), listWidget);

If you need to insert a new item into the list at a particular position, then it should be constructed without a parent widget. The insertItem() function should then be used to place it within the list. The list widget will take ownership of the item.

      QListWidgetItem *newItem = new QListWidgetItem;
      newItem->setText(itemText);
      listWidget->insertItem(row, newItem);

For multiple items, insertItems() can be used instead. The number of items in the list is found with the count() function. To remove items from the list, use takeItem().

The current item in the list can be found with currentItem(), and changed with setCurrentItem(). The user can also change the current item by navigating with the keyboard or clicking on a different item. When the current item changes, the currentItemChanged() signal is emitted with the new current item and the item that was previously current.

Implementations

impl QListWidget

pub fn slot_scroll_to_item( &self, ) -> Receiver<(*const QListWidgetItem, ScrollHint)>

Scrolls the view if necessary to ensure that the item is visible.

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

C++ documentation:

Scrolls the view if necessary to ensure that the item is visible.

hint specifies where the item should be located after the operation.

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

Removes all items and selections in the view.

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

C++ documentation:

Removes all items and selections in the view.

Warning: All items will be permanently deleted.

pub fn item_pressed(&self) -> Signal<(*mut QListWidgetItem,)>

This signal is emitted with the specified item when a mouse button is pressed on an item in the widget.

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

C++ documentation:

This signal is emitted with the specified item when a mouse button is pressed on an item in the widget.

See also itemClicked() and itemDoubleClicked().

pub fn item_clicked(&self) -> Signal<(*mut QListWidgetItem,)>

This signal is emitted with the specified item when a mouse button is clicked on an item in the widget.

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

C++ documentation:

This signal is emitted with the specified item when a mouse button is clicked on an item in the widget.

See also itemPressed() and itemDoubleClicked().

pub fn item_double_clicked(&self) -> Signal<(*mut QListWidgetItem,)>

This signal is emitted with the specified item when a mouse button is double clicked on an item in the widget.

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

C++ documentation:

This signal is emitted with the specified item when a mouse button is double clicked on an item in the widget.

See also itemClicked() and itemPressed().

pub fn item_activated(&self) -> Signal<(*mut QListWidgetItem,)>

This signal is emitted when the item is activated. The item is activated when the user clicks or double clicks on it, depending on the system configuration. It is also activated when the user presses the activation key (on Windows and X11 this is the Return key, on Mac OS X it is Command+O).

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

C++ documentation:

This signal is emitted when the item is activated. The item is activated when the user clicks or double clicks on it, depending on the system configuration. It is also activated when the user presses the activation key (on Windows and X11 this is the Return key, on Mac OS X it is Command+O).

pub fn item_entered(&self) -> Signal<(*mut QListWidgetItem,)>

This signal is emitted when the mouse cursor enters an item. The item is the item entered. This signal is only emitted when mouseTracking is turned on, or when a mouse button is pressed while moving into an item.

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

C++ documentation:

This signal is emitted when the mouse cursor enters an item. The item is the item entered. This signal is only emitted when mouseTracking is turned on, or when a mouse button is pressed while moving into an item.

See also QWidget::setMouseTracking().

pub fn item_changed(&self) -> Signal<(*mut QListWidgetItem,)>

This signal is emitted whenever the data of item has changed.

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

C++ documentation:

This signal is emitted whenever the data of item has changed.

pub fn current_item_changed( &self, ) -> Signal<(*mut QListWidgetItem, *mut QListWidgetItem)>

This signal is emitted whenever the current item changes.

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

C++ documentation:

This signal is emitted whenever the current item changes.

previous is the item that previously had the focus; current is the new current item.

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

This signal is emitted whenever the current item changes.

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

C++ documentation:

This signal is emitted whenever the current item changes.

currentText is the text data in the current item. If there is no current item, the currentText is invalid.

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

This signal is emitted whenever the current item changes.

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

C++ documentation:

This signal is emitted whenever the current item changes.

currentRow is the row of the current item. If there is no current item, the currentRow is -1.

Note: Notifier signal for property currentRow.

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

This signal is emitted whenever the selection changes.

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

C++ documentation:

This signal is emitted whenever the selection changes.

See also selectedItems(), QListWidgetItem::isSelected(), and currentItemChanged().

pub unsafe fn add_item_q_string(&self, label: impl CastInto<Ref<QString>>)

Inserts an item with the text label at the end of the list widget.

Calls C++ function: void QListWidget::addItem(const QString& label).

C++ documentation:

Inserts an item with the text label at the end of the list widget.

pub unsafe fn add_item_q_list_widget_item( &self, item: impl CastInto<Ptr<QListWidgetItem>>, )

Inserts the item at the end of the list widget.

Calls C++ function: void QListWidget::addItem(QListWidgetItem* item).

C++ documentation:

Inserts the item at the end of the list widget.

Warning: A QListWidgetItem can only be added to a QListWidget once. Adding the same QListWidgetItem multiple times to a QListWidget will result in undefined behavior.

See also insertItem().

pub unsafe fn add_items(&self, labels: impl CastInto<Ref<QStringList>>)

Inserts items with the text labels at the end of the list widget.

Calls C++ function: void QListWidget::addItems(const QStringList& labels).

C++ documentation:

Inserts items with the text labels at the end of the list widget.

See also insertItems().

pub unsafe fn clear(&self)

Removes all items and selections in the view.

Calls C++ function: [slot] void QListWidget::clear().

C++ documentation:

Removes all items and selections in the view.

Warning: All items will be permanently deleted.

pub unsafe fn close_persistent_editor( &self, item: impl CastInto<Ptr<QListWidgetItem>>, )

Closes the persistent editor for the given item.

Calls C++ function: void QListWidget::closePersistentEditor(QListWidgetItem* item).

C++ documentation:

Closes the persistent editor for the given item.

See also openPersistentEditor().

pub unsafe fn count(&self) -> c_int

This property holds the number of items in the list including any hidden items.

Calls C++ function: int QListWidget::count() const.

C++ documentation:

This property holds the number of items in the list including any hidden items.

Access functions:

int	count() const

pub unsafe fn current_item(&self) -> Ptr<QListWidgetItem>

Returns the current item.

Calls C++ function: QListWidgetItem* QListWidget::currentItem() const.

C++ documentation:

Returns the current item.

See also setCurrentItem().

pub unsafe fn current_row(&self) -> c_int

This property holds the row of the current item.

Calls C++ function: int QListWidget::currentRow() const.

C++ documentation:

This property holds the row of the current item.

Depending on the current selection mode, the row may also be selected.

Access functions:

int	currentRow() const
void	setCurrentRow(int row)
void	setCurrentRow(int row, QItemSelectionModel::SelectionFlags command)

Notifier signal:

void	currentRowChanged(int currentRow)

pub unsafe fn drop_event(&self, event: impl CastInto<Ptr<QDropEvent>>)

Reimplemented from QWidget::dropEvent().

Calls C++ function: virtual void QListWidget::dropEvent(QDropEvent* event).

C++ documentation:

Reimplemented from QWidget::dropEvent().

pub unsafe fn edit_item(&self, item: impl CastInto<Ptr<QListWidgetItem>>)

Starts editing the item if it is editable.

Calls C++ function: void QListWidget::editItem(QListWidgetItem* item).

C++ documentation:

Starts editing the item if it is editable.

pub unsafe fn find_items( &self, text: impl CastInto<Ref<QString>>, flags: QFlags<MatchFlag>, ) -> CppBox<QListOfQListWidgetItem>

Finds items with the text that matches the string text using the given flags.

Calls C++ function: QList<QListWidgetItem*> QListWidget::findItems(const QString& text, QFlags<Qt::MatchFlag> flags) const.

C++ documentation:

Finds items with the text that matches the string text using the given flags.

pub unsafe fn insert_item_int_q_list_widget_item( &self, row: c_int, item: impl CastInto<Ptr<QListWidgetItem>>, )

Inserts the item at the position in the list given by row.

Calls C++ function: void QListWidget::insertItem(int row, QListWidgetItem* item).

C++ documentation:

Inserts the item at the position in the list given by row.

See also addItem().

pub unsafe fn insert_item_int_q_string( &self, row: c_int, label: impl CastInto<Ref<QString>>, )

Inserts an item with the text label in the list widget at the position given by row.

Calls C++ function: void QListWidget::insertItem(int row, const QString& label).

C++ documentation:

Inserts an item with the text label in the list widget at the position given by row.

See also addItem().

pub unsafe fn insert_items( &self, row: c_int, labels: impl CastInto<Ref<QStringList>>, )

Inserts items from the list of labels into the list, starting at the given row.

Calls C++ function: void QListWidget::insertItems(int row, const QStringList& labels).

C++ documentation:

Inserts items from the list of labels into the list, starting at the given row.

See also insertItem() and addItem().

pub unsafe fn is_item_hidden( &self, item: impl CastInto<Ptr<QListWidgetItem>>, ) -> bool

Returns true if the item is explicitly hidden; otherwise returns false.

Calls C++ function: bool QListWidget::isItemHidden(const QListWidgetItem* item) const.

C++ documentation:

Returns true if the item is explicitly hidden; otherwise returns false.

This function is deprecated. Use QListWidgetItem::isHidden() instead.

pub unsafe fn is_item_selected( &self, item: impl CastInto<Ptr<QListWidgetItem>>, ) -> bool

Returns true if item is selected; otherwise returns false.

Calls C++ function: bool QListWidget::isItemSelected(const QListWidgetItem* item) const.

C++ documentation:

Returns true if item is selected; otherwise returns false.

This function is deprecated. Use QListWidgetItem::isSelected() instead.

pub unsafe fn is_persistent_editor_open( &self, item: impl CastInto<Ptr<QListWidgetItem>>, ) -> 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.

Returns whether a persistent editor is open for item item.

Calls C++ function: bool QListWidget::isPersistentEditorOpen(QListWidgetItem* item) const.

C++ documentation:

Returns whether a persistent editor is open for item item.

This function was introduced in Qt 5.10.

See also openPersistentEditor() and closePersistentEditor().

pub unsafe fn is_sorting_enabled(&self) -> bool

This property holds whether sorting is enabled

Calls C++ function: bool QListWidget::isSortingEnabled() const.

C++ documentation:

This property holds whether sorting is enabled

If this property is true, sorting is enabled for the list; if the property is false, sorting is not enabled.

The default value is false.

This property was introduced in Qt 4.2.

Access functions:

bool	isSortingEnabled() const
void	setSortingEnabled(bool enable)

pub unsafe fn item(&self, row: c_int) -> Ptr<QListWidgetItem>

Returns the item that occupies the given row in the list if one has been set; otherwise returns 0.

Calls C++ function: QListWidgetItem* QListWidget::item(int row) const.

C++ documentation:

Returns the item that occupies the given row in the list if one has been set; otherwise returns 0.

See also row().

pub unsafe fn item_at_1a( &self, p: impl CastInto<Ref<QPoint>>, ) -> Ptr<QListWidgetItem>

Returns a pointer to the item at the coordinates p. The coordinates are relative to the list widget's viewport().

Calls C++ function: QListWidgetItem* QListWidget::itemAt(const QPoint& p) const.

C++ documentation:

Returns a pointer to the item at the coordinates p. The coordinates are relative to the list widget’s viewport().

pub unsafe fn item_at_2a(&self, x: c_int, y: c_int) -> Ptr<QListWidgetItem>

This is an overloaded function.

Calls C++ function: QListWidgetItem* QListWidget::itemAt(int x, int y) const.

C++ documentation:

This is an overloaded function.

Returns a pointer to the item at the coordinates (x, y). The coordinates are relative to the list widget's viewport().

pub unsafe fn item_widget( &self, item: impl CastInto<Ptr<QListWidgetItem>>, ) -> QPtr<QWidget>

Returns the widget displayed in the given item.

Calls C++ function: QWidget* QListWidget::itemWidget(QListWidgetItem* item) const.

C++ documentation:

Returns the widget displayed in the given item.

This function was introduced in Qt 4.1.

See also setItemWidget() and removeItemWidget().

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

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

pub unsafe fn new_1a(parent: impl CastInto<Ptr<QWidget>>) -> QBox<QListWidget>

Constructs an empty QListWidget with the given parent.

Calls C++ function: [constructor] void QListWidget::QListWidget(QWidget* parent = …).

C++ documentation:

Constructs an empty QListWidget with the given parent.

pub unsafe fn new_0a() -> QBox<QListWidget>

The QListWidget class provides an item-based list widget.

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

C++ documentation:

The QListWidget class provides an item-based list widget.

QListWidget is a convenience class that provides a list view similar to the one supplied by QListView, but with a classic item-based interface for adding and removing items. QListWidget uses an internal model to manage each QListWidgetItem in the list.

For a more flexible list view widget, use the QListView class with a standard model.

List widgets are constructed in the same way as other widgets:

      QListWidget *listWidget = new QListWidget(this);

The selectionMode() of a list widget determines how many of the items in the list can be selected at the same time, and whether complex selections of items can be created. This can be set with the setSelectionMode() function.

There are two ways to add items to the list: they can be constructed with the list widget as their parent widget, or they can be constructed with no parent widget and added to the list later. If a list widget already exists when the items are constructed, the first method is easier to use:

      new QListWidgetItem(tr(“Oak”), listWidget);
      new QListWidgetItem(tr(“Fir”), listWidget);
      new QListWidgetItem(tr(“Pine”), listWidget);

If you need to insert a new item into the list at a particular position, then it should be constructed without a parent widget. The insertItem() function should then be used to place it within the list. The list widget will take ownership of the item.

      QListWidgetItem *newItem = new QListWidgetItem;
      newItem->setText(itemText);
      listWidget->insertItem(row, newItem);

For multiple items, insertItems() can be used instead. The number of items in the list is found with the count() function. To remove items from the list, use takeItem().

The current item in the list can be found with currentItem(), and changed with setCurrentItem(). The user can also change the current item by navigating with the keyboard or clicking on a different item. When the current item changes, the currentItemChanged() signal is emitted with the new current item and the item that was previously current.

pub unsafe fn open_persistent_editor( &self, item: impl CastInto<Ptr<QListWidgetItem>>, )

Opens an editor for the given item. The editor remains open after editing.

Calls C++ function: void QListWidget::openPersistentEditor(QListWidgetItem* item).

C++ documentation:

Opens an editor for the given item. The editor remains open after editing.

See also closePersistentEditor().

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

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

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

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

pub unsafe fn remove_item_widget( &self, item: impl CastInto<Ptr<QListWidgetItem>>, )

Removes the widget set on the given item.

Calls C++ function: void QListWidget::removeItemWidget(QListWidgetItem* item).

C++ documentation:

Removes the widget set on the given item.

To remove an item (row) from the list entirely, either delete the item or use takeItem().

This function was introduced in Qt 4.3.

See also itemWidget() and setItemWidget().

pub unsafe fn row(&self, item: impl CastInto<Ptr<QListWidgetItem>>) -> c_int

Returns the row containing the given item.

Calls C++ function: int QListWidget::row(const QListWidgetItem* item) const.

C++ documentation:

Returns the row containing the given item.

See also item().

pub unsafe fn scroll_to_item_2a( &self, item: impl CastInto<Ptr<QListWidgetItem>>, hint: ScrollHint, )

Scrolls the view if necessary to ensure that the item is visible.

Calls C++ function: [slot] void QListWidget::scrollToItem(const QListWidgetItem* item, QAbstractItemView::ScrollHint hint = …).

C++ documentation:

Scrolls the view if necessary to ensure that the item is visible.

hint specifies where the item should be located after the operation.

pub unsafe fn scroll_to_item_1a( &self, item: impl CastInto<Ptr<QListWidgetItem>>, )

Scrolls the view if necessary to ensure that the item is visible.

Calls C++ function: [slot] void QListWidget::scrollToItem(const QListWidgetItem* item).

C++ documentation:

Scrolls the view if necessary to ensure that the item is visible.

hint specifies where the item should be located after the operation.

pub unsafe fn selected_items(&self) -> CppBox<QListOfQListWidgetItem>

Returns a list of all selected items in the list widget.

Calls C++ function: QList<QListWidgetItem*> QListWidget::selectedItems() const.

C++ documentation:

Returns a list of all selected items in the list widget.

pub unsafe fn set_current_item_1a( &self, item: impl CastInto<Ptr<QListWidgetItem>>, )

Sets the current item to item.

Calls C++ function: void QListWidget::setCurrentItem(QListWidgetItem* item).

C++ documentation:

Sets the current item to item.

Unless the selection mode is NoSelection, the item is also selected.

See also currentItem().

pub unsafe fn set_current_item_2a( &self, item: impl CastInto<Ptr<QListWidgetItem>>, command: QFlags<SelectionFlag>, )

Set the current item to item, using the given command.

Calls C++ function: void QListWidget::setCurrentItem(QListWidgetItem* item, QFlags<QItemSelectionModel::SelectionFlag> command).

C++ documentation:

Set the current item to item, using the given command.

This function was introduced in Qt 4.4.

pub unsafe fn set_current_row_1a(&self, row: c_int)

This property holds the row of the current item.

Calls C++ function: void QListWidget::setCurrentRow(int row).

C++ documentation:

This property holds the row of the current item.

Depending on the current selection mode, the row may also be selected.

Access functions:

int	currentRow() const
void	setCurrentRow(int row)
void	setCurrentRow(int row, QItemSelectionModel::SelectionFlags command)

Notifier signal:

void	currentRowChanged(int currentRow)

pub unsafe fn set_current_row_2a( &self, row: c_int, command: QFlags<SelectionFlag>, )

This property holds the row of the current item.

Calls C++ function: void QListWidget::setCurrentRow(int row, QFlags<QItemSelectionModel::SelectionFlag> command).

C++ documentation:

This property holds the row of the current item.

Depending on the current selection mode, the row may also be selected.

Access functions:

int	currentRow() const
void	setCurrentRow(int row)
void	setCurrentRow(int row, QItemSelectionModel::SelectionFlags command)

Notifier signal:

void	currentRowChanged(int currentRow)

pub unsafe fn set_item_hidden( &self, item: impl CastInto<Ptr<QListWidgetItem>>, hide: bool, )

If hide is true, the item will be hidden; otherwise it will be shown.

Calls C++ function: void QListWidget::setItemHidden(const QListWidgetItem* item, bool hide).

C++ documentation:

If hide is true, the item will be hidden; otherwise it will be shown.

This function is deprecated. Use QListWidgetItem::setHidden() instead.

See also isItemHidden().

pub unsafe fn set_item_selected( &self, item: impl CastInto<Ptr<QListWidgetItem>>, select: bool, )

Selects or deselects the given item depending on whether select is true of false.

Calls C++ function: void QListWidget::setItemSelected(const QListWidgetItem* item, bool select).

C++ documentation:

Selects or deselects the given item depending on whether select is true of false.

This function is deprecated. Use QListWidgetItem::setSelected() instead.

See also isItemSelected().

pub unsafe fn set_item_widget( &self, item: impl CastInto<Ptr<QListWidgetItem>>, widget: impl CastInto<Ptr<QWidget>>, )

Sets the widget to be displayed in the given item.

Calls C++ function: void QListWidget::setItemWidget(QListWidgetItem* item, QWidget* widget).

C++ documentation:

Sets the widget to be displayed in the given item.

This function should only be used to display static content in the place of a list widget item. If you want to display custom dynamic content or implement a custom editor widget, use QListView and subclass QItemDelegate instead.

This function was introduced in Qt 4.1.

See also itemWidget(), removeItemWidget(), and Delegate Classes.

pub unsafe fn set_selection_model( &self, selection_model: impl CastInto<Ptr<QItemSelectionModel>>, )

Reimplemented from QAbstractItemView::setSelectionModel().

Calls C++ function: virtual void QListWidget::setSelectionModel(QItemSelectionModel* selectionModel).

C++ documentation:

Reimplemented from QAbstractItemView::setSelectionModel().

pub unsafe fn set_sorting_enabled(&self, enable: bool)

This property holds whether sorting is enabled

Calls C++ function: void QListWidget::setSortingEnabled(bool enable).

C++ documentation:

This property holds whether sorting is enabled

If this property is true, sorting is enabled for the list; if the property is false, sorting is not enabled.

The default value is false.

This property was introduced in Qt 4.2.

Access functions:

bool	isSortingEnabled() const
void	setSortingEnabled(bool enable)

pub unsafe fn sort_items_1a(&self, order: SortOrder)

Sorts all the items in the list widget according to the specified order.

Calls C++ function: void QListWidget::sortItems(Qt::SortOrder order = …).

C++ documentation:

Sorts all the items in the list widget according to the specified order.

pub unsafe fn sort_items_0a(&self)

Sorts all the items in the list widget according to the specified order.

Calls C++ function: void QListWidget::sortItems().

C++ documentation:

Sorts all the items in the list widget according to the specified order.

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

Returns a reference to the staticMetaObject field.

pub unsafe fn take_item(&self, row: c_int) -> Ptr<QListWidgetItem>

Removes and returns the item from the given row in the list widget; otherwise returns 0.

Calls C++ function: QListWidgetItem* QListWidget::takeItem(int row).

C++ documentation:

Removes and returns the item from the given row in the list widget; otherwise returns 0.

Items removed from a list widget will not be managed by Qt, and will need to be deleted manually.

See also insertItem() and addItem().

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

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

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

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

pub unsafe fn visual_item_rect( &self, item: impl CastInto<Ptr<QListWidgetItem>>, ) -> CppBox<QRect>

Returns the rectangle on the viewport occupied by the item at item.

Calls C++ function: QRect QListWidget::visualItemRect(const QListWidgetItem* item) const.

C++ documentation:

Returns the rectangle on the viewport occupied by the item at item.

Methods from Deref<Target = QListView>

pub fn indexes_moved(&self) -> Signal<(*const QListOfQModelIndex,)>

This signal is emitted when the specified indexes are moved in the view.

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

C++ documentation:

This signal is emitted when the specified indexes are moved in the view.

This function was introduced in Qt 4.2.

pub unsafe fn batch_size(&self) -> c_int

This property holds the number of items laid out in each batch if layoutMode is set to Batched

Calls C++ function: int QListView::batchSize() const.

C++ documentation:

This property holds the number of items laid out in each batch if layoutMode is set to Batched

The default value is 100.

This property was introduced in Qt 4.2.

Access functions:

int	batchSize() const
void	setBatchSize(int batchSize)

pub unsafe fn clear_property_flags(&self)

Clears the QListView-specific property flags. See viewMode.

Calls C++ function: void QListView::clearPropertyFlags().

C++ documentation:

Clears the QListView-specific property flags. See viewMode.

Properties inherited from QAbstractItemView are not covered by the property flags. Specifically, dragEnabled and acceptsDrops are computed by QListView when calling setMovement() or setViewMode().

pub unsafe fn do_items_layout(&self)

Calls C++ function: virtual void QListView::doItemsLayout().

pub unsafe fn flow(&self) -> Flow

This property holds which direction the items layout should flow.

Calls C++ function: QListView::Flow QListView::flow() const.

C++ documentation:

This property holds which direction the items layout should flow.

If this property is LeftToRight, the items will be laid out left to right. If the isWrapping property is true, the layout will wrap when it reaches the right side of the visible area. If this property is TopToBottom, the items will be laid out from the top of the visible area, wrapping when it reaches the bottom.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is set to TopToBottom.

Access functions:

Flow	flow() const
void	setFlow(Flow flow)

See also viewMode.

pub unsafe fn grid_size(&self) -> CppBox<QSize>

This property holds the size of the layout grid

Calls C++ function: QSize QListView::gridSize() const.

C++ documentation:

This property holds the size of the layout grid

This property is the size of the grid in which the items are laid out. The default is an empty size which means that there is no grid and the layout is not done in a grid. Setting this property to a non-empty size switches on the grid layout. (When a grid layout is in force the spacing property is ignored.)

Setting this property when the view is visible will cause the items to be laid out again.

Access functions:

QSize	gridSize() const
void	setGridSize(const QSize &size)

See also viewMode.

pub unsafe fn index_at( &self, p: impl CastInto<Ref<QPoint>>, ) -> CppBox<QModelIndex>

Reimplemented from QAbstractItemView::indexAt().

Calls C++ function: virtual QModelIndex QListView::indexAt(const QPoint& p) const.

C++ documentation:

Reimplemented from QAbstractItemView::indexAt().

pub unsafe fn is_row_hidden(&self, row: c_int) -> bool

Returns true if the row is hidden; otherwise returns false.

Calls C++ function: bool QListView::isRowHidden(int row) const.

C++ documentation:

Returns true if the row is hidden; otherwise returns false.

pub unsafe fn is_selection_rect_visible(&self) -> bool

if the selection rectangle should be visible

Calls C++ function: bool QListView::isSelectionRectVisible() const.

C++ documentation:

if the selection rectangle should be visible

If this property is true then the selection rectangle is visible; otherwise it will be hidden.

Note: The selection rectangle will only be visible if the selection mode is in a mode where more than one item can be selected; i.e., it will not draw a selection rectangle if the selection mode is QAbstractItemView::SingleSelection.

By default, this property is false.

This property was introduced in Qt 4.3.

Access functions:

bool	isSelectionRectVisible() const
void	setSelectionRectVisible(bool show)

pub unsafe fn is_wrapping(&self) -> bool

This property holds whether the items layout should wrap.

Calls C++ function: bool QListView::isWrapping() const.

C++ documentation:

This property holds whether the items layout should wrap.

This property holds whether the layout should wrap when there is no more space in the visible area. The point at which the layout wraps depends on the flow property.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is false.

Access functions:

bool	isWrapping() const
void	setWrapping(bool enable)

See also viewMode.

pub unsafe fn item_alignment(&self) -> QFlags<AlignmentFlag>

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

This property holds the alignment of each item in its cell

Calls C++ function: QFlags<Qt::AlignmentFlag> QListView::itemAlignment() const.

C++ documentation:

This property holds the alignment of each item in its cell

This is only supported in ListMode with TopToBottom flow and with wrapping enabled. The default alignment is 0, which means that an item fills its cell entirely.

This property was introduced in Qt 5.12.

Access functions:

Qt::Alignment	itemAlignment() const
void	setItemAlignment(Qt::Alignment alignment)

pub unsafe fn layout_mode(&self) -> LayoutMode

determines whether the layout of items should happen immediately or be delayed.

Calls C++ function: QListView::LayoutMode QListView::layoutMode() const.

C++ documentation:

determines whether the layout of items should happen immediately or be delayed.

This property holds the layout mode for the items. When the mode is SinglePass (the default), the items are laid out all in one go. When the mode is Batched, the items are laid out in batches of batchSize items, while processing events. This makes it possible to instantly view and interact with the visible items while the rest are being laid out.

Access functions:

LayoutMode	layoutMode() const
void	setLayoutMode(LayoutMode mode)

See also viewMode.

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

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

pub unsafe fn model_column(&self) -> c_int

This property holds the column in the model that is visible

Calls C++ function: int QListView::modelColumn() const.

C++ documentation:

This property holds the column in the model that is visible

By default, this property contains 0, indicating that the first column in the model will be shown.

Access functions:

int	modelColumn() const
void	setModelColumn(int column)

pub unsafe fn movement(&self) -> Movement

This property holds whether the items can be moved freely, are snapped to a grid, or cannot be moved at all.

Calls C++ function: QListView::Movement QListView::movement() const.

C++ documentation:

This property holds whether the items can be moved freely, are snapped to a grid, or cannot be moved at all.

This property determines how the user can move the items in the view. Static means that the items can't be moved the user. Free means that the user can drag and drop the items to any position in the view. Snap means that the user can drag and drop the items, but only to the positions in a notional grid signified by the gridSize property.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is set to Static.

Access functions:

Movement	movement() const
void	setMovement(Movement movement)

See also gridSize, resizeMode, and viewMode.

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

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

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

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

pub unsafe fn reset(&self)

Calls C++ function: virtual void QListView::reset().

pub unsafe fn resize_mode(&self) -> ResizeMode

This property holds whether the items are laid out again when the view is resized.

Calls C++ function: QListView::ResizeMode QListView::resizeMode() const.

C++ documentation:

This property holds whether the items are laid out again when the view is resized.

If this property is Adjust, the items will be laid out again when the view is resized. If the value is Fixed, the items will not be laid out when the view is resized.

By default, this property is set to Fixed.

Access functions:

ResizeMode	resizeMode() const
void	setResizeMode(ResizeMode mode)

See also movement, gridSize, and viewMode.

pub unsafe fn scroll_to_2a( &self, index: impl CastInto<Ref<QModelIndex>>, hint: ScrollHint, )

Reimplemented from QAbstractItemView::scrollTo().

Calls C++ function: virtual void QListView::scrollTo(const QModelIndex& index, QAbstractItemView::ScrollHint hint = …).

C++ documentation:

Reimplemented from QAbstractItemView::scrollTo().

pub unsafe fn scroll_to_1a(&self, index: impl CastInto<Ref<QModelIndex>>)

Reimplemented from QAbstractItemView::scrollTo().

Calls C++ function: virtual void QListView::scrollTo(const QModelIndex& index).

C++ documentation:

Reimplemented from QAbstractItemView::scrollTo().

pub unsafe fn set_batch_size(&self, batch_size: c_int)

This property holds the number of items laid out in each batch if layoutMode is set to Batched

Calls C++ function: void QListView::setBatchSize(int batchSize).

C++ documentation:

This property holds the number of items laid out in each batch if layoutMode is set to Batched

The default value is 100.

This property was introduced in Qt 4.2.

Access functions:

int	batchSize() const
void	setBatchSize(int batchSize)

pub unsafe fn set_flow(&self, flow: Flow)

This property holds which direction the items layout should flow.

Calls C++ function: void QListView::setFlow(QListView::Flow flow).

C++ documentation:

This property holds which direction the items layout should flow.

If this property is LeftToRight, the items will be laid out left to right. If the isWrapping property is true, the layout will wrap when it reaches the right side of the visible area. If this property is TopToBottom, the items will be laid out from the top of the visible area, wrapping when it reaches the bottom.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is set to TopToBottom.

Access functions:

Flow	flow() const
void	setFlow(Flow flow)

See also viewMode.

pub unsafe fn set_grid_size(&self, size: impl CastInto<Ref<QSize>>)

This property holds the size of the layout grid

Calls C++ function: void QListView::setGridSize(const QSize& size).

C++ documentation:

This property holds the size of the layout grid

This property is the size of the grid in which the items are laid out. The default is an empty size which means that there is no grid and the layout is not done in a grid. Setting this property to a non-empty size switches on the grid layout. (When a grid layout is in force the spacing property is ignored.)

Setting this property when the view is visible will cause the items to be laid out again.

Access functions:

QSize	gridSize() const
void	setGridSize(const QSize &size)

See also viewMode.

pub unsafe fn set_item_alignment(&self, alignment: QFlags<AlignmentFlag>)

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

This property holds the alignment of each item in its cell

Calls C++ function: void QListView::setItemAlignment(QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

This property holds the alignment of each item in its cell

This is only supported in ListMode with TopToBottom flow and with wrapping enabled. The default alignment is 0, which means that an item fills its cell entirely.

This property was introduced in Qt 5.12.

Access functions:

Qt::Alignment	itemAlignment() const
void	setItemAlignment(Qt::Alignment alignment)

pub unsafe fn set_layout_mode(&self, mode: LayoutMode)

determines whether the layout of items should happen immediately or be delayed.

Calls C++ function: void QListView::setLayoutMode(QListView::LayoutMode mode).

C++ documentation:

determines whether the layout of items should happen immediately or be delayed.

This property holds the layout mode for the items. When the mode is SinglePass (the default), the items are laid out all in one go. When the mode is Batched, the items are laid out in batches of batchSize items, while processing events. This makes it possible to instantly view and interact with the visible items while the rest are being laid out.

Access functions:

LayoutMode	layoutMode() const
void	setLayoutMode(LayoutMode mode)

See also viewMode.

pub unsafe fn set_model_column(&self, column: c_int)

This property holds the column in the model that is visible

Calls C++ function: void QListView::setModelColumn(int column).

C++ documentation:

This property holds the column in the model that is visible

By default, this property contains 0, indicating that the first column in the model will be shown.

Access functions:

int	modelColumn() const
void	setModelColumn(int column)

pub unsafe fn set_movement(&self, movement: Movement)

This property holds whether the items can be moved freely, are snapped to a grid, or cannot be moved at all.

Calls C++ function: void QListView::setMovement(QListView::Movement movement).

C++ documentation:

This property holds whether the items can be moved freely, are snapped to a grid, or cannot be moved at all.

This property determines how the user can move the items in the view. Static means that the items can't be moved the user. Free means that the user can drag and drop the items to any position in the view. Snap means that the user can drag and drop the items, but only to the positions in a notional grid signified by the gridSize property.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is set to Static.

Access functions:

Movement	movement() const
void	setMovement(Movement movement)

See also gridSize, resizeMode, and viewMode.

pub unsafe fn set_resize_mode(&self, mode: ResizeMode)

This property holds whether the items are laid out again when the view is resized.

Calls C++ function: void QListView::setResizeMode(QListView::ResizeMode mode).

C++ documentation:

This property holds whether the items are laid out again when the view is resized.

If this property is Adjust, the items will be laid out again when the view is resized. If the value is Fixed, the items will not be laid out when the view is resized.

By default, this property is set to Fixed.

Access functions:

ResizeMode	resizeMode() const
void	setResizeMode(ResizeMode mode)

See also movement, gridSize, and viewMode.

pub unsafe fn set_root_index(&self, index: impl CastInto<Ref<QModelIndex>>)

Calls C++ function: virtual void QListView::setRootIndex(const QModelIndex& index).

pub unsafe fn set_row_hidden(&self, row: c_int, hide: bool)

If hide is true, the given row will be hidden; otherwise the row will be shown.

Calls C++ function: void QListView::setRowHidden(int row, bool hide).

C++ documentation:

If hide is true, the given row will be hidden; otherwise the row will be shown.

See also isRowHidden().

pub unsafe fn set_selection_rect_visible(&self, show: bool)

if the selection rectangle should be visible

Calls C++ function: void QListView::setSelectionRectVisible(bool show).

C++ documentation:

if the selection rectangle should be visible

If this property is true then the selection rectangle is visible; otherwise it will be hidden.

Note: The selection rectangle will only be visible if the selection mode is in a mode where more than one item can be selected; i.e., it will not draw a selection rectangle if the selection mode is QAbstractItemView::SingleSelection.

By default, this property is false.

This property was introduced in Qt 4.3.

Access functions:

bool	isSelectionRectVisible() const
void	setSelectionRectVisible(bool show)

pub unsafe fn set_spacing(&self, space: c_int)

This property holds the space around the items in the layout

Calls C++ function: void QListView::setSpacing(int space).

C++ documentation:

This property holds the space around the items in the layout

This property is the size of the empty space that is padded around an item in the layout.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property contains a value of 0.

Access functions:

int	spacing() const
void	setSpacing(int space)

See also viewMode.

pub unsafe fn set_uniform_item_sizes(&self, enable: bool)

This property holds whether all items in the listview have the same size

Calls C++ function: void QListView::setUniformItemSizes(bool enable).

C++ documentation:

This property holds whether all items in the listview have the same size

This property should only be set to true if it is guaranteed that all items in the view have the same size. This enables the view to do some optimizations for performance purposes.

By default, this property is false.

This property was introduced in Qt 4.1.

Access functions:

bool	uniformItemSizes() const
void	setUniformItemSizes(bool enable)

pub unsafe fn set_view_mode(&self, mode: ViewMode)

This property holds the view mode of the QListView.

Calls C++ function: void QListView::setViewMode(QListView::ViewMode mode).

C++ documentation:

This property holds the view mode of the QListView.

This property will change the other unset properties to conform with the set view mode. QListView-specific properties that have already been set will not be changed, unless clearPropertyFlags() has been called.

Setting the view mode will enable or disable drag and drop based on the selected movement. For ListMode, the default movement is Static (drag and drop disabled); for IconMode, the default movement is Free (drag and drop enabled).

Access functions:

ViewMode	viewMode() const
void	setViewMode(ViewMode mode)

See also isWrapping, spacing, gridSize, flow, movement, and resizeMode.

pub unsafe fn set_word_wrap(&self, on: bool)

This property holds the item text word-wrapping policy

Calls C++ function: void QListView::setWordWrap(bool on).

C++ documentation:

This property holds the item text word-wrapping policy

If this property is true then the item text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. This property is false by default.

Please note that even if wrapping is enabled, the cell will not be expanded to make room for the text. It will print ellipsis for text that cannot be shown, according to the view's textElideMode.

This property was introduced in Qt 4.2.

Access functions:

bool	wordWrap() const
void	setWordWrap(bool on)

pub unsafe fn set_wrapping(&self, enable: bool)

This property holds whether the items layout should wrap.

Calls C++ function: void QListView::setWrapping(bool enable).

C++ documentation:

This property holds whether the items layout should wrap.

This property holds whether the layout should wrap when there is no more space in the visible area. The point at which the layout wraps depends on the flow property.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property is false.

Access functions:

bool	isWrapping() const
void	setWrapping(bool enable)

See also viewMode.

pub unsafe fn spacing(&self) -> c_int

This property holds the space around the items in the layout

Calls C++ function: int QListView::spacing() const.

C++ documentation:

This property holds the space around the items in the layout

This property is the size of the empty space that is padded around an item in the layout.

Setting this property when the view is visible will cause the items to be laid out again.

By default, this property contains a value of 0.

Access functions:

int	spacing() const
void	setSpacing(int space)

See also viewMode.

pub unsafe fn uniform_item_sizes(&self) -> bool

This property holds whether all items in the listview have the same size

Calls C++ function: bool QListView::uniformItemSizes() const.

C++ documentation:

This property holds whether all items in the listview have the same size

This property should only be set to true if it is guaranteed that all items in the view have the same size. This enables the view to do some optimizations for performance purposes.

By default, this property is false.

This property was introduced in Qt 4.1.

Access functions:

bool	uniformItemSizes() const
void	setUniformItemSizes(bool enable)

pub unsafe fn view_mode(&self) -> ViewMode

This property holds the view mode of the QListView.

Calls C++ function: QListView::ViewMode QListView::viewMode() const.

C++ documentation:

This property holds the view mode of the QListView.

This property will change the other unset properties to conform with the set view mode. QListView-specific properties that have already been set will not be changed, unless clearPropertyFlags() has been called.

Setting the view mode will enable or disable drag and drop based on the selected movement. For ListMode, the default movement is Static (drag and drop disabled); for IconMode, the default movement is Free (drag and drop enabled).

Access functions:

ViewMode	viewMode() const
void	setViewMode(ViewMode mode)

See also isWrapping, spacing, gridSize, flow, movement, and resizeMode.

pub unsafe fn visual_rect( &self, index: impl CastInto<Ref<QModelIndex>>, ) -> CppBox<QRect>

Reimplemented from QAbstractItemView::visualRect().

Calls C++ function: virtual QRect QListView::visualRect(const QModelIndex& index) const.

C++ documentation:

Reimplemented from QAbstractItemView::visualRect().

pub unsafe fn word_wrap(&self) -> bool

This property holds the item text word-wrapping policy

Calls C++ function: bool QListView::wordWrap() const.

C++ documentation:

This property holds the item text word-wrapping policy

If this property is true then the item text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. This property is false by default.

Please note that even if wrapping is enabled, the cell will not be expanded to make room for the text. It will print ellipsis for text that cannot be shown, according to the view's textElideMode.

This property was introduced in Qt 4.2.

Access functions:

bool	wordWrap() const
void	setWordWrap(bool on)

Methods from Deref<Target = QAbstractItemView>

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

Reset the internal state of the view.

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

C++ documentation:

Reset the internal state of the view.

Warning: This function will reset open editors, scroll bar positions, selections, etc. Existing changes will not be committed. If you would like to save your changes when resetting the view, you can reimplement this function, commit your changes, and then call the superclass' implementation.

pub fn slot_set_root_index(&self) -> Receiver<(*const QModelIndex,)>

Sets the root item to the item at the given index.

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

C++ documentation:

Sets the root item to the item at the given index.

See also rootIndex().

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

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

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

Selects all items in the view. This function will use the selection behavior set on the view when selecting.

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

C++ documentation:

Selects all items in the view. This function will use the selection behavior set on the view when selecting.

See also setSelection(), selectedIndexes(), and clearSelection().

pub fn slot_edit(&self) -> Receiver<(*const QModelIndex,)>

Starts editing the item corresponding to the given index if it is editable.

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

C++ documentation:

Starts editing the item corresponding to the given index if it is editable.

Note that this function does not change the current index. Since the current index defines the next and previous items to edit, users may find that keyboard navigation does not work as expected. To provide consistent navigation behavior, call setCurrentIndex() before this function with the same model index.

See also QModelIndex::flags().

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

Deselects all selected items. The current index will not be changed.

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

C++ documentation:

Deselects all selected items. The current index will not be changed.

See also setSelection() and selectAll().

pub fn slot_set_current_index(&self) -> Receiver<(*const QModelIndex,)>

Sets the current item to be the item at index.

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

C++ documentation:

Sets the current item to be the item at index.

Unless the current selection mode is NoSelection, the item is also selected. Note that this function also updates the starting position for any new selections the user performs.

To set an item as the current item without selecting it, call

selectionModel()->setCurrentIndex(index, QItemSelectionModel::NoUpdate);

See also currentIndex(), currentChanged(), and selectionMode.

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

Scrolls the view to the top.

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

C++ documentation:

Scrolls the view to the top.

This function was introduced in Qt 4.1.

See also scrollTo() and scrollToBottom().

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

Scrolls the view to the bottom.

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

C++ documentation:

Scrolls the view to the bottom.

This function was introduced in Qt 4.1.

See also scrollTo() and scrollToTop().

pub fn slot_update(&self) -> Receiver<(*const QModelIndex,)>

Updates the area occupied by the given index.

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

C++ documentation:

Updates the area occupied by the given index.

This function was introduced in Qt 4.3.

pub fn slot_data_changed( &self, ) -> Receiver<(*const QModelIndex, *const QModelIndex, *const QVectorOfInt)>

This slot is called when items with the given roles are changed in the model. The changed items are those from topLeft to bottomRight inclusive. If just one item is changed topLeft == bottomRight.

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

C++ documentation:

This slot is called when items with the given roles are changed in the model. The changed items are those from topLeft to bottomRight inclusive. If just one item is changed topLeft == bottomRight.

The roles which have been changed can either be an empty container (meaning everything has changed), or a non-empty container with the subset of roles which have changed.

pub fn slot_rows_inserted(&self) -> Receiver<(*const QModelIndex, c_int, c_int)>

This slot is called when rows are inserted. The new rows are those under the given parent from start to end inclusive. The base class implementation calls fetchMore() on the model to check for more data.

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

C++ documentation:

This slot is called when rows are inserted. The new rows are those under the given parent from start to end inclusive. The base class implementation calls fetchMore() on the model to check for more data.

See also rowsAboutToBeRemoved().

pub fn slot_rows_about_to_be_removed( &self, ) -> Receiver<(*const QModelIndex, c_int, c_int)>

This slot is called when rows are about to be removed. The deleted rows are those under the given parent from start to end inclusive.

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

C++ documentation:

This slot is called when rows are about to be removed. The deleted rows are those under the given parent from start to end inclusive.

See also rowsInserted().

pub fn slot_selection_changed( &self, ) -> Receiver<(*const QItemSelection, *const QItemSelection)>

This slot is called when the selection is changed. The previous selection (which may be empty), is specified by deselected, and the new selection by selected.

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

C++ documentation:

This slot is called when the selection is changed. The previous selection (which may be empty), is specified by deselected, and the new selection by selected.

See also setSelection().

pub fn slot_current_changed( &self, ) -> Receiver<(*const QModelIndex, *const QModelIndex)>

This slot is called when a new item becomes the current item. The previous current item is specified by the previous index, and the new item by the current index.

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

C++ documentation:

This slot is called when a new item becomes the current item. The previous current item is specified by the previous index, and the new item by the current index.

If you want to know about changes to items see the dataChanged() signal.

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

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

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

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

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

Updates the geometry of the child widgets of the view.

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

C++ documentation:

Updates the geometry of the child widgets of the view.

This function was introduced in Qt 4.4.

pub fn slot_vertical_scrollbar_action(&self) -> Receiver<(c_int,)>

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

pub fn slot_horizontal_scrollbar_action(&self) -> Receiver<(c_int,)>

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

pub fn slot_vertical_scrollbar_value_changed(&self) -> Receiver<(c_int,)>

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

pub fn slot_horizontal_scrollbar_value_changed(&self) -> Receiver<(c_int,)>

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

pub fn slot_close_editor(&self) -> Receiver<(*mut QWidget, EndEditHint)>

Closes the given editor, and releases it. The hint is used to specify how the view should respond to the end of the editing operation. For example, the hint may indicate that the next item in the view should be opened for editing.

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

C++ documentation:

Closes the given editor, and releases it. The hint is used to specify how the view should respond to the end of the editing operation. For example, the hint may indicate that the next item in the view should be opened for editing.

See also edit() and commitData().

pub fn slot_commit_data(&self) -> Receiver<(*mut QWidget,)>

Commit the data in the editor to the model.

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

C++ documentation:

Commit the data in the editor to the model.

See also closeEditor().

pub fn slot_editor_destroyed(&self) -> Receiver<(*mut QObject,)>

This function is called when the given editor has been destroyed.

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

C++ documentation:

This function is called when the given editor has been destroyed.

See also closeEditor().

pub fn pressed(&self) -> Signal<(*const QModelIndex,)>

This signal is emitted when a mouse button is pressed. The item the mouse was pressed on is specified by index. The signal is only emitted when the index is valid.

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

C++ documentation:

This signal is emitted when a mouse button is pressed. The item the mouse was pressed on is specified by index. The signal is only emitted when the index is valid.

Use the QApplication::mouseButtons() function to get the state of the mouse buttons.

See also activated(), clicked(), doubleClicked(), and entered().

pub fn clicked(&self) -> Signal<(*const QModelIndex,)>

This signal is emitted when a mouse button is left-clicked. The item the mouse was clicked on is specified by index. The signal is only emitted when the index is valid.

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

C++ documentation:

This signal is emitted when a mouse button is left-clicked. The item the mouse was clicked on is specified by index. The signal is only emitted when the index is valid.

See also activated(), doubleClicked(), entered(), and pressed().

pub fn double_clicked(&self) -> Signal<(*const QModelIndex,)>

This signal is emitted when a mouse button is double-clicked. The item the mouse was double-clicked on is specified by index. The signal is only emitted when the index is valid.

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

C++ documentation:

This signal is emitted when a mouse button is double-clicked. The item the mouse was double-clicked on is specified by index. The signal is only emitted when the index is valid.

See also clicked() and activated().

pub fn activated(&self) -> Signal<(*const QModelIndex,)>

This signal is emitted when the item specified by index is activated by the user. How to activate items depends on the platform; e.g., by single- or double-clicking the item, or by pressing the Return or Enter key when the item is current.

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

C++ documentation:

This signal is emitted when the item specified by index is activated by the user. How to activate items depends on the platform; e.g., by single- or double-clicking the item, or by pressing the Return or Enter key when the item is current.

See also clicked(), doubleClicked(), entered(), and pressed().

pub fn entered(&self) -> Signal<(*const QModelIndex,)>

This signal is emitted when the mouse cursor enters the item specified by index. Mouse tracking needs to be enabled for this feature to work.

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

C++ documentation:

This signal is emitted when the mouse cursor enters the item specified by index. Mouse tracking needs to be enabled for this feature to work.

See also viewportEntered(), activated(), clicked(), doubleClicked(), and pressed().

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

This signal is emitted when the mouse cursor enters the viewport. Mouse tracking needs to be enabled for this feature to work.

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

C++ documentation:

This signal is emitted when the mouse cursor enters the viewport. Mouse tracking needs to be enabled for this feature to work.

See also entered().

pub fn icon_size_changed(&self) -> Signal<(*const QSize,)>

This property holds the size of items' icons

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

C++ documentation:

This property holds the size of items’ icons

Setting this property when the view is visible will cause the items to be laid out again.

Access functions:

QSize	iconSize() const
void	setIconSize(const QSize &size)

Notifier signal:

void	iconSizeChanged(const QSize &size)

pub unsafe fn alternating_row_colors(&self) -> bool

This property holds whether to draw the background using alternating colors

Calls C++ function: bool QAbstractItemView::alternatingRowColors() const.

C++ documentation:

This property holds whether to draw the background using alternating colors

If this property is true, the item background will be drawn using QPalette::Base and QPalette::AlternateBase; otherwise the background will be drawn using the QPalette::Base color.

By default, this property is false.

Access functions:

bool	alternatingRowColors() const
void	setAlternatingRowColors(bool enable)

pub unsafe fn auto_scroll_margin(&self) -> c_int

This property holds the size of the area when auto scrolling is triggered

Calls C++ function: int QAbstractItemView::autoScrollMargin() const.

C++ documentation:

This property holds the size of the area when auto scrolling is triggered

This property controls the size of the area at the edge of the viewport that triggers autoscrolling. The default value is 16 pixels.

This property was introduced in Qt 4.4.

Access functions:

int	autoScrollMargin() const
void	setAutoScrollMargin(int margin)

pub unsafe fn clear_selection(&self)

Deselects all selected items. The current index will not be changed.

Calls C++ function: [slot] void QAbstractItemView::clearSelection().

C++ documentation:

Deselects all selected items. The current index will not be changed.

See also setSelection() and selectAll().

pub unsafe fn close_persistent_editor( &self, index: impl CastInto<Ref<QModelIndex>>, )

Closes the persistent editor for the item at the given index.

Calls C++ function: void QAbstractItemView::closePersistentEditor(const QModelIndex& index).

C++ documentation:

Closes the persistent editor for the item at the given index.

See also openPersistentEditor().

pub unsafe fn current_index(&self) -> CppBox<QModelIndex>

Returns the model index of the current item.

Calls C++ function: QModelIndex QAbstractItemView::currentIndex() const.

C++ documentation:

Returns the model index of the current item.

See also setCurrentIndex().

pub unsafe fn default_drop_action(&self) -> DropAction

This property holds the drop action that will be used by default in QAbstractItemView::drag()

Calls C++ function: Qt::DropAction QAbstractItemView::defaultDropAction() const.

C++ documentation:

This property holds the drop action that will be used by default in QAbstractItemView::drag()

If the property is not set, the drop action is CopyAction when the supported actions support CopyAction.

This property was introduced in Qt 4.6.

Access functions:

Qt::DropAction	defaultDropAction() const
void	setDefaultDropAction(Qt::DropAction dropAction)

See also showDropIndicator and dragDropOverwriteMode.

pub unsafe fn do_items_layout(&self)

Calls C++ function: virtual [slot] void QAbstractItemView::doItemsLayout().

pub unsafe fn drag_drop_mode(&self) -> DragDropMode

This property holds the drag and drop event the view will act upon

Calls C++ function: QAbstractItemView::DragDropMode QAbstractItemView::dragDropMode() const.

C++ documentation:

This property holds the drag and drop event the view will act upon

This property was introduced in Qt 4.2.

Access functions:

DragDropMode	dragDropMode() const
void	setDragDropMode(DragDropMode behavior)

See also showDropIndicator and dragDropOverwriteMode.

pub unsafe fn drag_drop_overwrite_mode(&self) -> bool

This property holds the view's drag and drop behavior

Calls C++ function: bool QAbstractItemView::dragDropOverwriteMode() const.

C++ documentation:

This property holds the view’s drag and drop behavior

If its value is true, the selected data will overwrite the existing item data when dropped, while moving the data will clear the item. If its value is false, the selected data will be inserted as a new item when the data is dropped. When the data is moved, the item is removed as well.

The default value is false, as in the QListView and QTreeView subclasses. In the QTableView subclass, on the other hand, the property has been set to true.

Note: This is not intended to prevent overwriting of items. The model's implementation of flags() should do that by not returning Qt::ItemIsDropEnabled.

This property was introduced in Qt 4.2.

Access functions:

bool	dragDropOverwriteMode() const
void	setDragDropOverwriteMode(bool overwrite)

See also dragDropMode.

pub unsafe fn drag_enabled(&self) -> bool

This property holds whether the view supports dragging of its own items

Calls C++ function: bool QAbstractItemView::dragEnabled() const.

C++ documentation:

This property holds whether the view supports dragging of its own items

Access functions:

bool	dragEnabled() const
void	setDragEnabled(bool enable)

See also showDropIndicator, DragDropMode, dragDropOverwriteMode, and acceptDrops.

pub unsafe fn edit(&self, index: impl CastInto<Ref<QModelIndex>>)

Starts editing the item corresponding to the given index if it is editable.

Calls C++ function: [slot] void QAbstractItemView::edit(const QModelIndex& index).

C++ documentation:

Starts editing the item corresponding to the given index if it is editable.

Note that this function does not change the current index. Since the current index defines the next and previous items to edit, users may find that keyboard navigation does not work as expected. To provide consistent navigation behavior, call setCurrentIndex() before this function with the same model index.

See also QModelIndex::flags().

pub unsafe fn edit_triggers(&self) -> QFlags<EditTrigger>

This property holds which actions will initiate item editing

Calls C++ function: QFlags<QAbstractItemView::EditTrigger> QAbstractItemView::editTriggers() const.

C++ documentation:

This property holds which actions will initiate item editing

This property is a selection of flags defined by EditTrigger, combined using the OR operator. The view will only initiate the editing of an item if the action performed is set in this property.

Access functions:

EditTriggers	editTriggers() const
void	setEditTriggers(EditTriggers triggers)

pub unsafe fn has_auto_scroll(&self) -> bool

This property holds whether autoscrolling in drag move events is enabled

Calls C++ function: bool QAbstractItemView::hasAutoScroll() const.

C++ documentation:

This property holds whether autoscrolling in drag move events is enabled

If this property is set to true (the default), the QAbstractItemView automatically scrolls the contents of the view if the user drags within 16 pixels of the viewport edge. If the current item changes, then the view will scroll automatically to ensure that the current item is fully visible.

This property only works if the viewport accepts drops. Autoscroll is switched off by setting this property to false.

Access functions:

bool	hasAutoScroll() const
void	setAutoScroll(bool enable)

pub unsafe fn horizontal_scroll_mode(&self) -> ScrollMode

how the view scrolls its contents in the horizontal direction

Calls C++ function: QAbstractItemView::ScrollMode QAbstractItemView::horizontalScrollMode() const.

C++ documentation:

how the view scrolls its contents in the horizontal direction

This property controls how the view scroll its contents horizontally. Scrolling can be done either per pixel or per item. Its default value comes from the style via the QStyle::SH_ItemView_ScrollMode style hint.

This property was introduced in Qt 4.2.

Access functions:

ScrollMode	horizontalScrollMode() const
void	setHorizontalScrollMode(ScrollMode mode)
void	resetHorizontalScrollMode()

pub unsafe fn icon_size(&self) -> CppBox<QSize>

This property holds the size of items' icons

Calls C++ function: QSize QAbstractItemView::iconSize() const.

C++ documentation:

This property holds the size of items’ icons

Setting this property when the view is visible will cause the items to be laid out again.

Access functions:

QSize	iconSize() const
void	setIconSize(const QSize &size)

Notifier signal:

void	iconSizeChanged(const QSize &size)

pub unsafe fn index_at( &self, point: impl CastInto<Ref<QPoint>>, ) -> CppBox<QModelIndex>

Returns the model index of the item at the viewport coordinates point.

Calls C++ function: pure virtual QModelIndex QAbstractItemView::indexAt(const QPoint& point) const.

C++ documentation:

Returns the model index of the item at the viewport coordinates point.

In the base class this is a pure virtual function.

See also visualRect().

pub unsafe fn index_widget( &self, index: impl CastInto<Ref<QModelIndex>>, ) -> QPtr<QWidget>

Returns the widget for the item at the given index.

Calls C++ function: QWidget* QAbstractItemView::indexWidget(const QModelIndex& index) const.

C++ documentation:

Returns the widget for the item at the given index.

This function was introduced in Qt 4.1.

See also setIndexWidget().

pub unsafe fn input_method_query( &self, query: InputMethodQuery, ) -> CppBox<QVariant>

Reimplemented from QWidget::inputMethodQuery().

Calls C++ function: virtual QVariant QAbstractItemView::inputMethodQuery(Qt::InputMethodQuery query) const.

C++ documentation:

Reimplemented from QWidget::inputMethodQuery().

pub unsafe fn is_persistent_editor_open( &self, index: impl CastInto<Ref<QModelIndex>>, ) -> 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.

Returns whether a persistent editor is open for the item at index index.

Calls C++ function: bool QAbstractItemView::isPersistentEditorOpen(const QModelIndex& index) const.

C++ documentation:

Returns whether a persistent editor is open for the item at index index.

This function was introduced in Qt 5.10.

See also openPersistentEditor() and closePersistentEditor().

pub unsafe fn item_delegate_0a(&self) -> QPtr<QAbstractItemDelegate>

Returns the item delegate used by this view and model. This is either one set with setItemDelegate(), or the default one.

Calls C++ function: QAbstractItemDelegate* QAbstractItemView::itemDelegate() const.

C++ documentation:

Returns the item delegate used by this view and model. This is either one set with setItemDelegate(), or the default one.

See also setItemDelegate().

pub unsafe fn item_delegate_1a( &self, index: impl CastInto<Ref<QModelIndex>>, ) -> QPtr<QAbstractItemDelegate>

Returns the item delegate used by this view and model for the given index.

Calls C++ function: QAbstractItemDelegate* QAbstractItemView::itemDelegate(const QModelIndex& index) const.

C++ documentation:

Returns the item delegate used by this view and model for the given index.

pub unsafe fn item_delegate_for_column( &self, column: c_int, ) -> QPtr<QAbstractItemDelegate>

Returns the item delegate used by this view and model for the given column. You can call itemDelegate() to get a pointer to the current delegate for a given index.

Calls C++ function: QAbstractItemDelegate* QAbstractItemView::itemDelegateForColumn(int column) const.

C++ documentation:

Returns the item delegate used by this view and model for the given column. You can call itemDelegate() to get a pointer to the current delegate for a given index.

This function was introduced in Qt 4.2.

See also setItemDelegateForColumn(), itemDelegateForRow(), and itemDelegate().

pub unsafe fn item_delegate_for_row( &self, row: c_int, ) -> QPtr<QAbstractItemDelegate>

Returns the item delegate used by this view and model for the given row, or 0 if no delegate has been assigned. You can call itemDelegate() to get a pointer to the current delegate for a given index.

Calls C++ function: QAbstractItemDelegate* QAbstractItemView::itemDelegateForRow(int row) const.

C++ documentation:

Returns the item delegate used by this view and model for the given row, or 0 if no delegate has been assigned. You can call itemDelegate() to get a pointer to the current delegate for a given index.

This function was introduced in Qt 4.2.

See also setItemDelegateForRow(), itemDelegateForColumn(), and setItemDelegate().

pub unsafe fn keyboard_search(&self, search: impl CastInto<Ref<QString>>)

Moves to and selects the item best matching the string search. If no item is found nothing happens.

Calls C++ function: virtual void QAbstractItemView::keyboardSearch(const QString& search).

C++ documentation:

Moves to and selects the item best matching the string search. If no item is found nothing happens.

In the default implementation, the search is reset if search is empty, or the time interval since the last search has exceeded QApplication::keyboardInputInterval().

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

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

pub unsafe fn model(&self) -> QPtr<QAbstractItemModel>

Returns the model that this view is presenting.

Calls C++ function: QAbstractItemModel* QAbstractItemView::model() const.

C++ documentation:

Returns the model that this view is presenting.

See also setModel().

pub unsafe fn open_persistent_editor( &self, index: impl CastInto<Ref<QModelIndex>>, )

Opens a persistent editor on the item at the given index. If no editor exists, the delegate will create a new editor.

Calls C++ function: void QAbstractItemView::openPersistentEditor(const QModelIndex& index).

C++ documentation:

Opens a persistent editor on the item at the given index. If no editor exists, the delegate will create a new editor.

See also closePersistentEditor().

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

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

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

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

pub unsafe fn reset(&self)

Reset the internal state of the view.

Calls C++ function: virtual [slot] void QAbstractItemView::reset().

C++ documentation:

Reset the internal state of the view.

Warning: This function will reset open editors, scroll bar positions, selections, etc. Existing changes will not be committed. If you would like to save your changes when resetting the view, you can reimplement this function, commit your changes, and then call the superclass' implementation.

pub unsafe fn reset_horizontal_scroll_mode(&self)

how the view scrolls its contents in the horizontal direction

Calls C++ function: void QAbstractItemView::resetHorizontalScrollMode().

C++ documentation:

how the view scrolls its contents in the horizontal direction

This property controls how the view scroll its contents horizontally. Scrolling can be done either per pixel or per item. Its default value comes from the style via the QStyle::SH_ItemView_ScrollMode style hint.

This property was introduced in Qt 4.2.

Access functions:

ScrollMode	horizontalScrollMode() const
void	setHorizontalScrollMode(ScrollMode mode)
void	resetHorizontalScrollMode()

pub unsafe fn reset_vertical_scroll_mode(&self)

how the view scrolls its contents in the vertical direction

Calls C++ function: void QAbstractItemView::resetVerticalScrollMode().

C++ documentation:

how the view scrolls its contents in the vertical direction

This property controls how the view scroll its contents vertically. Scrolling can be done either per pixel or per item. Its default value comes from the style via the QStyle::SH_ItemView_ScrollMode style hint.

This property was introduced in Qt 4.2.

Access functions:

ScrollMode	verticalScrollMode() const
void	setVerticalScrollMode(ScrollMode mode)
void	resetVerticalScrollMode()

pub unsafe fn root_index(&self) -> CppBox<QModelIndex>

Returns the model index of the model's root item. The root item is the parent item to the view's toplevel items. The root can be invalid.

Calls C++ function: QModelIndex QAbstractItemView::rootIndex() const.

C++ documentation:

Returns the model index of the model’s root item. The root item is the parent item to the view’s toplevel items. The root can be invalid.

See also setRootIndex().

pub unsafe fn scroll_to_2a( &self, index: impl CastInto<Ref<QModelIndex>>, hint: ScrollHint, )

Scrolls the view if necessary to ensure that the item at index is visible. The view will try to position the item according to the given hint.

Calls C++ function: pure virtual void QAbstractItemView::scrollTo(const QModelIndex& index, QAbstractItemView::ScrollHint hint = …).

C++ documentation:

Scrolls the view if necessary to ensure that the item at index is visible. The view will try to position the item according to the given hint.

In the base class this is a pure virtual function.

pub unsafe fn scroll_to_1a(&self, index: impl CastInto<Ref<QModelIndex>>)

Scrolls the view if necessary to ensure that the item at index is visible. The view will try to position the item according to the given hint.

Calls C++ function: pure virtual void QAbstractItemView::scrollTo(const QModelIndex& index).

C++ documentation:

Scrolls the view if necessary to ensure that the item at index is visible. The view will try to position the item according to the given hint.

In the base class this is a pure virtual function.

pub unsafe fn scroll_to_bottom(&self)

Scrolls the view to the bottom.

Calls C++ function: [slot] void QAbstractItemView::scrollToBottom().

C++ documentation:

Scrolls the view to the bottom.

This function was introduced in Qt 4.1.

See also scrollTo() and scrollToTop().

pub unsafe fn scroll_to_top(&self)

Scrolls the view to the top.

Calls C++ function: [slot] void QAbstractItemView::scrollToTop().

C++ documentation:

Scrolls the view to the top.

This function was introduced in Qt 4.1.

See also scrollTo() and scrollToBottom().

pub unsafe fn select_all(&self)

Selects all items in the view. This function will use the selection behavior set on the view when selecting.

Calls C++ function: virtual [slot] void QAbstractItemView::selectAll().

C++ documentation:

Selects all items in the view. This function will use the selection behavior set on the view when selecting.

See also setSelection(), selectedIndexes(), and clearSelection().

pub unsafe fn selection_behavior(&self) -> SelectionBehavior

This property holds which selection behavior the view uses

Calls C++ function: QAbstractItemView::SelectionBehavior QAbstractItemView::selectionBehavior() const.

C++ documentation:

This property holds which selection behavior the view uses

This property holds whether selections are done in terms of single items, rows or columns.

Access functions:

QAbstractItemView::SelectionBehavior	selectionBehavior() const
void	setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior)

See also SelectionMode and SelectionBehavior.

pub unsafe fn selection_mode(&self) -> SelectionMode

This property holds which selection mode the view operates in

Calls C++ function: QAbstractItemView::SelectionMode QAbstractItemView::selectionMode() const.

C++ documentation:

This property holds which selection mode the view operates in

This property controls whether the user can select one or many items and, in many-item selections, whether the selection must be a continuous range of items.

Access functions:

QAbstractItemView::SelectionMode	selectionMode() const
void	setSelectionMode(QAbstractItemView::SelectionMode mode)

See also SelectionMode and SelectionBehavior.

pub unsafe fn selection_model(&self) -> QPtr<QItemSelectionModel>

Returns the current selection model.

Calls C++ function: QItemSelectionModel* QAbstractItemView::selectionModel() const.

C++ documentation:

Returns the current selection model.

See also setSelectionModel() and selectedIndexes().

pub unsafe fn set_alternating_row_colors(&self, enable: bool)

This property holds whether to draw the background using alternating colors

Calls C++ function: void QAbstractItemView::setAlternatingRowColors(bool enable).

C++ documentation:

This property holds whether to draw the background using alternating colors

If this property is true, the item background will be drawn using QPalette::Base and QPalette::AlternateBase; otherwise the background will be drawn using the QPalette::Base color.

By default, this property is false.

Access functions:

bool	alternatingRowColors() const
void	setAlternatingRowColors(bool enable)

pub unsafe fn set_auto_scroll(&self, enable: bool)

This property holds whether autoscrolling in drag move events is enabled

Calls C++ function: void QAbstractItemView::setAutoScroll(bool enable).

C++ documentation:

This property holds whether autoscrolling in drag move events is enabled

If this property is set to true (the default), the QAbstractItemView automatically scrolls the contents of the view if the user drags within 16 pixels of the viewport edge. If the current item changes, then the view will scroll automatically to ensure that the current item is fully visible.

This property only works if the viewport accepts drops. Autoscroll is switched off by setting this property to false.

Access functions:

bool	hasAutoScroll() const
void	setAutoScroll(bool enable)

pub unsafe fn set_auto_scroll_margin(&self, margin: c_int)

This property holds the size of the area when auto scrolling is triggered

Calls C++ function: void QAbstractItemView::setAutoScrollMargin(int margin).

C++ documentation:

This property holds the size of the area when auto scrolling is triggered

This property controls the size of the area at the edge of the viewport that triggers autoscrolling. The default value is 16 pixels.

This property was introduced in Qt 4.4.

Access functions:

int	autoScrollMargin() const
void	setAutoScrollMargin(int margin)

pub unsafe fn set_current_index(&self, index: impl CastInto<Ref<QModelIndex>>)

Sets the current item to be the item at index.

Calls C++ function: [slot] void QAbstractItemView::setCurrentIndex(const QModelIndex& index).

C++ documentation:

Sets the current item to be the item at index.

Unless the current selection mode is NoSelection, the item is also selected. Note that this function also updates the starting position for any new selections the user performs.

To set an item as the current item without selecting it, call

selectionModel()->setCurrentIndex(index, QItemSelectionModel::NoUpdate);

See also currentIndex(), currentChanged(), and selectionMode.

pub unsafe fn set_default_drop_action(&self, drop_action: DropAction)

This property holds the drop action that will be used by default in QAbstractItemView::drag()

Calls C++ function: void QAbstractItemView::setDefaultDropAction(Qt::DropAction dropAction).

C++ documentation:

This property holds the drop action that will be used by default in QAbstractItemView::drag()

If the property is not set, the drop action is CopyAction when the supported actions support CopyAction.

This property was introduced in Qt 4.6.

Access functions:

Qt::DropAction	defaultDropAction() const
void	setDefaultDropAction(Qt::DropAction dropAction)

See also showDropIndicator and dragDropOverwriteMode.

pub unsafe fn set_drag_drop_mode(&self, behavior: DragDropMode)

This property holds the drag and drop event the view will act upon

Calls C++ function: void QAbstractItemView::setDragDropMode(QAbstractItemView::DragDropMode behavior).

C++ documentation:

This property holds the drag and drop event the view will act upon

This property was introduced in Qt 4.2.

Access functions:

DragDropMode	dragDropMode() const
void	setDragDropMode(DragDropMode behavior)

See also showDropIndicator and dragDropOverwriteMode.

pub unsafe fn set_drag_drop_overwrite_mode(&self, overwrite: bool)

This property holds the view's drag and drop behavior

Calls C++ function: void QAbstractItemView::setDragDropOverwriteMode(bool overwrite).

C++ documentation:

This property holds the view’s drag and drop behavior

If its value is true, the selected data will overwrite the existing item data when dropped, while moving the data will clear the item. If its value is false, the selected data will be inserted as a new item when the data is dropped. When the data is moved, the item is removed as well.

The default value is false, as in the QListView and QTreeView subclasses. In the QTableView subclass, on the other hand, the property has been set to true.

Note: This is not intended to prevent overwriting of items. The model's implementation of flags() should do that by not returning Qt::ItemIsDropEnabled.

This property was introduced in Qt 4.2.

Access functions:

bool	dragDropOverwriteMode() const
void	setDragDropOverwriteMode(bool overwrite)

See also dragDropMode.

pub unsafe fn set_drag_enabled(&self, enable: bool)

This property holds whether the view supports dragging of its own items

Calls C++ function: void QAbstractItemView::setDragEnabled(bool enable).

C++ documentation:

This property holds whether the view supports dragging of its own items

Access functions:

bool	dragEnabled() const
void	setDragEnabled(bool enable)

See also showDropIndicator, DragDropMode, dragDropOverwriteMode, and acceptDrops.

pub unsafe fn set_drop_indicator_shown(&self, enable: bool)

This property holds whether the drop indicator is shown when dragging items and dropping.

Calls C++ function: void QAbstractItemView::setDropIndicatorShown(bool enable).

C++ documentation:

This property holds whether the drop indicator is shown when dragging items and dropping.

Access functions:

bool	showDropIndicator() const
void	setDropIndicatorShown(bool enable)

See also dragEnabled, DragDropMode, dragDropOverwriteMode, and acceptDrops.

pub unsafe fn set_edit_triggers(&self, triggers: QFlags<EditTrigger>)

This property holds which actions will initiate item editing

Calls C++ function: void QAbstractItemView::setEditTriggers(QFlags<QAbstractItemView::EditTrigger> triggers).

C++ documentation:

This property holds which actions will initiate item editing

This property is a selection of flags defined by EditTrigger, combined using the OR operator. The view will only initiate the editing of an item if the action performed is set in this property.

Access functions:

EditTriggers	editTriggers() const
void	setEditTriggers(EditTriggers triggers)

pub unsafe fn set_horizontal_scroll_mode(&self, mode: ScrollMode)

how the view scrolls its contents in the horizontal direction

Calls C++ function: void QAbstractItemView::setHorizontalScrollMode(QAbstractItemView::ScrollMode mode).

C++ documentation:

how the view scrolls its contents in the horizontal direction

This property controls how the view scroll its contents horizontally. Scrolling can be done either per pixel or per item. Its default value comes from the style via the QStyle::SH_ItemView_ScrollMode style hint.

This property was introduced in Qt 4.2.

Access functions:

ScrollMode	horizontalScrollMode() const
void	setHorizontalScrollMode(ScrollMode mode)
void	resetHorizontalScrollMode()

pub unsafe fn set_icon_size(&self, size: impl CastInto<Ref<QSize>>)

This property holds the size of items' icons

Calls C++ function: void QAbstractItemView::setIconSize(const QSize& size).

C++ documentation:

This property holds the size of items’ icons

Setting this property when the view is visible will cause the items to be laid out again.

Access functions:

QSize	iconSize() const
void	setIconSize(const QSize &size)

Notifier signal:

void	iconSizeChanged(const QSize &size)

pub unsafe fn set_index_widget( &self, index: impl CastInto<Ref<QModelIndex>>, widget: impl CastInto<Ptr<QWidget>>, )

Sets the given widget on the item at the given index, passing the ownership of the widget to the viewport.

Calls C++ function: void QAbstractItemView::setIndexWidget(const QModelIndex& index, QWidget* widget).

C++ documentation:

Sets the given widget on the item at the given index, passing the ownership of the widget to the viewport.

If index is invalid (e.g., if you pass the root index), this function will do nothing.

The given widget's autoFillBackground property must be set to true, otherwise the widget's background will be transparent, showing both the model data and the item at the given index.

If index widget A is replaced with index widget B, index widget A will be deleted. For example, in the code snippet below, the QLineEdit object will be deleted.

setIndexWidget(index, new QLineEdit);
...
setIndexWidget(index, new QTextEdit);

This function should only be used to display static content within the visible area corresponding to an item of data. If you want to display custom dynamic content or implement a custom editor widget, subclass QItemDelegate instead.

This function was introduced in Qt 4.1.

See also indexWidget() and Delegate Classes.

pub unsafe fn set_item_delegate( &self, delegate: impl CastInto<Ptr<QAbstractItemDelegate>>, )

Sets the item delegate for this view and its model to delegate. This is useful if you want complete control over the editing and display of items.

Calls C++ function: void QAbstractItemView::setItemDelegate(QAbstractItemDelegate* delegate).

C++ documentation:

Sets the item delegate for this view and its model to delegate. This is useful if you want complete control over the editing and display of items.

Any existing delegate will be removed, but not deleted. QAbstractItemView does not take ownership of delegate.

Warning: You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the closeEditor() signal, and attempt to access, modify or close an editor that has already been closed.

See also itemDelegate().

pub unsafe fn set_item_delegate_for_column( &self, column: c_int, delegate: impl CastInto<Ptr<QAbstractItemDelegate>>, )

Sets the given item delegate used by this view and model for the given column. All items on column will be drawn and managed by delegate instead of using the default delegate (i.e., itemDelegate()).

Calls C++ function: void QAbstractItemView::setItemDelegateForColumn(int column, QAbstractItemDelegate* delegate).

C++ documentation:

Sets the given item delegate used by this view and model for the given column. All items on column will be drawn and managed by delegate instead of using the default delegate (i.e., itemDelegate()).

Any existing column delegate for column will be removed, but not deleted. QAbstractItemView does not take ownership of delegate.

Note: If a delegate has been assigned to both a row and a column, the row delegate will take precedence and manage the intersecting cell index.

Warning: You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the closeEditor() signal, and attempt to access, modify or close an editor that has already been closed.

This function was introduced in Qt 4.2.

See also itemDelegateForColumn(), setItemDelegateForRow(), and itemDelegate().

pub unsafe fn set_item_delegate_for_row( &self, row: c_int, delegate: impl CastInto<Ptr<QAbstractItemDelegate>>, )

Sets the given item delegate used by this view and model for the given row. All items on row will be drawn and managed by delegate instead of using the default delegate (i.e., itemDelegate()).

Calls C++ function: void QAbstractItemView::setItemDelegateForRow(int row, QAbstractItemDelegate* delegate).

C++ documentation:

Sets the given item delegate used by this view and model for the given row. All items on row will be drawn and managed by delegate instead of using the default delegate (i.e., itemDelegate()).

Any existing row delegate for row will be removed, but not deleted. QAbstractItemView does not take ownership of delegate.

Note: If a delegate has been assigned to both a row and a column, the row delegate (i.e., this delegate) will take precedence and manage the intersecting cell index.

Warning: You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the closeEditor() signal, and attempt to access, modify or close an editor that has already been closed.

This function was introduced in Qt 4.2.

See also itemDelegateForRow(), setItemDelegateForColumn(), and itemDelegate().

pub unsafe fn set_model(&self, model: impl CastInto<Ptr<QAbstractItemModel>>)

Sets the model for the view to present.

Calls C++ function: virtual void QAbstractItemView::setModel(QAbstractItemModel* model).

C++ documentation:

Sets the model for the view to present.

This function will create and set a new selection model, replacing any model that was previously set with setSelectionModel(). However, the old selection model will not be deleted as it may be shared between several views. We recommend that you delete the old selection model if it is no longer required. This is done with the following code:

QItemSelectionModel *m = view->selectionModel();
view->setModel(new model);
delete m;

If both the old model and the old selection model do not have parents, or if their parents are long-lived objects, it may be preferable to call their deleteLater() functions to explicitly delete them.

The view does not take ownership of the model unless it is the model's parent object because the model may be shared between many different views.

See also model(), selectionModel(), and setSelectionModel().

pub unsafe fn set_root_index(&self, index: impl CastInto<Ref<QModelIndex>>)

Sets the root item to the item at the given index.

Calls C++ function: virtual [slot] void QAbstractItemView::setRootIndex(const QModelIndex& index).

C++ documentation:

Sets the root item to the item at the given index.

See also rootIndex().

pub unsafe fn set_selection_behavior(&self, behavior: SelectionBehavior)

This property holds which selection behavior the view uses

Calls C++ function: void QAbstractItemView::setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior).

C++ documentation:

This property holds which selection behavior the view uses

This property holds whether selections are done in terms of single items, rows or columns.

Access functions:

QAbstractItemView::SelectionBehavior	selectionBehavior() const
void	setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior)

See also SelectionMode and SelectionBehavior.

pub unsafe fn set_selection_mode(&self, mode: SelectionMode)

This property holds which selection mode the view operates in

Calls C++ function: void QAbstractItemView::setSelectionMode(QAbstractItemView::SelectionMode mode).

C++ documentation:

This property holds which selection mode the view operates in

This property controls whether the user can select one or many items and, in many-item selections, whether the selection must be a continuous range of items.

Access functions:

QAbstractItemView::SelectionMode	selectionMode() const
void	setSelectionMode(QAbstractItemView::SelectionMode mode)

See also SelectionMode and SelectionBehavior.

pub unsafe fn set_selection_model( &self, selection_model: impl CastInto<Ptr<QItemSelectionModel>>, )

Sets the current selection model to the given selectionModel.

Calls C++ function: virtual void QAbstractItemView::setSelectionModel(QItemSelectionModel* selectionModel).

C++ documentation:

Sets the current selection model to the given selectionModel.

Note that, if you call setModel() after this function, the given selectionModel will be replaced by one created by the view.

Note: It is up to the application to delete the old selection model if it is no longer needed; i.e., if it is not being used by other views. This will happen automatically when its parent object is deleted. However, if it does not have a parent, or if the parent is a long-lived object, it may be preferable to call its deleteLater() function to explicitly delete it.

See also selectionModel(), setModel(), and clearSelection().

pub unsafe fn set_tab_key_navigation(&self, enable: bool)

This property holds whether item navigation with tab and backtab is enabled.

Calls C++ function: void QAbstractItemView::setTabKeyNavigation(bool enable).

C++ documentation:

This property holds whether item navigation with tab and backtab is enabled.

Access functions:

bool	tabKeyNavigation() const
void	setTabKeyNavigation(bool enable)

pub unsafe fn set_text_elide_mode(&self, mode: TextElideMode)

This property holds the position of the "..." in elided text.

Calls C++ function: void QAbstractItemView::setTextElideMode(Qt::TextElideMode mode).

C++ documentation:

This property holds the position of the “…” in elided text.

The default value for all item views is Qt::ElideRight.

Access functions:

Qt::TextElideMode	textElideMode() const
void	setTextElideMode(Qt::TextElideMode mode)

pub unsafe fn set_vertical_scroll_mode(&self, mode: ScrollMode)

how the view scrolls its contents in the vertical direction

Calls C++ function: void QAbstractItemView::setVerticalScrollMode(QAbstractItemView::ScrollMode mode).

C++ documentation:

how the view scrolls its contents in the vertical direction

This property controls how the view scroll its contents vertically. Scrolling can be done either per pixel or per item. Its default value comes from the style via the QStyle::SH_ItemView_ScrollMode style hint.

This property was introduced in Qt 4.2.

Access functions:

ScrollMode	verticalScrollMode() const
void	setVerticalScrollMode(ScrollMode mode)
void	resetVerticalScrollMode()

pub unsafe fn show_drop_indicator(&self) -> bool

This property holds whether the drop indicator is shown when dragging items and dropping.

Calls C++ function: bool QAbstractItemView::showDropIndicator() const.

C++ documentation:

This property holds whether the drop indicator is shown when dragging items and dropping.

Access functions:

bool	showDropIndicator() const
void	setDropIndicatorShown(bool enable)

See also dragEnabled, DragDropMode, dragDropOverwriteMode, and acceptDrops.

pub unsafe fn size_hint_for_column(&self, column: c_int) -> c_int

Returns the width size hint for the specified column or -1 if there is no model.

Calls C++ function: virtual int QAbstractItemView::sizeHintForColumn(int column) const.

C++ documentation:

Returns the width size hint for the specified column or -1 if there is no model.

This function is used in views with a horizontal header to find the size hint for a header section based on the contents of the given column.

See also sizeHintForRow().

pub unsafe fn size_hint_for_index( &self, index: impl CastInto<Ref<QModelIndex>>, ) -> CppBox<QSize>

Returns the size hint for the item with the specified index or an invalid size for invalid indexes.

Calls C++ function: QSize QAbstractItemView::sizeHintForIndex(const QModelIndex& index) const.

C++ documentation:

Returns the size hint for the item with the specified index or an invalid size for invalid indexes.

See also sizeHintForRow() and sizeHintForColumn().

pub unsafe fn size_hint_for_row(&self, row: c_int) -> c_int

Returns the height size hint for the specified row or -1 if there is no model.

Calls C++ function: virtual int QAbstractItemView::sizeHintForRow(int row) const.

C++ documentation:

Returns the height size hint for the specified row or -1 if there is no model.

The returned height is calculated using the size hints of the given row's items, i.e. the returned value is the maximum height among the items. Note that to control the height of a row, you must reimplement the QAbstractItemDelegate::sizeHint() function.

This function is used in views with a vertical header to find the size hint for a header section based on the contents of the given row.

See also sizeHintForColumn().

pub unsafe fn tab_key_navigation(&self) -> bool

This property holds whether item navigation with tab and backtab is enabled.

Calls C++ function: bool QAbstractItemView::tabKeyNavigation() const.

C++ documentation:

This property holds whether item navigation with tab and backtab is enabled.

Access functions:

bool	tabKeyNavigation() const
void	setTabKeyNavigation(bool enable)

pub unsafe fn text_elide_mode(&self) -> TextElideMode

This property holds the position of the "..." in elided text.

Calls C++ function: Qt::TextElideMode QAbstractItemView::textElideMode() const.

C++ documentation:

This property holds the position of the “…” in elided text.

The default value for all item views is Qt::ElideRight.

Access functions:

Qt::TextElideMode	textElideMode() const
void	setTextElideMode(Qt::TextElideMode mode)

pub unsafe fn update(&self, index: impl CastInto<Ref<QModelIndex>>)

Updates the area occupied by the given index.

Calls C++ function: [slot] void QAbstractItemView::update(const QModelIndex& index).

C++ documentation:

Updates the area occupied by the given index.

This function was introduced in Qt 4.3.

pub unsafe fn vertical_scroll_mode(&self) -> ScrollMode

how the view scrolls its contents in the vertical direction

Calls C++ function: QAbstractItemView::ScrollMode QAbstractItemView::verticalScrollMode() const.

C++ documentation:

how the view scrolls its contents in the vertical direction

This property controls how the view scroll its contents vertically. Scrolling can be done either per pixel or per item. Its default value comes from the style via the QStyle::SH_ItemView_ScrollMode style hint.

This property was introduced in Qt 4.2.

Access functions:

ScrollMode	verticalScrollMode() const
void	setVerticalScrollMode(ScrollMode mode)
void	resetVerticalScrollMode()

pub unsafe fn visual_rect( &self, index: impl CastInto<Ref<QModelIndex>>, ) -> CppBox<QRect>

Returns the rectangle on the viewport occupied by the item at index.

Calls C++ function: pure virtual QRect QAbstractItemView::visualRect(const QModelIndex& index) const.

C++ documentation:

Returns the rectangle on the viewport occupied by the item at index.

If your item is displayed in several areas then visualRect should return the primary area that contains index and not the complete area that index might encompasses, touch or cause drawing.

In the base class this is a pure virtual function.

See also indexAt() and visualRegionForSelection().

Methods from Deref<Target = QAbstractScrollArea>

pub unsafe fn add_scroll_bar_widget( &self, widget: impl CastInto<Ptr<QWidget>>, alignment: QFlags<AlignmentFlag>, )

Adds widget as a scroll bar widget in the location specified by alignment.

Calls C++ function: void QAbstractScrollArea::addScrollBarWidget(QWidget* widget, QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

Adds widget as a scroll bar widget in the location specified by alignment.

Scroll bar widgets are shown next to the horizontal or vertical scroll bar, and can be placed on either side of it. If you want the scroll bar widgets to be always visible, set the scrollBarPolicy for the corresponding scroll bar to AlwaysOn.

alignment must be one of Qt::Alignleft and Qt::AlignRight, which maps to the horizontal scroll bar, or Qt::AlignTop and Qt::AlignBottom, which maps to the vertical scroll bar.

A scroll bar widget can be removed by either re-parenting the widget or deleting it. It's also possible to hide a widget with QWidget::hide()

The scroll bar widget will be resized to fit the scroll bar geometry for the current style. The following describes the case for scroll bar widgets on the horizontal scroll bar:

The height of the widget will be set to match the height of the scroll bar. To control the width of the widget, use QWidget::setMinimumWidth and QWidget::setMaximumWidth, or implement QWidget::sizeHint() and set a horizontal size policy. If you want a square widget, call QStyle::pixelMetric(QStyle::PM_ScrollBarExtent) and set the width to this value.

This function was introduced in Qt 4.2.

See also scrollBarWidgets().

pub unsafe fn corner_widget(&self) -> QPtr<QWidget>

Returns the widget in the corner between the two scroll bars.

Calls C++ function: QWidget* QAbstractScrollArea::cornerWidget() const.

C++ documentation:

Returns the widget in the corner between the two scroll bars.

By default, no corner widget is present.

This function was introduced in Qt 4.2.

See also setCornerWidget().

pub unsafe fn horizontal_scroll_bar(&self) -> QPtr<QScrollBar>

Returns the horizontal scroll bar.

Calls C++ function: QScrollBar* QAbstractScrollArea::horizontalScrollBar() const.

C++ documentation:

Returns the horizontal scroll bar.

See also setHorizontalScrollBar(), horizontalScrollBarPolicy, and verticalScrollBar().

pub unsafe fn horizontal_scroll_bar_policy(&self) -> ScrollBarPolicy

This property holds the policy for the horizontal scroll bar

Calls C++ function: Qt::ScrollBarPolicy QAbstractScrollArea::horizontalScrollBarPolicy() const.

C++ documentation:

This property holds the policy for the horizontal scroll bar

The default policy is Qt::ScrollBarAsNeeded.

Access functions:

Qt::ScrollBarPolicy	horizontalScrollBarPolicy() const
void	setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy)

See also verticalScrollBarPolicy.

pub unsafe fn maximum_viewport_size(&self) -> CppBox<QSize>

Returns the size of the viewport as if the scroll bars had no valid scrolling range.

Calls C++ function: QSize QAbstractScrollArea::maximumViewportSize() const.

C++ documentation:

Returns the size of the viewport as if the scroll bars had no valid scrolling range.

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

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

pub unsafe fn minimum_size_hint(&self) -> CppBox<QSize>

Reimplemented from QWidget::minimumSizeHint().

Calls C++ function: virtual QSize QAbstractScrollArea::minimumSizeHint() const.

C++ documentation:

Reimplemented from QWidget::minimumSizeHint().

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

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

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

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

pub unsafe fn scroll_bar_widgets( &self, alignment: QFlags<AlignmentFlag>, ) -> CppBox<QListOfQWidget>

Returns a list of the currently set scroll bar widgets. alignment can be any combination of the four location flags.

Calls C++ function: QList<QWidget*> QAbstractScrollArea::scrollBarWidgets(QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

Returns a list of the currently set scroll bar widgets. alignment can be any combination of the four location flags.

This function was introduced in Qt 4.2.

See also addScrollBarWidget().

pub unsafe fn set_corner_widget(&self, widget: impl CastInto<Ptr<QWidget>>)

Sets the widget in the corner between the two scroll bars to be widget.

Calls C++ function: void QAbstractScrollArea::setCornerWidget(QWidget* widget).

C++ documentation:

Sets the widget in the corner between the two scroll bars to be widget.

You will probably also want to set at least one of the scroll bar modes to AlwaysOn.

Passing 0 shows no widget in the corner.

Any previous corner widget is hidden.

You may call setCornerWidget() with the same widget at different times.

All widgets set here will be deleted by the scroll area when it is destroyed unless you separately reparent the widget after setting some other corner widget (or 0).

Any newly set widget should have no current parent.

By default, no corner widget is present.

This function was introduced in Qt 4.2.

See also cornerWidget(), horizontalScrollBarPolicy, and horizontalScrollBarPolicy.

pub unsafe fn set_horizontal_scroll_bar( &self, scrollbar: impl CastInto<Ptr<QScrollBar>>, )

Replaces the existing horizontal scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. The former scroll bar is then deleted.

Calls C++ function: void QAbstractScrollArea::setHorizontalScrollBar(QScrollBar* scrollbar).

C++ documentation:

Replaces the existing horizontal scroll bar with scrollBar, and sets all the former scroll bar’s slider properties on the new scroll bar. The former scroll bar is then deleted.

QAbstractScrollArea already provides horizontal and vertical scroll bars by default. You can call this function to replace the default horizontal scroll bar with your own custom scroll bar.

This function was introduced in Qt 4.2.

See also horizontalScrollBar() and setVerticalScrollBar().

pub unsafe fn set_horizontal_scroll_bar_policy(&self, arg1: ScrollBarPolicy)

This property holds the policy for the horizontal scroll bar

Calls C++ function: void QAbstractScrollArea::setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy arg1).

C++ documentation:

This property holds the policy for the horizontal scroll bar

The default policy is Qt::ScrollBarAsNeeded.

Access functions:

Qt::ScrollBarPolicy	horizontalScrollBarPolicy() const
void	setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy)

See also verticalScrollBarPolicy.

pub unsafe fn set_size_adjust_policy(&self, policy: SizeAdjustPolicy)

This property holds the policy describing how the size of the scroll area changes when the size of the viewport changes.

Calls C++ function: void QAbstractScrollArea::setSizeAdjustPolicy(QAbstractScrollArea::SizeAdjustPolicy policy).

C++ documentation:

This property holds the policy describing how the size of the scroll area changes when the size of the viewport changes.

The default policy is QAbstractScrollArea::AdjustIgnored. Changing this property might actually resize the scrollarea.

This property was introduced in Qt 5.2.

Access functions:

SizeAdjustPolicy	sizeAdjustPolicy() const
void	setSizeAdjustPolicy(SizeAdjustPolicy policy)

pub unsafe fn set_vertical_scroll_bar( &self, scrollbar: impl CastInto<Ptr<QScrollBar>>, )

Replaces the existing vertical scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. The former scroll bar is then deleted.

Calls C++ function: void QAbstractScrollArea::setVerticalScrollBar(QScrollBar* scrollbar).

C++ documentation:

Replaces the existing vertical scroll bar with scrollBar, and sets all the former scroll bar’s slider properties on the new scroll bar. The former scroll bar is then deleted.

QAbstractScrollArea already provides vertical and horizontal scroll bars by default. You can call this function to replace the default vertical scroll bar with your own custom scroll bar.

This function was introduced in Qt 4.2.

See also verticalScrollBar() and setHorizontalScrollBar().

pub unsafe fn set_vertical_scroll_bar_policy(&self, arg1: ScrollBarPolicy)

This property holds the policy for the vertical scroll bar

Calls C++ function: void QAbstractScrollArea::setVerticalScrollBarPolicy(Qt::ScrollBarPolicy arg1).

C++ documentation:

This property holds the policy for the vertical scroll bar

The default policy is Qt::ScrollBarAsNeeded.

Access functions:

Qt::ScrollBarPolicy	verticalScrollBarPolicy() const
void	setVerticalScrollBarPolicy(Qt::ScrollBarPolicy)

See also horizontalScrollBarPolicy.

pub unsafe fn set_viewport(&self, widget: impl CastInto<Ptr<QWidget>>)

Sets the viewport to be the given widget. The QAbstractScrollArea will take ownership of the given widget.

Calls C++ function: void QAbstractScrollArea::setViewport(QWidget* widget).

C++ documentation:

Sets the viewport to be the given widget. The QAbstractScrollArea will take ownership of the given widget.

If widget is 0, QAbstractScrollArea will assign a new QWidget instance for the viewport.

This function was introduced in Qt 4.2.

See also viewport().

pub unsafe fn setup_viewport(&self, viewport: impl CastInto<Ptr<QWidget>>)

This slot is called by QAbstractScrollArea after setViewport(viewport) has been called. Reimplement this function in a subclass of QAbstractScrollArea to initialize the new viewport before it is used.

Calls C++ function: virtual void QAbstractScrollArea::setupViewport(QWidget* viewport).

C++ documentation:

This slot is called by QAbstractScrollArea after setViewport(viewport) has been called. Reimplement this function in a subclass of QAbstractScrollArea to initialize the new viewport before it is used.

See also setViewport().

pub unsafe fn size_adjust_policy(&self) -> SizeAdjustPolicy

This property holds the policy describing how the size of the scroll area changes when the size of the viewport changes.

Calls C++ function: QAbstractScrollArea::SizeAdjustPolicy QAbstractScrollArea::sizeAdjustPolicy() const.

C++ documentation:

This property holds the policy describing how the size of the scroll area changes when the size of the viewport changes.

The default policy is QAbstractScrollArea::AdjustIgnored. Changing this property might actually resize the scrollarea.

This property was introduced in Qt 5.2.

Access functions:

SizeAdjustPolicy	sizeAdjustPolicy() const
void	setSizeAdjustPolicy(SizeAdjustPolicy policy)

pub unsafe fn size_hint(&self) -> CppBox<QSize>

Reimplemented from QWidget::sizeHint().

Calls C++ function: virtual QSize QAbstractScrollArea::sizeHint() const.

C++ documentation:

Reimplemented from QWidget::sizeHint().

Returns the sizeHint property of the scroll area. The size is determined by using viewportSizeHint() plus some extra space for scroll bars, if needed.

pub unsafe fn vertical_scroll_bar(&self) -> QPtr<QScrollBar>

Returns the vertical scroll bar.

Calls C++ function: QScrollBar* QAbstractScrollArea::verticalScrollBar() const.

C++ documentation:

Returns the vertical scroll bar.

See also setVerticalScrollBar(), verticalScrollBarPolicy, and horizontalScrollBar().

pub unsafe fn vertical_scroll_bar_policy(&self) -> ScrollBarPolicy

This property holds the policy for the vertical scroll bar

Calls C++ function: Qt::ScrollBarPolicy QAbstractScrollArea::verticalScrollBarPolicy() const.

C++ documentation:

This property holds the policy for the vertical scroll bar

The default policy is Qt::ScrollBarAsNeeded.

Access functions:

Qt::ScrollBarPolicy	verticalScrollBarPolicy() const
void	setVerticalScrollBarPolicy(Qt::ScrollBarPolicy)

See also horizontalScrollBarPolicy.

pub unsafe fn viewport(&self) -> QPtr<QWidget>

Returns the viewport widget.

Calls C++ function: QWidget* QAbstractScrollArea::viewport() const.

C++ documentation:

Returns the viewport widget.

Use the QScrollArea::widget() function to retrieve the contents of the viewport widget.

See also setViewport() and QScrollArea::widget().

Methods from Deref<Target = QFrame>

pub unsafe fn frame_rect(&self) -> CppBox<QRect>

This property holds the frame's rectangle

Calls C++ function: QRect QFrame::frameRect() const.

C++ documentation:

This property holds the frame’s rectangle

The frame's rectangle is the rectangle the frame is drawn in. By default, this is the entire widget. Setting the rectangle does does not cause a widget update. The frame rectangle is automatically adjusted when the widget changes size.

If you set the rectangle to a null rectangle (for example, QRect(0, 0, 0, 0)), then the resulting frame rectangle is equivalent to the widget rectangle.

Access functions:

QRect	frameRect() const
void	setFrameRect(const QRect &)

pub unsafe fn frame_shadow(&self) -> Shadow

This property holds the frame shadow value from the frame style

Calls C++ function: QFrame::Shadow QFrame::frameShadow() const.

C++ documentation:

This property holds the frame shadow value from the frame style

Access functions:

Shadow	frameShadow() const
void	setFrameShadow(Shadow)

See also frameStyle() and frameShape().

pub unsafe fn frame_shape(&self) -> Shape

This property holds the frame shape value from the frame style

Calls C++ function: QFrame::Shape QFrame::frameShape() const.

C++ documentation:

This property holds the frame shape value from the frame style

Access functions:

Shape	frameShape() const
void	setFrameShape(Shape)

See also frameStyle() and frameShadow().

pub unsafe fn frame_style(&self) -> c_int

Returns the frame style.

Calls C++ function: int QFrame::frameStyle() const.

C++ documentation:

Returns the frame style.

The default value is QFrame::Plain.

See also setFrameStyle(), frameShape(), and frameShadow().

pub unsafe fn frame_width(&self) -> c_int

This property holds the width of the frame that is drawn.

Calls C++ function: int QFrame::frameWidth() const.

C++ documentation:

This property holds the width of the frame that is drawn.

Note that the frame width depends on the frame style, not only the line width and the mid-line width. For example, the style specified by NoFrame always has a frame width of 0, whereas the style Panel has a frame width equivalent to the line width.

Access functions:

int	frameWidth() const

See also lineWidth(), midLineWidth(), and frameStyle().

pub unsafe fn line_width(&self) -> c_int

This property holds the line width

Calls C++ function: int QFrame::lineWidth() const.

C++ documentation:

This property holds the line width

Note that the total line width for frames used as separators (HLine and VLine) is specified by frameWidth.

The default value is 1.

Access functions:

int	lineWidth() const
void	setLineWidth(int)

See also midLineWidth and frameWidth.

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

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

pub unsafe fn mid_line_width(&self) -> c_int

This property holds the width of the mid-line

Calls C++ function: int QFrame::midLineWidth() const.

C++ documentation:

This property holds the width of the mid-line

The default value is 0.

Access functions:

int	midLineWidth() const
void	setMidLineWidth(int)

See also lineWidth and frameWidth.

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

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

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

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

pub unsafe fn set_frame_rect(&self, arg1: impl CastInto<Ref<QRect>>)

This property holds the frame's rectangle

Calls C++ function: void QFrame::setFrameRect(const QRect& arg1).

C++ documentation:

This property holds the frame’s rectangle

The frame's rectangle is the rectangle the frame is drawn in. By default, this is the entire widget. Setting the rectangle does does not cause a widget update. The frame rectangle is automatically adjusted when the widget changes size.

If you set the rectangle to a null rectangle (for example, QRect(0, 0, 0, 0)), then the resulting frame rectangle is equivalent to the widget rectangle.

Access functions:

QRect	frameRect() const
void	setFrameRect(const QRect &)

pub unsafe fn set_frame_shadow(&self, arg1: Shadow)

This property holds the frame shadow value from the frame style

Calls C++ function: void QFrame::setFrameShadow(QFrame::Shadow arg1).

C++ documentation:

This property holds the frame shadow value from the frame style

Access functions:

Shadow	frameShadow() const
void	setFrameShadow(Shadow)

See also frameStyle() and frameShape().

pub unsafe fn set_frame_shape(&self, arg1: Shape)

This property holds the frame shape value from the frame style

Calls C++ function: void QFrame::setFrameShape(QFrame::Shape arg1).

C++ documentation:

This property holds the frame shape value from the frame style

Access functions:

Shape	frameShape() const
void	setFrameShape(Shape)

See also frameStyle() and frameShadow().

pub unsafe fn set_frame_style(&self, arg1: c_int)

Sets the frame style to style.

Calls C++ function: void QFrame::setFrameStyle(int arg1).

C++ documentation:

Sets the frame style to style.

The style is the bitwise OR between a frame shape and a frame shadow style. See the picture of the frames in the main class documentation.

The frame shapes are given in QFrame::Shape and the shadow styles in QFrame::Shadow.

If a mid-line width greater than 0 is specified, an additional line is drawn for Raised or Sunken Box, HLine, and VLine frames. The mid-color of the current color group is used for drawing middle lines.

See also frameStyle().

pub unsafe fn set_line_width(&self, arg1: c_int)

This property holds the line width

Calls C++ function: void QFrame::setLineWidth(int arg1).

C++ documentation:

This property holds the line width

Note that the total line width for frames used as separators (HLine and VLine) is specified by frameWidth.

The default value is 1.

Access functions:

int	lineWidth() const
void	setLineWidth(int)

See also midLineWidth and frameWidth.

pub unsafe fn set_mid_line_width(&self, arg1: c_int)

This property holds the width of the mid-line

Calls C++ function: void QFrame::setMidLineWidth(int arg1).

C++ documentation:

This property holds the width of the mid-line

The default value is 0.

Access functions:

int	midLineWidth() const
void	setMidLineWidth(int)

See also lineWidth and frameWidth.

pub unsafe fn size_hint(&self) -> CppBox<QSize>

Reimplemented from QWidget::sizeHint().

Calls C++ function: virtual QSize QFrame::sizeHint() const.

C++ documentation:

Reimplemented from QWidget::sizeHint().

Methods from Deref<Target = QWidget>

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

This property holds whether the widget is enabled

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

C++ documentation:

This property holds whether the widget is enabled

In general an enabled widget handles keyboard and mouse events; a disabled widget does not. An exception is made with QAbstractButton.

Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can use the changeEvent() with type QEvent::EnabledChange.

Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. It it not possible to explicitly enable a child widget which is not a window while its parent widget remains disabled.

By default, this property is true.

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

See also isEnabledTo(), QKeyEvent, QMouseEvent, and changeEvent().

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

Disables widget input events if disable is true; otherwise enables input events.

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

C++ documentation:

Disables widget input events if disable is true; otherwise enables input events.

See the enabled documentation for more information.

See also isEnabledTo(), QKeyEvent, QMouseEvent, and changeEvent().

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

This property holds whether the document shown in the window has unsaved changes

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

C++ documentation:

This property holds whether the document shown in the window has unsaved changes

A modified window is a window whose content has changed but has not been saved to disk. This flag will have different effects varied by the platform. On macOS the close button will have a modified look; on other platforms, the window title will have an '*' (asterisk).

The window title must contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the window isn't modified, the placeholder is simply removed.

Note that if a widget is set as modified, all its ancestors will also be set as modified. However, if you call setWindowModified(false) on a widget, this will not propagate to its parent because other children of the parent might have been modified.

Access functions:

bool	isWindowModified() const
void	setWindowModified(bool)

See also windowTitle, Application Example, SDI Example, and MDI Example.

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

This property holds the window title (caption)

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

C++ documentation:

This property holds the window title (caption)

This property only makes sense for top-level widgets, such as windows and dialogs. If no caption has been set, the title is based of the windowFilePath. If neither of these is set, then the title is an empty string.

If you use the windowModified mechanism, the window title must contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the windowModified property is false (the default), the placeholder is simply removed.

On some desktop platforms (including Windows and Unix), the application name (from QGuiApplication::applicationDisplayName) is added at the end of the window title, if set. This is done by the QPA plugin, so it is shown to the user, but isn't part of the windowTitle string.

Access functions:

QString	windowTitle() const
void	setWindowTitle(const QString &)

Notifier signal:

void	windowTitleChanged(const QString &title)

See also windowIcon, windowModified, and windowFilePath.

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

This property holds the widget's style sheet

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

C++ documentation:

This property holds the widget’s style sheet

The style sheet contains a textual description of customizations to the widget's style, as described in the Qt Style Sheets document.

Since Qt 4.5, Qt style sheets fully supports macOS.

Warning: Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

This property was introduced in Qt 4.2.

Access functions:

QString	styleSheet() const
void	setStyleSheet(const QString &styleSheet)

See also setStyle(), QApplication::styleSheet, and Qt Style Sheets.

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

This is an overloaded function.

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

C++ documentation:

This is an overloaded function.

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window.

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

Updates the widget unless updates are disabled or the widget is hidden.

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

C++ documentation:

Updates the widget unless updates are disabled or the widget is hidden.

This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker than a call to repaint() does.

Calling update() several times normally results in just one paintEvent() call.

Qt normally erases the widget's area before the paintEvent() call. If the Qt::WA_OpaquePaintEvent widget attribute is set, the widget is responsible for painting all its pixels with an opaque color.

See also repaint(), paintEvent(), setUpdatesEnabled(), and Analog Clock Example.

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

Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

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

C++ documentation:

Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

We suggest only using repaint() if you need an immediate repaint, for example during animation. In almost all circumstances update() is better, as it permits Qt to optimize for speed and minimize flicker.

Warning: If you call repaint() in a function which may itself be called from paintEvent(), you may get infinite recursion. The update() function never causes recursion.

See also update(), paintEvent(), and setUpdatesEnabled().

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

This property holds whether the widget is visible

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

C++ documentation:

This property holds whether the widget is visible

Calling setVisible(true) or show() sets the widget to visible status if all its parent widgets up to the window are visible. If an ancestor is not visible, the widget won't become visible until all its ancestors are shown. If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. If the widget has not been resized yet, Qt will adjust the widget's size to a useful default using adjustSize().

Calling setVisible(false) or hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it.

A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames.

A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified windows and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again.

You almost never have to reimplement the setVisible() function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use the Polish event delivered to the event() function.

Access functions:

bool	isVisible() const
virtual void	setVisible(bool visible)

See also show(), hide(), isHidden(), isVisibleTo(), isMinimized(), showEvent(), and hideEvent().

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

Convenience function, equivalent to setVisible(!hidden).

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

C++ documentation:

Convenience function, equivalent to setVisible(!hidden).

See also isHidden().

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

Shows the widget and its child widgets.

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

C++ documentation:

Shows the widget and its child widgets.

This is equivalent to calling showFullScreen(), showMaximized(), or setVisible(true), depending on the platform's default behavior for the window flags.

See also raise(), showEvent(), hide(), setVisible(), showMinimized(), showMaximized(), showNormal(), isVisible(), and windowFlags().

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

Hides the widget. This function is equivalent to setVisible(false).

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

C++ documentation:

Hides the widget. This function is equivalent to setVisible(false).

Note: If you are working with QDialog or its subclasses and you invoke the show() function after this function, the dialog will be displayed in its original position.

See also hideEvent(), isHidden(), show(), setVisible(), isVisible(), and close().

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

Shows the widget minimized, as an icon.

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

C++ documentation:

Shows the widget minimized, as an icon.

Calling this function only affects windows.

See also showNormal(), showMaximized(), show(), hide(), isVisible(), and isMinimized().

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

Shows the widget maximized.

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

C++ documentation:

Shows the widget maximized.

Calling this function only affects windows.

On X11, this function may not work properly with certain window managers. See the Window Geometry documentation for an explanation.

See also setWindowState(), showNormal(), showMinimized(), show(), hide(), and isVisible().

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

Shows the widget in full-screen mode.

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

C++ documentation:

Shows the widget in full-screen mode.

Calling this function only affects windows.

To return from full-screen mode, call showNormal().

Full-screen mode works fine under Windows, but has certain problems under X. These problems are due to limitations of the ICCCM protocol that specifies the communication between X11 clients and the window manager. ICCCM simply does not understand the concept of non-decorated full-screen windows. Therefore, the best we can do is to request a borderless window and place and resize it to fill the entire screen. Depending on the window manager, this may or may not work. The borderless window is requested using MOTIF hints, which are at least partially supported by virtually all modern window managers.

An alternative would be to bypass the window manager entirely and create a window with the Qt::X11BypassWindowManagerHint flag. This has other severe problems though, like totally broken keyboard focus and very strange effects on desktop changes or when the user raises other windows.

X11 window managers that follow modern post-ICCCM specifications support full-screen mode properly.

See also showNormal(), showMaximized(), show(), hide(), and isVisible().

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

Restores the widget after it has been maximized or minimized.

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

C++ documentation:

Restores the widget after it has been maximized or minimized.

Calling this function only affects windows.

See also setWindowState(), showMinimized(), showMaximized(), show(), hide(), and isVisible().

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

Closes this widget. Returns true if the widget was closed; otherwise returns false.

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

C++ documentation:

Closes this widget. Returns true if the widget was closed; otherwise returns false.

First it sends the widget a QCloseEvent. The widget is hidden if it accepts the close event. If it ignores the event, nothing happens. The default implementation of QWidget::closeEvent() accepts the close event.

If the widget has the Qt::WA_DeleteOnClose flag, the widget is also deleted. A close events is delivered to the widget no matter if the widget is visible or not.

The QApplication::lastWindowClosed() signal is emitted when the last visible primary window (i.e. window with no parent) with the Qt::WA_QuitOnClose attribute set is closed. By default this attribute is set for all widgets except transient windows such as splash screens, tool windows, and popup menus.

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

Raises this widget to the top of the parent widget's stack.

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

C++ documentation:

Raises this widget to the top of the parent widget’s stack.

After this call the widget will be visually in front of any overlapping sibling widgets.

Note: When using activateWindow(), you can call this function to ensure that the window is stacked on top.

See also lower() and stackUnder().

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

Lowers the widget to the bottom of the parent widget's stack.

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

C++ documentation:

Lowers the widget to the bottom of the parent widget’s stack.

After this call the widget will be visually behind (and therefore obscured by) any overlapping sibling widgets.

See also raise() and stackUnder().

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

This signal is emitted when the window's title has changed, with the new title as an argument.

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

C++ documentation:

This signal is emitted when the window’s title has changed, with the new title as an argument.

This function was introduced in Qt 5.2.

Note: Notifier signal for property windowTitle.

pub fn window_icon_changed(&self) -> Signal<(*const QIcon,)>

This signal is emitted when the window's icon has changed, with the new icon as an argument.

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

C++ documentation:

This signal is emitted when the window’s icon has changed, with the new icon as an argument.

This function was introduced in Qt 5.2.

Note: Notifier signal for property windowIcon.

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

This signal is emitted when the window's icon text has changed, with the new iconText as an argument.

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

C++ documentation:

This signal is emitted when the window’s icon text has changed, with the new iconText as an argument.

This signal is deprecated.

This function was introduced in Qt 5.2.

Note: Notifier signal for property windowIconText.

pub fn custom_context_menu_requested(&self) -> Signal<(*const QPoint,)>

This signal is emitted when the widget's contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. The position pos is the position of the context menu event that the widget receives. Normally this is in widget coordinates. The exception to this rule is QAbstractScrollArea and its subclasses that map the context menu event to coordinates of the viewport().

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

C++ documentation:

This signal is emitted when the widget’s contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. The position pos is the position of the context menu event that the widget receives. Normally this is in widget coordinates. The exception to this rule is QAbstractScrollArea and its subclasses that map the context menu event to coordinates of the viewport().

See also mapToGlobal(), QMenu, and contextMenuPolicy.

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

Updates the widget's micro focus.

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

C++ documentation:

Updates the widget’s micro focus.

pub unsafe fn accept_drops(&self) -> bool

This property holds whether drop events are enabled for this widget

Calls C++ function: bool QWidget::acceptDrops() const.

C++ documentation:

This property holds whether drop events are enabled for this widget

Setting this property to true announces to the system that this widget may be able to accept drop events.

If the widget is the desktop (windowType() == Qt::Desktop), this may fail if another application is using the desktop; you can call acceptDrops() to test if this occurs.

Warning: Do not modify this property in a drag and drop event handler.

By default, this property is false.

Access functions:

bool	acceptDrops() const
void	setAcceptDrops(bool on)

See also Drag and Drop.

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

This property holds the widget's description as seen by assistive technologies

Calls C++ function: QString QWidget::accessibleDescription() const.

C++ documentation:

This property holds the widget’s description as seen by assistive technologies

The accessible description of a widget should convey what a widget does. While the accessibleName should be a short and consise string (e.g. Save), the description should give more context, such as Saves the current document.

This property has to be localized.

By default, this property contains an empty string and Qt falls back to using the tool tip to provide this information.

Access functions:

QString	accessibleDescription() const
void	setAccessibleDescription(const QString &description)

See also QWidget::accessibleName and QAccessibleInterface::text().

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

This property holds the widget's name as seen by assistive technologies

Calls C++ function: QString QWidget::accessibleName() const.

C++ documentation:

This property holds the widget’s name as seen by assistive technologies

This is the primary name by which assistive technology such as screen readers announce this widget. For most widgets setting this property is not required. For example for QPushButton the button's text will be used.

It is important to set this property when the widget does not provide any text. For example a button that only contains an icon needs to set this property to work with screen readers. The name should be short and equivalent to the visual information conveyed by the widget.

This property has to be localized.

By default, this property contains an empty string.

Access functions:

QString	accessibleName() const
void	setAccessibleName(const QString &name)

See also QWidget::accessibleDescription and QAccessibleInterface::text().

pub unsafe fn actions(&self) -> CppBox<QListOfQAction>

Returns the (possibly empty) list of this widget's actions.

Calls C++ function: QList<QAction*> QWidget::actions() const.

C++ documentation:

Returns the (possibly empty) list of this widget’s actions.

See also contextMenuPolicy, insertAction(), and removeAction().

pub unsafe fn activate_window(&self)

Sets the top-level widget containing this widget to be the active window.

Calls C++ function: void QWidget::activateWindow().

C++ documentation:

Sets the top-level widget containing this widget to be the active window.

An active window is a visible top-level window that has the keyboard input focus.

This function performs the same operation as clicking the mouse on the title bar of a top-level window. On X11, the result depends on the Window Manager. If you want to ensure that the window is stacked on top as well you should also call raise(). Note that the window must be visible, otherwise activateWindow() has no effect.

On Windows, if you are calling this when the application is not currently the active one then it will not make it the active window. It will change the color of the taskbar entry to indicate that the window has changed in some way. This is because Microsoft does not allow an application to interrupt what the user is currently doing in another application.

See also isActiveWindow(), window(), show(), and QWindowsWindowFunctions::setWindowActivationBehavior().

pub unsafe fn add_action(&self, action: impl CastInto<Ptr<QAction>>)

Appends the action action to this widget's list of actions.

Calls C++ function: void QWidget::addAction(QAction* action).

C++ documentation:

Appends the action action to this widget’s list of actions.

All QWidgets have a list of QActions, however they can be represented graphically in many different ways. The default use of the QAction list (as returned by actions()) is to create a context QMenu.

A QWidget should only have one of each action and adding an action it already has will not cause the same action to be in the widget twice.

The ownership of action is not transferred to this QWidget.

See also removeAction(), insertAction(), actions(), and QMenu.

pub unsafe fn add_actions(&self, actions: impl CastInto<Ref<QListOfQAction>>)

Appends the actions actions to this widget's list of actions.

Calls C++ function: void QWidget::addActions(QList<QAction*> actions).

C++ documentation:

Appends the actions actions to this widget’s list of actions.

See also removeAction(), QMenu, and addAction().

pub unsafe fn adjust_size(&self)

Adjusts the size of the widget to fit its contents.

Calls C++ function: void QWidget::adjustSize().

C++ documentation:

Adjusts the size of the widget to fit its contents.

This function uses sizeHint() if it is valid, i.e., the size hint's width and height are >= 0. Otherwise, it sets the size to the children rectangle that covers all child widgets (the union of all child widget rectangles).

For windows, the screen size is also taken into account. If the sizeHint() is less than (200, 100) and the size policy is expanding, the window will be at least (200, 100). The maximum size of a window is 2/3 of the screen's width and height.

See also sizeHint() and childrenRect().

pub unsafe fn auto_fill_background(&self) -> bool

This property holds whether the widget background is filled automatically

Calls C++ function: bool QWidget::autoFillBackground() const.

C++ documentation:

This property holds whether the widget background is filled automatically

If enabled, this property will cause Qt to fill the background of the widget before invoking the paint event. The color used is defined by the QPalette::Window color role from the widget's palette.

In addition, Windows are always filled with QPalette::Window, unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set.

This property cannot be turned off (i.e., set to false) if a widget's parent has a static gradient for its background.

Warning: Use this property with caution in conjunction with Qt Style Sheets. When a widget has a style sheet with a valid background or a border-image, this property is automatically disabled.

By default, this property is false.

This property was introduced in Qt 4.1.

Access functions:

bool	autoFillBackground() const
void	setAutoFillBackground(bool enabled)

See also Qt::WA_OpaquePaintEvent, Qt::WA_NoSystemBackground, and Transparency and Double Buffering.

pub unsafe fn background_role(&self) -> ColorRole

Returns the background role of the widget.

Calls C++ function: QPalette::ColorRole QWidget::backgroundRole() const.

C++ documentation:

Returns the background role of the widget.

The background role defines the brush from the widget's palette that is used to render the background.

If no explicit background role is set, the widget inherts its parent widget's background role.

See also setBackgroundRole() and foregroundRole().

pub unsafe fn backing_store(&self) -> Ptr<QBackingStore>

Returns the QBackingStore this widget will be drawn into.

Calls C++ function: QBackingStore* QWidget::backingStore() const.

C++ documentation:

Returns the QBackingStore this widget will be drawn into.

This function was introduced in Qt 5.0.

pub unsafe fn base_size(&self) -> CppBox<QSize>

This property holds the base size of the widget

Calls C++ function: QSize QWidget::baseSize() const.

C++ documentation:

This property holds the base size of the widget

The base size is used to calculate a proper widget size if the widget defines sizeIncrement().

By default, for a newly-created widget, this property contains a size with zero width and height.

Access functions:

QSize	baseSize() const
void	setBaseSize(const QSize &)
void	setBaseSize(int basew, int baseh)

See also setSizeIncrement().

pub unsafe fn child_at_2a(&self, x: c_int, y: c_int) -> QPtr<QWidget>

Returns the visible child widget at the position (x, y) in the widget's coordinate system. If there is no visible child widget at the specified position, the function returns 0.

Calls C++ function: QWidget* QWidget::childAt(int x, int y) const.

C++ documentation:

Returns the visible child widget at the position (x, y) in the widget’s coordinate system. If there is no visible child widget at the specified position, the function returns 0.

pub unsafe fn child_at_1a(&self, p: impl CastInto<Ref<QPoint>>) -> QPtr<QWidget>

This is an overloaded function.

Calls C++ function: QWidget* QWidget::childAt(const QPoint& p) const.

C++ documentation:

This is an overloaded function.

Returns the visible child widget at point p in the widget's own coordinate system.

pub unsafe fn children_rect(&self) -> CppBox<QRect>

This property holds the bounding rectangle of the widget's children

Calls C++ function: QRect QWidget::childrenRect() const.

C++ documentation:

This property holds the bounding rectangle of the widget’s children

Hidden children are excluded.

By default, for a widget with no children, this property contains a rectangle with zero width and height located at the origin.

Access functions:

QRect

childrenRect() const

See also childrenRegion() and geometry().

pub unsafe fn children_region(&self) -> CppBox<QRegion>

This property holds the combined region occupied by the widget's children

Calls C++ function: QRegion QWidget::childrenRegion() const.

C++ documentation:

This property holds the combined region occupied by the widget’s children

Hidden children are excluded.

By default, for a widget with no children, this property contains an empty region.

Access functions:

QRegion

childrenRegion() const

See also childrenRect(), geometry(), and mask().

pub unsafe fn clear_focus(&self)

Takes keyboard input focus from the widget.

Calls C++ function: void QWidget::clearFocus().

C++ documentation:

Takes keyboard input focus from the widget.

If the widget has active focus, a focus out event is sent to this widget to tell it that it has lost the focus.

This widget must enable focus setting in order to get the keyboard input focus, i.e. it must call setFocusPolicy().

See also hasFocus(), setFocus(), focusInEvent(), focusOutEvent(), setFocusPolicy(), and QApplication::focusWidget().

pub unsafe fn clear_mask(&self)

Removes any mask set by setMask().

Calls C++ function: void QWidget::clearMask().

C++ documentation:

Removes any mask set by setMask().

See also setMask().

pub unsafe fn close(&self) -> bool

Closes this widget. Returns true if the widget was closed; otherwise returns false.

Calls C++ function: [slot] bool QWidget::close().

C++ documentation:

Closes this widget. Returns true if the widget was closed; otherwise returns false.

First it sends the widget a QCloseEvent. The widget is hidden if it accepts the close event. If it ignores the event, nothing happens. The default implementation of QWidget::closeEvent() accepts the close event.

If the widget has the Qt::WA_DeleteOnClose flag, the widget is also deleted. A close events is delivered to the widget no matter if the widget is visible or not.

The QApplication::lastWindowClosed() signal is emitted when the last visible primary window (i.e. window with no parent) with the Qt::WA_QuitOnClose attribute set is closed. By default this attribute is set for all widgets except transient windows such as splash screens, tool windows, and popup menus.

pub unsafe fn contents_margins(&self) -> CppBox<QMargins>

The contentsMargins function returns the widget's contents margins.

Calls C++ function: QMargins QWidget::contentsMargins() const.

C++ documentation:

The contentsMargins function returns the widget’s contents margins.

This function was introduced in Qt 4.6.

See also getContentsMargins(), setContentsMargins(), and contentsRect().

pub unsafe fn contents_rect(&self) -> CppBox<QRect>

Returns the area inside the widget's margins.

Calls C++ function: QRect QWidget::contentsRect() const.

C++ documentation:

Returns the area inside the widget’s margins.

See also setContentsMargins() and getContentsMargins().

pub unsafe fn context_menu_policy(&self) -> ContextMenuPolicy

how the widget shows a context menu

Calls C++ function: Qt::ContextMenuPolicy QWidget::contextMenuPolicy() const.

C++ documentation:

how the widget shows a context menu

The default value of this property is Qt::DefaultContextMenu, which means the contextMenuEvent() handler is called. Other values are Qt::NoContextMenu, Qt::PreventContextMenu, Qt::ActionsContextMenu, and Qt::CustomContextMenu. With Qt::CustomContextMenu, the signal customContextMenuRequested() is emitted.

Access functions:

Qt::ContextMenuPolicy	contextMenuPolicy() const
void	setContextMenuPolicy(Qt::ContextMenuPolicy policy)

See also contextMenuEvent(), customContextMenuRequested(), and actions().

pub unsafe fn create_win_id(&self)

Calls C++ function: void QWidget::createWinId().

pub unsafe fn cursor(&self) -> CppBox<QCursor>

This property holds the cursor shape for this widget

Calls C++ function: QCursor QWidget::cursor() const.

C++ documentation:

This property holds the cursor shape for this widget

The mouse cursor will assume this shape when it's over this widget. See the list of predefined cursor objects for a range of useful shapes.

An editor widget might use an I-beam cursor:

setCursor(Qt::IBeamCursor);

If no cursor has been set, or after a call to unsetCursor(), the parent's cursor is used.

By default, this property contains a cursor with the Qt::ArrowCursor shape.

Some underlying window implementations will reset the cursor if it leaves a widget even if the mouse is grabbed. If you want to have a cursor set for all widgets, even when outside the window, consider QApplication::setOverrideCursor().

Access functions:

QCursor	cursor() const
void	setCursor(const QCursor &)
void	unsetCursor()

See also QApplication::setOverrideCursor().

pub unsafe fn dev_type(&self) -> c_int

Calls C++ function: virtual int QWidget::devType() const.

pub unsafe fn effective_win_id(&self) -> c_ulonglong

Returns the effective window system identifier of the widget, i.e. the native parent's window system identifier.

Calls C++ function: unsigned long long QWidget::effectiveWinId() const.

C++ documentation:

Returns the effective window system identifier of the widget, i.e. the native parent’s window system identifier.

If the widget is native, this function returns the native widget ID. Otherwise, the window ID of the first native parent widget, i.e., the top-level widget that contains this widget, is returned.

Note: We recommend that you do not store this value as it is likely to change at run-time.

This function was introduced in Qt 4.4.

See also nativeParentWidget().

pub unsafe fn ensure_polished(&self)

Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

Calls C++ function: void QWidget::ensurePolished() const.

C++ documentation:

Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

QWidget calls this function after it has been fully constructed but before it is shown the very first time. You can call this function if you want to ensure that the widget is polished before doing an operation, e.g., the correct font size might be needed in the widget's sizeHint() reimplementation. Note that this function is called from the default implementation of sizeHint().

Polishing is useful for final initialization that must happen after all constructors (from base classes as well as from subclasses) have been called.

If you need to change some settings when a widget is polished, reimplement event() and handle the QEvent::Polish event type.

Note: The function is declared const so that it can be called from other const functions (e.g., sizeHint()).

See also event().

pub unsafe fn focus_policy(&self) -> FocusPolicy

This property holds the way the widget accepts keyboard focus

Calls C++ function: Qt::FocusPolicy QWidget::focusPolicy() const.

C++ documentation:

This property holds the way the widget accepts keyboard focus

The policy is Qt::TabFocus if the widget accepts keyboard focus by tabbing, Qt::ClickFocus if the widget accepts focus by clicking, Qt::StrongFocus if it accepts both, and Qt::NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(Qt::StrongFocus).

If the widget has a focus proxy, then the focus policy will be propagated to it.

Access functions:

Qt::FocusPolicy	focusPolicy() const
void	setFocusPolicy(Qt::FocusPolicy policy)

See also focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), and enabled.

pub unsafe fn focus_proxy(&self) -> QPtr<QWidget>

Returns the focus proxy, or 0 if there is no focus proxy.

Calls C++ function: QWidget* QWidget::focusProxy() const.

C++ documentation:

Returns the focus proxy, or 0 if there is no focus proxy.

See also setFocusProxy().

pub unsafe fn focus_widget(&self) -> QPtr<QWidget>

Returns the last child of this widget that setFocus had been called on. For top level widgets this is the widget that will get focus in case this window gets activated

Calls C++ function: QWidget* QWidget::focusWidget() const.

C++ documentation:

Returns the last child of this widget that setFocus had been called on. For top level widgets this is the widget that will get focus in case this window gets activated

This is not the same as QApplication::focusWidget(), which returns the focus widget in the currently active window.

pub unsafe fn font(&self) -> Ref<QFont>

This property holds the font currently set for the widget

Calls C++ function: const QFont& QWidget::font() const.

C++ documentation:

This property holds the font currently set for the widget

This property describes the widget's requested font. The font is used by the widget's style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform's look and feel. It's common that different platforms, or different styles, define different fonts for an application.

When you assign a new font to a widget, the properties from this font are combined with the widget's default font to form the widget's final font. You can call fontInfo() to get a copy of the widget's final font. The final font is also used to initialize QPainter's font.

The default depends on the system environment. QApplication maintains a system/theme font which serves as a default for all widgets. There may also be special font defaults for certain types of widgets. You can also define default fonts for widgets yourself by passing a custom font and the name of a widget to QApplication::setFont(). Finally, the font is matched against Qt's font database to find the best match.

QWidget propagates explicit font properties from parent to child. If you change a specific property on a font and assign that font to a widget, that property will propagate to all the widget's children, overriding any system defaults for that property. Note that fonts by default don't propagate to windows (see isWindow()) unless the Qt::WA_WindowPropagation attribute is enabled.

QWidget's font propagation is similar to its palette propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose to use the widget font, or in some cases, to ignore it (partially, or completely). In particular, certain styles like GTK style, Mac style, Windows XP, and Vista style, apply special modifications to the widget font to match the platform's native look and feel. Because of this, assigning properties to a widget's font is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet.

Note: If Qt Style Sheets are used on the same widget as setFont(), style sheets will take precedence if the settings conflict.

Access functions:

const QFont &	font() const
void	setFont(const QFont &)

See also fontInfo() and fontMetrics().

pub unsafe fn font_info(&self) -> CppBox<QFontInfo>

Returns the font info for the widget's current font. Equivalent to QFontInfo(widget->font()).

Calls C++ function: QFontInfo QWidget::fontInfo() const.

C++ documentation:

Returns the font info for the widget’s current font. Equivalent to QFontInfo(widget->font()).

See also font(), fontMetrics(), and setFont().

pub unsafe fn font_metrics(&self) -> CppBox<QFontMetrics>

Returns the font metrics for the widget's current font. Equivalent to QFontMetrics(widget->font()).

Calls C++ function: QFontMetrics QWidget::fontMetrics() const.

C++ documentation:

Returns the font metrics for the widget’s current font. Equivalent to QFontMetrics(widget->font()).

See also font(), fontInfo(), and setFont().

pub unsafe fn foreground_role(&self) -> ColorRole

Returns the foreground role.

Calls C++ function: QPalette::ColorRole QWidget::foregroundRole() const.

C++ documentation:

Returns the foreground role.

The foreground role defines the color from the widget's palette that is used to draw the foreground.

If no explicit foreground role is set, the function returns a role that contrasts with the background role.

See also setForegroundRole() and backgroundRole().

pub unsafe fn frame_geometry(&self) -> CppBox<QRect>

geometry of the widget relative to its parent including any window frame

Calls C++ function: QRect QWidget::frameGeometry() const.

C++ documentation:

geometry of the widget relative to its parent including any window frame

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

QRect

frameGeometry() const

See also geometry(), x(), y(), and pos().

pub unsafe fn frame_size(&self) -> CppBox<QSize>

This property holds the size of the widget including any window frame

Calls C++ function: QSize QWidget::frameSize() const.

C++ documentation:

This property holds the size of the widget including any window frame

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

QSize

frameSize() const

pub unsafe fn geometry(&self) -> Ref<QRect>

This property holds the geometry of the widget relative to its parent and excluding the window frame

Calls C++ function: const QRect& QWidget::geometry() const.

C++ documentation:

This property holds the geometry of the widget relative to its parent and excluding the window frame

When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown.

The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize().

Warning: Calling setGeometry() inside resizeEvent() or moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

const QRect &	geometry() const
void	setGeometry(int x, int y, int w, int h)
void	setGeometry(const QRect &)

See also frameGeometry(), rect(), move(), resize(), moveEvent(), resizeEvent(), minimumSize(), and maximumSize().

pub unsafe fn get_contents_margins( &self, left: *mut c_int, top: *mut c_int, right: *mut c_int, bottom: *mut c_int, )

Returns the widget's contents margins for left, top, right, and bottom.

Calls C++ function: void QWidget::getContentsMargins(int* left, int* top, int* right, int* bottom) const.

C++ documentation:

Returns the widget’s contents margins for left, top, right, and bottom.

See also setContentsMargins() and contentsRect().

pub unsafe fn grab_1a( &self, rectangle: impl CastInto<Ref<QRect>>, ) -> CppBox<QPixmap>

Renders the widget into a pixmap restricted by the given rectangle. If the widget has any children, then they are also painted in the appropriate positions.

Calls C++ function: QPixmap QWidget::grab(const QRect& rectangle = …).

C++ documentation:

Renders the widget into a pixmap restricted by the given rectangle. If the widget has any children, then they are also painted in the appropriate positions.

If a rectangle with an invalid size is specified (the default), the entire widget is painted.

This function was introduced in Qt 5.0.

See also render() and QPixmap.

pub unsafe fn grab_0a(&self) -> CppBox<QPixmap>

Renders the widget into a pixmap restricted by the given rectangle. If the widget has any children, then they are also painted in the appropriate positions.

Calls C++ function: QPixmap QWidget::grab().

C++ documentation:

Renders the widget into a pixmap restricted by the given rectangle. If the widget has any children, then they are also painted in the appropriate positions.

If a rectangle with an invalid size is specified (the default), the entire widget is painted.

This function was introduced in Qt 5.0.

See also render() and QPixmap.

pub unsafe fn grab_gesture_2a( &self, type_: GestureType, flags: QFlags<GestureFlag>, )

Subscribes the widget to a given gesture with specific flags.

Calls C++ function: void QWidget::grabGesture(Qt::GestureType type, QFlags<Qt::GestureFlag> flags = …).

C++ documentation:

Subscribes the widget to a given gesture with specific flags.

This function was introduced in Qt 4.6.

See also ungrabGesture() and QGestureEvent.

pub unsafe fn grab_gesture_1a(&self, type_: GestureType)

Subscribes the widget to a given gesture with specific flags.

Calls C++ function: void QWidget::grabGesture(Qt::GestureType type).

C++ documentation:

Subscribes the widget to a given gesture with specific flags.

This function was introduced in Qt 4.6.

See also ungrabGesture() and QGestureEvent.

pub unsafe fn grab_keyboard(&self)

Grabs the keyboard input.

Calls C++ function: void QWidget::grabKeyboard().

C++ documentation:

Grabs the keyboard input.

This widget receives all keyboard events until releaseKeyboard() is called; other widgets get no keyboard events at all. Mouse events are not affected. Use grabMouse() if you want to grab that.

The focus widget is not affected, except that it doesn't receive any keyboard events. setFocus() moves the focus as usual, but the new focus widget receives keyboard events only after releaseKeyboard() is called.

If a different widget is currently grabbing keyboard input, that widget's grab is released first.

See also releaseKeyboard(), grabMouse(), releaseMouse(), and focusWidget().

pub unsafe fn grab_mouse_0a(&self)

Grabs the mouse input.

Calls C++ function: void QWidget::grabMouse().

C++ documentation:

Grabs the mouse input.

This widget receives all mouse events until releaseMouse() is called; other widgets get no mouse events at all. Keyboard events are not affected. Use grabKeyboard() if you want to grab that.

Warning: Bugs in mouse-grabbing applications very often lock the terminal. Use this function with extreme caution, and consider using the -nograb command line option while debugging.

It is almost never necessary to grab the mouse when using Qt, as Qt grabs and releases it sensibly. In particular, Qt grabs the mouse when a mouse button is pressed and keeps it until the last button is released.

Note: Only visible widgets can grab mouse input. If isVisible() returns false for a widget, that widget cannot call grabMouse().

Note: On Windows, grabMouse() only works when the mouse is inside a window owned by the process. On macOS, grabMouse() only works when the mouse is inside the frame of that widget.

See also releaseMouse(), grabKeyboard(), and releaseKeyboard().

pub unsafe fn grab_mouse_1a(&self, arg1: impl CastInto<Ref<QCursor>>)

This function overloads grabMouse().

Calls C++ function: void QWidget::grabMouse(const QCursor& arg1).

C++ documentation:

This function overloads grabMouse().

Grabs the mouse input and changes the cursor shape.

The cursor will assume shape cursor (for as long as the mouse focus is grabbed) and this widget will be the only one to receive mouse events until releaseMouse() is called().

Warning: Grabbing the mouse might lock the terminal.

Note: See the note in QWidget::grabMouse().

See also releaseMouse(), grabKeyboard(), releaseKeyboard(), and setCursor().

pub unsafe fn grab_shortcut_2a( &self, key: impl CastInto<Ref<QKeySequence>>, context: ShortcutContext, ) -> c_int

Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. If the context is Qt::ApplicationShortcut, the shortcut applies to the application as a whole. Otherwise, it is either local to this widget, Qt::WidgetShortcut, or to the window itself, Qt::WindowShortcut.

Calls C++ function: int QWidget::grabShortcut(const QKeySequence& key, Qt::ShortcutContext context = …).

C++ documentation:

Adds a shortcut to Qt’s shortcut system that watches for the given key sequence in the given context. If the context is Qt::ApplicationShortcut, the shortcut applies to the application as a whole. Otherwise, it is either local to this widget, Qt::WidgetShortcut, or to the window itself, Qt::WindowShortcut.

If the same key sequence has been grabbed by several widgets, when the key sequence occurs a QEvent::Shortcut event is sent to all the widgets to which it applies in a non-deterministic order, but with the ``ambiguous'' flag set to true.

Warning: You should not normally need to use this function; instead create QActions with the shortcut key sequences you require (if you also want equivalent menu options and toolbar buttons), or create QShortcuts if you just need key sequences. Both QAction and QShortcut handle all the event filtering for you, and provide signals which are triggered when the user triggers the key sequence, so are much easier to use than this low-level function.

See also releaseShortcut() and setShortcutEnabled().

pub unsafe fn grab_shortcut_1a( &self, key: impl CastInto<Ref<QKeySequence>>, ) -> c_int

Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. If the context is Qt::ApplicationShortcut, the shortcut applies to the application as a whole. Otherwise, it is either local to this widget, Qt::WidgetShortcut, or to the window itself, Qt::WindowShortcut.

Calls C++ function: int QWidget::grabShortcut(const QKeySequence& key).

C++ documentation:

Adds a shortcut to Qt’s shortcut system that watches for the given key sequence in the given context. If the context is Qt::ApplicationShortcut, the shortcut applies to the application as a whole. Otherwise, it is either local to this widget, Qt::WidgetShortcut, or to the window itself, Qt::WindowShortcut.

If the same key sequence has been grabbed by several widgets, when the key sequence occurs a QEvent::Shortcut event is sent to all the widgets to which it applies in a non-deterministic order, but with the ``ambiguous'' flag set to true.

Warning: You should not normally need to use this function; instead create QActions with the shortcut key sequences you require (if you also want equivalent menu options and toolbar buttons), or create QShortcuts if you just need key sequences. Both QAction and QShortcut handle all the event filtering for you, and provide signals which are triggered when the user triggers the key sequence, so are much easier to use than this low-level function.

See also releaseShortcut() and setShortcutEnabled().

pub unsafe fn graphics_effect(&self) -> QPtr<QGraphicsEffect>

The graphicsEffect function returns a pointer to the widget's graphics effect.

Calls C++ function: QGraphicsEffect* QWidget::graphicsEffect() const.

C++ documentation:

The graphicsEffect function returns a pointer to the widget’s graphics effect.

If the widget has no graphics effect, 0 is returned.

This function was introduced in Qt 4.6.

See also setGraphicsEffect().

pub unsafe fn graphics_proxy_widget(&self) -> QPtr<QGraphicsProxyWidget>

Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns 0.

Calls C++ function: QGraphicsProxyWidget* QWidget::graphicsProxyWidget() const.

C++ documentation:

Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns 0.

This function was introduced in Qt 4.5.

See also QGraphicsProxyWidget::createProxyForChildWidget() and QGraphicsScene::addWidget().

pub unsafe fn has_focus(&self) -> bool

This property holds whether this widget (or its focus proxy) has the keyboard input focus

Calls C++ function: bool QWidget::hasFocus() const.

C++ documentation:

This property holds whether this widget (or its focus proxy) has the keyboard input focus

By default, this property is false.

Note: Obtaining the value of this property for a widget is effectively equivalent to checking whether QApplication::focusWidget() refers to the widget.

Access functions:

bool	hasFocus() const

See also setFocus(), clearFocus(), setFocusPolicy(), and QApplication::focusWidget().

pub unsafe fn has_height_for_width(&self) -> bool

Returns true if the widget's preferred height depends on its width; otherwise returns false.

Calls C++ function: virtual bool QWidget::hasHeightForWidth() const.

C++ documentation:

Returns true if the widget’s preferred height depends on its width; otherwise returns false.

This function was introduced in Qt 5.0.

pub unsafe fn has_mouse_tracking(&self) -> bool

This property holds whether mouse tracking is enabled for the widget

Calls C++ function: bool QWidget::hasMouseTracking() const.

C++ documentation:

This property holds whether mouse tracking is enabled for the widget

If mouse tracking is disabled (the default), the widget only receives mouse move events when at least one mouse button is pressed while the mouse is being moved.

If mouse tracking is enabled, the widget receives mouse move events even if no buttons are pressed.

Access functions:

bool	hasMouseTracking() const
void	setMouseTracking(bool enable)

See also mouseMoveEvent().

pub unsafe fn has_tablet_tracking(&self) -> bool

This property holds whether tablet tracking is enabled for the widget

Calls C++ function: bool QWidget::hasTabletTracking() const.

C++ documentation:

This property holds whether tablet tracking is enabled for the widget

If tablet tracking is disabled (the default), the widget only receives tablet move events when the stylus is in contact with the tablet, or at least one stylus button is pressed, while the stylus is being moved.

If tablet tracking is enabled, the widget receives tablet move events even while hovering in proximity. This is useful for monitoring position as well as the auxiliary properties such as rotation and tilt, and providing feedback in the UI.

This property was introduced in Qt 5.9.

Access functions:

bool	hasTabletTracking() const
void	setTabletTracking(bool enable)

See also tabletEvent().

pub unsafe fn height(&self) -> c_int

This property holds the height of the widget excluding any window frame

Calls C++ function: int QWidget::height() const.

C++ documentation:

This property holds the height of the widget excluding any window frame

See the Window Geometry documentation for an overview of geometry issues with windows.

Note: Do not use this function to find the height of a screen on a multiple screen desktop. Read this note for details.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

int	height() const

See also geometry, width, and size.

pub unsafe fn height_for_width(&self, arg1: c_int) -> c_int

Returns the preferred height for this widget, given the width w.

Calls C++ function: virtual int QWidget::heightForWidth(int arg1) const.

C++ documentation:

Returns the preferred height for this widget, given the width w.

If this widget has a layout, the default implementation returns the layout's preferred height. if there is no layout, the default implementation returns -1 indicating that the preferred height does not depend on the width.

pub unsafe fn hide(&self)

Hides the widget. This function is equivalent to setVisible(false).

Calls C++ function: [slot] void QWidget::hide().

C++ documentation:

Hides the widget. This function is equivalent to setVisible(false).

Note: If you are working with QDialog or its subclasses and you invoke the show() function after this function, the dialog will be displayed in its original position.

See also hideEvent(), isHidden(), show(), setVisible(), isVisible(), and close().

pub unsafe fn input_method_hints(&self) -> QFlags<InputMethodHint>

What input method specific hints the widget has.

Calls C++ function: QFlags<Qt::InputMethodHint> QWidget::inputMethodHints() const.

C++ documentation:

What input method specific hints the widget has.

This is only relevant for input widgets. It is used by the input method to retrieve hints as to how the input method should operate. For example, if the Qt::ImhFormattedNumbersOnly flag is set, the input method may change its visual components to reflect that only numbers can be entered.

Warning: Some widgets require certain flags in order to work as intended. To set a flag, do w->setInputMethodHints(w->inputMethodHints()|f) instead of w->setInputMethodHints(f).

Note: The flags are only hints, so the particular input method implementation is free to ignore them. If you want to be sure that a certain type of characters are entered, you should also set a QValidator on the widget.

The default value is Qt::ImhNone.

This property was introduced in Qt 4.6.

Access functions:

Qt::InputMethodHints	inputMethodHints() const
void	setInputMethodHints(Qt::InputMethodHints hints)

See also inputMethodQuery().

pub unsafe fn input_method_query( &self, arg1: InputMethodQuery, ) -> CppBox<QVariant>

This method is only relevant for input widgets. It is used by the input method to query a set of properties of the widget to be able to support complex input method operations as support for surrounding text and reconversions.

Calls C++ function: virtual QVariant QWidget::inputMethodQuery(Qt::InputMethodQuery arg1) const.

C++ documentation:

This method is only relevant for input widgets. It is used by the input method to query a set of properties of the widget to be able to support complex input method operations as support for surrounding text and reconversions.

query specifies which property is queried.

See also inputMethodEvent(), QInputMethodEvent, QInputMethodQueryEvent, and inputMethodHints.

pub unsafe fn insert_action( &self, before: impl CastInto<Ptr<QAction>>, action: impl CastInto<Ptr<QAction>>, )

Inserts the action action to this widget's list of actions, before the action before. It appends the action if before is 0 or before is not a valid action for this widget.

Calls C++ function: void QWidget::insertAction(QAction* before, QAction* action).

C++ documentation:

Inserts the action action to this widget’s list of actions, before the action before. It appends the action if before is 0 or before is not a valid action for this widget.

A QWidget should only have one of each action.

See also removeAction(), addAction(), QMenu, contextMenuPolicy, and actions().

pub unsafe fn insert_actions( &self, before: impl CastInto<Ptr<QAction>>, actions: impl CastInto<Ref<QListOfQAction>>, )

Inserts the actions actions to this widget's list of actions, before the action before. It appends the action if before is 0 or before is not a valid action for this widget.

Calls C++ function: void QWidget::insertActions(QAction* before, QList<QAction*> actions).

C++ documentation:

Inserts the actions actions to this widget’s list of actions, before the action before. It appends the action if before is 0 or before is not a valid action for this widget.

A QWidget can have at most one of each action.

See also removeAction(), QMenu, insertAction(), and contextMenuPolicy.

pub unsafe fn internal_win_id(&self) -> c_ulonglong

Calls C++ function: unsigned long long QWidget::internalWinId() const.

pub unsafe fn is_active_window(&self) -> bool

This property holds whether this widget's window is the active window

Calls C++ function: bool QWidget::isActiveWindow() const.

C++ documentation:

This property holds whether this widget’s window is the active window

The active window is the window that contains the widget that has keyboard focus (The window may still have focus if it has no widgets or none of its widgets accepts keyboard focus).

When popup windows are visible, this property is true for both the active window and for the popup.

By default, this property is false.

Access functions:

bool	isActiveWindow() const

See also activateWindow() and QApplication::activeWindow().

pub unsafe fn is_ancestor_of(&self, child: impl CastInto<Ptr<QWidget>>) -> bool

Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.

Calls C++ function: bool QWidget::isAncestorOf(const QWidget* child) const.

C++ documentation:

Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.

pub unsafe fn is_enabled(&self) -> bool

This property holds whether the widget is enabled

Calls C++ function: bool QWidget::isEnabled() const.

C++ documentation:

This property holds whether the widget is enabled

In general an enabled widget handles keyboard and mouse events; a disabled widget does not. An exception is made with QAbstractButton.

Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can use the changeEvent() with type QEvent::EnabledChange.

Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. It it not possible to explicitly enable a child widget which is not a window while its parent widget remains disabled.

By default, this property is true.

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

See also isEnabledTo(), QKeyEvent, QMouseEvent, and changeEvent().

pub unsafe fn is_enabled_to(&self, arg1: impl CastInto<Ptr<QWidget>>) -> bool

Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.

Calls C++ function: bool QWidget::isEnabledTo(const QWidget* arg1) const.

C++ documentation:

Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.

This is the case if neither the widget itself nor every parent up to but excluding ancestor has been explicitly disabled.

isEnabledTo(0) returns false if this widget or any if its ancestors was explicitly disabled.

The word ancestor here means a parent widget within the same window.

Therefore isEnabledTo(0) stops at this widget's window, unlike isEnabled() which also takes parent windows into considerations.

See also setEnabled() and enabled.

pub unsafe fn is_enabled_to_t_l_w(&self) -> bool

This function is deprecated. It is equivalent to isEnabled()

Calls C++ function: bool QWidget::isEnabledToTLW() const.

C++ documentation:

This function is deprecated. It is equivalent to isEnabled()

pub unsafe fn is_full_screen(&self) -> bool

This property holds whether the widget is shown in full screen mode

Calls C++ function: bool QWidget::isFullScreen() const.

C++ documentation:

This property holds whether the widget is shown in full screen mode

A widget in full screen mode occupies the whole screen area and does not display window decorations, such as a title bar.

By default, this property is false.

Access functions:

bool	isFullScreen() const

See also windowState(), minimized, and maximized.

pub unsafe fn is_hidden(&self) -> bool

Returns true if the widget is hidden, otherwise returns false.

Calls C++ function: bool QWidget::isHidden() const.

C++ documentation:

Returns true if the widget is hidden, otherwise returns false.

A hidden widget will only become visible when show() is called on it. It will not be automatically shown when the parent is shown.

To check visibility, use !isVisible() instead (notice the exclamation mark).

isHidden() implies !isVisible(), but a widget can be not visible and not hidden at the same time. This is the case for widgets that are children of widgets that are not visible.

Widgets are hidden if:

• they were created as independent windows,
• they were created as children of visible widgets,
• hide() or setVisible(false) was called.

pub unsafe fn is_left_to_right(&self) -> bool

Calls C++ function: bool QWidget::isLeftToRight() const.

pub unsafe fn is_maximized(&self) -> bool

This property holds whether this widget is maximized

Calls C++ function: bool QWidget::isMaximized() const.

C++ documentation:

This property holds whether this widget is maximized

This property is only relevant for windows.

Note: Due to limitations on some window systems, this does not always report the expected results (e.g., if the user on X11 maximizes the window via the window manager, Qt has no way of distinguishing this from any other resize). This is expected to improve as window manager protocols evolve.

By default, this property is false.

Access functions:

bool	isMaximized() const

See also windowState(), showMaximized(), visible, show(), hide(), showNormal(), and minimized.

pub unsafe fn is_minimized(&self) -> bool

This property holds whether this widget is minimized (iconified)

Calls C++ function: bool QWidget::isMinimized() const.

C++ documentation:

This property holds whether this widget is minimized (iconified)

This property is only relevant for windows.

By default, this property is false.

Access functions:

bool	isMinimized() const

See also showMinimized(), visible, show(), hide(), showNormal(), and maximized.

pub unsafe fn is_modal(&self) -> bool

This property holds whether the widget is a modal widget

Calls C++ function: bool QWidget::isModal() const.

C++ documentation:

This property holds whether the widget is a modal widget

This property only makes sense for windows. A modal widget prevents widgets in all other windows from getting any input.

By default, this property is false.

Access functions:

bool	isModal() const

See also isWindow(), windowModality, and QDialog.

pub unsafe fn is_right_to_left(&self) -> bool

Calls C++ function: bool QWidget::isRightToLeft() const.

pub unsafe fn is_top_level(&self) -> bool

Use isWindow() instead.

Calls C++ function: bool QWidget::isTopLevel() const.

C++ documentation:

Use isWindow() instead.

pub unsafe fn is_visible(&self) -> bool

This property holds whether the widget is visible

Calls C++ function: bool QWidget::isVisible() const.

C++ documentation:

This property holds whether the widget is visible

Calling setVisible(true) or show() sets the widget to visible status if all its parent widgets up to the window are visible. If an ancestor is not visible, the widget won't become visible until all its ancestors are shown. If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. If the widget has not been resized yet, Qt will adjust the widget's size to a useful default using adjustSize().

Calling setVisible(false) or hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it.

A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames.

A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified windows and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again.

You almost never have to reimplement the setVisible() function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use the Polish event delivered to the event() function.

Access functions:

bool	isVisible() const
virtual void	setVisible(bool visible)

See also show(), hide(), isHidden(), isVisibleTo(), isMinimized(), showEvent(), and hideEvent().

pub unsafe fn is_visible_to(&self, arg1: impl CastInto<Ptr<QWidget>>) -> bool

Returns true if this widget would become visible if ancestor is shown; otherwise returns false.

Calls C++ function: bool QWidget::isVisibleTo(const QWidget* arg1) const.

C++ documentation:

Returns true if this widget would become visible if ancestor is shown; otherwise returns false.

The true case occurs if neither the widget itself nor any parent up to but excluding ancestor has been explicitly hidden.

This function will still return true if the widget is obscured by other windows on the screen, but could be physically visible if it or they were to be moved.

isVisibleTo(0) is identical to isVisible().

See also show(), hide(), and isVisible().

pub unsafe fn is_window(&self) -> bool

Returns true if the widget is an independent window, otherwise returns false.

Calls C++ function: bool QWidget::isWindow() const.

C++ documentation:

Returns true if the widget is an independent window, otherwise returns false.

A window is a widget that isn't visually the child of any other widget and that usually has a frame and a window title.

A window can have a parent widget. It will then be grouped with its parent and deleted when the parent is deleted, minimized when the parent is minimized etc. If supported by the window manager, it will also have a common taskbar entry with its parent.

QDialog and QMainWindow widgets are by default windows, even if a parent widget is specified in the constructor. This behavior is specified by the Qt::Window flag.

See also window(), isModal(), and parentWidget().

pub unsafe fn is_window_modified(&self) -> bool

This property holds whether the document shown in the window has unsaved changes

Calls C++ function: bool QWidget::isWindowModified() const.

C++ documentation:

This property holds whether the document shown in the window has unsaved changes

A modified window is a window whose content has changed but has not been saved to disk. This flag will have different effects varied by the platform. On macOS the close button will have a modified look; on other platforms, the window title will have an '*' (asterisk).

The window title must contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the window isn't modified, the placeholder is simply removed.

Note that if a widget is set as modified, all its ancestors will also be set as modified. However, if you call setWindowModified(false) on a widget, this will not propagate to its parent because other children of the parent might have been modified.

Access functions:

bool	isWindowModified() const
void	setWindowModified(bool)

See also windowTitle, Application Example, SDI Example, and MDI Example.

pub unsafe fn layout(&self) -> QPtr<QLayout>

Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed.

Calls C++ function: QLayout* QWidget::layout() const.

C++ documentation:

Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed.

The layout manager sets the geometry of the widget's children that have been added to the layout.

See also setLayout(), sizePolicy(), and Layout Management.

pub unsafe fn layout_direction(&self) -> LayoutDirection

This property holds the layout direction for this widget

Calls C++ function: Qt::LayoutDirection QWidget::layoutDirection() const.

C++ documentation:

This property holds the layout direction for this widget

By default, this property is set to Qt::LeftToRight.

When the layout direction is set on a widget, it will propagate to the widget's children, but not to a child that is a window and not to a child for which setLayoutDirection() has been explicitly called. Also, child widgets added after setLayoutDirection() has been called for the parent do not inherit the parent's layout direction.

This method no longer affects text layout direction since Qt 4.7.

Access functions:

Qt::LayoutDirection	layoutDirection() const
void	setLayoutDirection(Qt::LayoutDirection direction)
void	unsetLayoutDirection()

See also QApplication::layoutDirection.

pub unsafe fn locale(&self) -> CppBox<QLocale>

This property holds the widget's locale

Calls C++ function: QLocale QWidget::locale() const.

C++ documentation:

This property holds the widget’s locale

As long as no special locale has been set, this is either the parent's locale or (if this widget is a top level widget), the default locale.

If the widget displays dates or numbers, these should be formatted using the widget's locale.

This property was introduced in Qt 4.3.

Access functions:

QLocale	locale() const
void	setLocale(const QLocale &locale)
void	unsetLocale()

See also QLocale and QLocale::setDefault().

pub unsafe fn lower(&self)

Lowers the widget to the bottom of the parent widget's stack.

Calls C++ function: [slot] void QWidget::lower().

C++ documentation:

Lowers the widget to the bottom of the parent widget’s stack.

After this call the widget will be visually behind (and therefore obscured by) any overlapping sibling widgets.

See also raise() and stackUnder().

pub unsafe fn map_from( &self, arg1: impl CastInto<Ptr<QWidget>>, arg2: impl CastInto<Ref<QPoint>>, ) -> CppBox<QPoint>

Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. The parent must not be 0 and must be a parent of the calling widget.

Calls C++ function: QPoint QWidget::mapFrom(const QWidget* arg1, const QPoint& arg2) const.

C++ documentation:

Translates the widget coordinate pos from the coordinate system of parent to this widget’s coordinate system. The parent must not be 0 and must be a parent of the calling widget.

See also mapTo(), mapFromParent(), mapFromGlobal(), and underMouse().

pub unsafe fn map_from_global( &self, arg1: impl CastInto<Ref<QPoint>>, ) -> CppBox<QPoint>

Translates the global screen coordinate pos to widget coordinates.

Calls C++ function: QPoint QWidget::mapFromGlobal(const QPoint& arg1) const.

C++ documentation:

Translates the global screen coordinate pos to widget coordinates.

See also mapToGlobal(), mapFrom(), and mapFromParent().

pub unsafe fn map_from_parent( &self, arg1: impl CastInto<Ref<QPoint>>, ) -> CppBox<QPoint>

Translates the parent widget coordinate pos to widget coordinates.

Calls C++ function: QPoint QWidget::mapFromParent(const QPoint& arg1) const.

C++ documentation:

Translates the parent widget coordinate pos to widget coordinates.

Same as mapFromGlobal() if the widget has no parent.

See also mapToParent(), mapFrom(), mapFromGlobal(), and underMouse().

pub unsafe fn map_to( &self, arg1: impl CastInto<Ptr<QWidget>>, arg2: impl CastInto<Ref<QPoint>>, ) -> CppBox<QPoint>

Translates the widget coordinate pos to the coordinate system of parent. The parent must not be 0 and must be a parent of the calling widget.

Calls C++ function: QPoint QWidget::mapTo(const QWidget* arg1, const QPoint& arg2) const.

C++ documentation:

Translates the widget coordinate pos to the coordinate system of parent. The parent must not be 0 and must be a parent of the calling widget.

See also mapFrom(), mapToParent(), mapToGlobal(), and underMouse().

pub unsafe fn map_to_global( &self, arg1: impl CastInto<Ref<QPoint>>, ) -> CppBox<QPoint>

Translates the widget coordinate pos to global screen coordinates. For example, mapToGlobal(QPoint(0,0)) would give the global coordinates of the top-left pixel of the widget.

Calls C++ function: QPoint QWidget::mapToGlobal(const QPoint& arg1) const.

C++ documentation:

Translates the widget coordinate pos to global screen coordinates. For example, mapToGlobal(QPoint(0,0)) would give the global coordinates of the top-left pixel of the widget.

See also mapFromGlobal(), mapTo(), and mapToParent().

pub unsafe fn map_to_parent( &self, arg1: impl CastInto<Ref<QPoint>>, ) -> CppBox<QPoint>

Translates the widget coordinate pos to a coordinate in the parent widget.

Calls C++ function: QPoint QWidget::mapToParent(const QPoint& arg1) const.

C++ documentation:

Translates the widget coordinate pos to a coordinate in the parent widget.

Same as mapToGlobal() if the widget has no parent.

See also mapFromParent(), mapTo(), mapToGlobal(), and underMouse().

pub unsafe fn mask(&self) -> CppBox<QRegion>

Returns the mask currently set on a widget. If no mask is set the return value will be an empty region.

Calls C++ function: QRegion QWidget::mask() const.

C++ documentation:

Returns the mask currently set on a widget. If no mask is set the return value will be an empty region.

See also setMask(), clearMask(), QRegion::isEmpty(), and Shaped Clock Example.

pub unsafe fn maximum_height(&self) -> c_int

This property holds the widget's maximum height in pixels

Calls C++ function: int QWidget::maximumHeight() const.

C++ documentation:

This property holds the widget’s maximum height in pixels

This property corresponds to the height held by the maximumSize property.

By default, this property contains a value of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

int	maximumHeight() const
void	setMaximumHeight(int maxh)

See also maximumSize and maximumWidth.

pub unsafe fn maximum_size(&self) -> CppBox<QSize>

This property holds the widget's maximum size in pixels

Calls C++ function: QSize QWidget::maximumSize() const.

C++ documentation:

This property holds the widget’s maximum size in pixels

The widget cannot be resized to a larger size than the maximum widget size.

By default, this property contains a size in which both width and height have values of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

QSize	maximumSize() const
void	setMaximumSize(const QSize &)
void	setMaximumSize(int maxw, int maxh)

See also maximumWidth, maximumHeight, minimumSize, and sizeIncrement.

pub unsafe fn maximum_width(&self) -> c_int

This property holds the widget's maximum width in pixels

Calls C++ function: int QWidget::maximumWidth() const.

C++ documentation:

This property holds the widget’s maximum width in pixels

This property corresponds to the width held by the maximumSize property.

By default, this property contains a value of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

int	maximumWidth() const
void	setMaximumWidth(int maxw)

See also maximumSize and maximumHeight.

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

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

pub unsafe fn minimum_height(&self) -> c_int

This property holds the widget's minimum height in pixels

Calls C++ function: int QWidget::minimumHeight() const.

C++ documentation:

This property holds the widget’s minimum height in pixels

This property corresponds to the height held by the minimumSize property.

By default, this property has a value of 0.

Access functions:

int	minimumHeight() const
void	setMinimumHeight(int minh)

See also minimumSize and minimumWidth.

pub unsafe fn minimum_size(&self) -> CppBox<QSize>

This property holds the widget's minimum size

Calls C++ function: QSize QWidget::minimumSize() const.

C++ documentation:

This property holds the widget’s minimum size

The widget cannot be resized to a smaller size than the minimum widget size. The widget's size is forced to the minimum size if the current size is smaller.

The minimum size set by this function will override the minimum size defined by QLayout. In order to unset the minimum size, use a value of QSize(0, 0).

By default, this property contains a size with zero width and height.

Access functions:

QSize	minimumSize() const
void	setMinimumSize(const QSize &)
void	setMinimumSize(int minw, int minh)

See also minimumWidth, minimumHeight, maximumSize, and sizeIncrement.

pub unsafe fn minimum_size_hint(&self) -> CppBox<QSize>

This property holds the recommended minimum size for the widget

Calls C++ function: virtual QSize QWidget::minimumSizeHint() const.

C++ documentation:

This property holds the recommended minimum size for the widget

If the value of this property is an invalid size, no minimum size is recommended.

The default implementation of minimumSizeHint() returns an invalid size if there is no layout for this widget, and returns the layout's minimum size otherwise. Most built-in widgets reimplement minimumSizeHint().

QLayout will never resize a widget to a size smaller than the minimum size hint unless minimumSize() is set or the size policy is set to QSizePolicy::Ignore. If minimumSize() is set, the minimum size hint will be ignored.

Access functions:

virtual QSize

minimumSizeHint() const

See also QSize::isValid(), resize(), setMinimumSize(), and sizePolicy().

pub unsafe fn minimum_width(&self) -> c_int

This property holds the widget's minimum width in pixels

Calls C++ function: int QWidget::minimumWidth() const.

C++ documentation:

This property holds the widget’s minimum width in pixels

This property corresponds to the width held by the minimumSize property.

By default, this property has a value of 0.

Access functions:

int	minimumWidth() const
void	setMinimumWidth(int minw)

See also minimumSize and minimumHeight.

pub unsafe fn move_2a(&self, x: c_int, y: c_int)

This property holds the position of the widget within its parent widget

Calls C++ function: void QWidget::move(int x, int y).

C++ documentation:

This property holds the position of the widget within its parent widget

If the widget is a window, the position is that of the widget on the desktop, including its frame.

When changing the position, the widget, if visible, receives a move event (moveEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

By default, this property contains a position that refers to the origin.

Warning: Calling move() or setGeometry() inside moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

Access functions:

QPoint	pos() const
void	move(int x, int y)
void	move(const QPoint &)

See also frameGeometry, size, x(), and y().

pub unsafe fn move_1a(&self, arg1: impl CastInto<Ref<QPoint>>)

This property holds the position of the widget within its parent widget

Calls C++ function: void QWidget::move(const QPoint& arg1).

C++ documentation:

This property holds the position of the widget within its parent widget

If the widget is a window, the position is that of the widget on the desktop, including its frame.

When changing the position, the widget, if visible, receives a move event (moveEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

By default, this property contains a position that refers to the origin.

Warning: Calling move() or setGeometry() inside moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

Access functions:

QPoint	pos() const
void	move(int x, int y)
void	move(const QPoint &)

See also frameGeometry, size, x(), and y().

pub unsafe fn native_parent_widget(&self) -> QPtr<QWidget>

Returns the native parent for this widget, i.e. the next ancestor widget that has a system identifier, or 0 if it does not have any native parent.

Calls C++ function: QWidget* QWidget::nativeParentWidget() const.

C++ documentation:

Returns the native parent for this widget, i.e. the next ancestor widget that has a system identifier, or 0 if it does not have any native parent.

This function was introduced in Qt 4.4.

See also effectiveWinId().

pub unsafe fn next_in_focus_chain(&self) -> QPtr<QWidget>

Returns the next widget in this widget's focus chain.

Calls C++ function: QWidget* QWidget::nextInFocusChain() const.

C++ documentation:

Returns the next widget in this widget’s focus chain.

See also previousInFocusChain().

pub unsafe fn normal_geometry(&self) -> CppBox<QRect>

This property holds the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget

Calls C++ function: QRect QWidget::normalGeometry() const.

C++ documentation:

This property holds the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget

For child widgets this property always holds an empty rectangle.

By default, this property contains an empty rectangle.

Access functions:

QRect

normalGeometry() const

See also QWidget::windowState() and QWidget::geometry.

pub unsafe fn override_window_flags(&self, type_: QFlags<WindowType>)

Sets the window flags for the widget to flags, without telling the window system.

Calls C++ function: void QWidget::overrideWindowFlags(QFlags<Qt::WindowType> type).

C++ documentation:

Sets the window flags for the widget to flags, without telling the window system.

Warning: Do not call this function unless you really know what you're doing.

See also setWindowFlags().

pub unsafe fn override_window_state(&self, state: QFlags<WindowState>)

Calls C++ function: void QWidget::overrideWindowState(QFlags<Qt::WindowState> state).

pub unsafe fn paint_engine(&self) -> Ptr<QPaintEngine>

Reimplemented from QPaintDevice::paintEngine().

Calls C++ function: virtual QPaintEngine* QWidget::paintEngine() const.

C++ documentation:

Reimplemented from QPaintDevice::paintEngine().

Returns the widget's paint engine.

Note that this function should not be called explicitly by the user, since it's meant for reimplementation purposes only. The function is called by Qt internally, and the default implementation may not always return a valid pointer.

pub unsafe fn palette(&self) -> Ref<QPalette>

This property holds the widget's palette

Calls C++ function: const QPalette& QWidget::palette() const.

C++ documentation:

This property holds the widget’s palette

This property describes the widget's palette. The palette is used by the widget's style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform's look and feel. It's common that different platforms, or different styles, have different palettes.

When you assign a new palette to a widget, the color roles from this palette are combined with the widget's default palette to form the widget's final palette. The palette entry for the widget's background role is used to fill the widget's background (see QWidget::autoFillBackground), and the foreground role initializes QPainter's pen.

The default depends on the system environment. QApplication maintains a system/theme palette which serves as a default for all widgets. There may also be special palette defaults for certain types of widgets (e.g., on Windows XP and Vista, all classes that derive from QMenuBar have a special default palette). You can also define default palettes for widgets yourself by passing a custom palette and the name of a widget to QApplication::setPalette(). Finally, the style always has the option of polishing the palette as it's assigned (see QStyle::polish()).

QWidget propagates explicit palette roles from parent to child. If you assign a brush or color to a specific role on a palette and assign that palette to a widget, that role will propagate to all the widget's children, overriding any system defaults for that role. Note that palettes by default don't propagate to windows (see isWindow()) unless the Qt::WA_WindowPropagation attribute is enabled.

QWidget's palette propagation is similar to its font propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose colors and brushes from the widget palette, or in some cases, to ignore the palette (partially, or completely). In particular, certain styles like GTK style, Mac style, Windows XP, and Vista style, depend on third party APIs to render the content of widgets, and these styles typically do not follow the palette. Because of this, assigning roles to a widget's palette is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet. You can refer to our Knowledge Base article here for more information.

Warning: Do not use this function in conjunction with Qt Style Sheets. When using style sheets, the palette of a widget can be customized using the "color", "background-color", "selection-color", "selection-background-color" and "alternate-background-color".

Access functions:

const QPalette &	palette() const
void	setPalette(const QPalette &)

See also QApplication::palette() and QWidget::font().

pub unsafe fn parent_widget(&self) -> QPtr<QWidget>

Returns the parent of this widget, or 0 if it does not have any parent widget.

Calls C++ function: QWidget* QWidget::parentWidget() const.

C++ documentation:

Returns the parent of this widget, or 0 if it does not have any parent widget.

pub unsafe fn pos(&self) -> CppBox<QPoint>

This property holds the position of the widget within its parent widget

Calls C++ function: QPoint QWidget::pos() const.

C++ documentation:

This property holds the position of the widget within its parent widget

If the widget is a window, the position is that of the widget on the desktop, including its frame.

When changing the position, the widget, if visible, receives a move event (moveEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

By default, this property contains a position that refers to the origin.

Warning: Calling move() or setGeometry() inside moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

Access functions:

QPoint	pos() const
void	move(int x, int y)
void	move(const QPoint &)

See also frameGeometry, size, x(), and y().

pub unsafe fn previous_in_focus_chain(&self) -> QPtr<QWidget>

The previousInFocusChain function returns the previous widget in this widget's focus chain.

Calls C++ function: QWidget* QWidget::previousInFocusChain() const.

C++ documentation:

The previousInFocusChain function returns the previous widget in this widget’s focus chain.

This function was introduced in Qt 4.6.

See also nextInFocusChain().

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

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

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

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

pub unsafe fn raise(&self)

Raises this widget to the top of the parent widget's stack.

Calls C++ function: [slot] void QWidget::raise().

C++ documentation:

Raises this widget to the top of the parent widget’s stack.

After this call the widget will be visually in front of any overlapping sibling widgets.

Note: When using activateWindow(), you can call this function to ensure that the window is stacked on top.

See also lower() and stackUnder().

pub unsafe fn rect(&self) -> CppBox<QRect>

This property holds the internal geometry of the widget excluding any window frame

Calls C++ function: QRect QWidget::rect() const.

C++ documentation:

This property holds the internal geometry of the widget excluding any window frame

The rect property equals QRect(0, 0, width(), height()).

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

QRect

rect() const

See also size.

pub unsafe fn release_keyboard(&self)

Releases the keyboard grab.

Calls C++ function: void QWidget::releaseKeyboard().

C++ documentation:

Releases the keyboard grab.

See also grabKeyboard(), grabMouse(), and releaseMouse().

pub unsafe fn release_mouse(&self)

Releases the mouse grab.

Calls C++ function: void QWidget::releaseMouse().

C++ documentation:

Releases the mouse grab.

See also grabMouse(), grabKeyboard(), and releaseKeyboard().

pub unsafe fn release_shortcut(&self, id: c_int)

Removes the shortcut with the given id from Qt's shortcut system. The widget will no longer receive QEvent::Shortcut events for the shortcut's key sequence (unless it has other shortcuts with the same key sequence).

Calls C++ function: void QWidget::releaseShortcut(int id).

C++ documentation:

Removes the shortcut with the given id from Qt’s shortcut system. The widget will no longer receive QEvent::Shortcut events for the shortcut’s key sequence (unless it has other shortcuts with the same key sequence).

Warning: You should not normally need to use this function since Qt's shortcut system removes shortcuts automatically when their parent widget is destroyed. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function. Note also that this is an expensive operation.

See also grabShortcut() and setShortcutEnabled().

pub unsafe fn remove_action(&self, action: impl CastInto<Ptr<QAction>>)

Removes the action action from this widget's list of actions.

Calls C++ function: void QWidget::removeAction(QAction* action).

C++ documentation:

Removes the action action from this widget’s list of actions.

See also insertAction(), actions(), and insertAction().

pub unsafe fn render_q_paint_device_q_point_q_region_q_flags_render_flag( &self, target: impl CastInto<Ptr<QPaintDevice>>, target_offset: impl CastInto<Ref<QPoint>>, source_region: impl CastInto<Ref<QRegion>>, render_flags: QFlags<RenderFlag>, )

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

Calls C++ function: void QWidget::render(QPaintDevice* target, const QPoint& targetOffset = …, const QRegion& sourceRegion = …, QFlags<QWidget::RenderFlag> renderFlags = …).

C++ documentation:

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

  QPixmap pixmap(widget->size());
  widget->render(&pixmap);

If sourceRegion is a null region, this function will use QWidget::rect() as the region, i.e. the entire widget.

Ensure that you call QPainter::end() for the target device's active painter (if any) before rendering. For example:

QPainter painter(this);
...
painter.end();
myWidget->render(this);

Note: To obtain the contents of a QOpenGLWidget, use QOpenGLWidget::grabFramebuffer() instead.

Note: To obtain the contents of a QGLWidget (deprecated), use QGLWidget::grabFrameBuffer() or QGLWidget::renderPixmap() instead.

This function was introduced in Qt 4.3.

pub unsafe fn render_q_painter_q_point_q_region_q_flags_render_flag( &self, painter: impl CastInto<Ptr<QPainter>>, target_offset: impl CastInto<Ref<QPoint>>, source_region: impl CastInto<Ref<QRegion>>, render_flags: QFlags<RenderFlag>, )

This is an overloaded function.

Calls C++ function: void QWidget::render(QPainter* painter, const QPoint& targetOffset = …, const QRegion& sourceRegion = …, QFlags<QWidget::RenderFlag> renderFlags = …).

C++ documentation:

This is an overloaded function.

Renders the widget into the painter's QPainter::device().

Transformations and settings applied to the painter will be used when rendering.

Note: The painter must be active. On macOS the widget will be rendered into a QPixmap and then drawn by the painter.

See also QPainter::device().

pub unsafe fn render_q_paint_device_q_point_q_region( &self, target: impl CastInto<Ptr<QPaintDevice>>, target_offset: impl CastInto<Ref<QPoint>>, source_region: impl CastInto<Ref<QRegion>>, )

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

Calls C++ function: void QWidget::render(QPaintDevice* target, const QPoint& targetOffset = …, const QRegion& sourceRegion = …).

C++ documentation:

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

  QPixmap pixmap(widget->size());
  widget->render(&pixmap);

If sourceRegion is a null region, this function will use QWidget::rect() as the region, i.e. the entire widget.

Ensure that you call QPainter::end() for the target device's active painter (if any) before rendering. For example:

QPainter painter(this);
...
painter.end();
myWidget->render(this);

Note: To obtain the contents of a QOpenGLWidget, use QOpenGLWidget::grabFramebuffer() instead.

Note: To obtain the contents of a QGLWidget (deprecated), use QGLWidget::grabFrameBuffer() or QGLWidget::renderPixmap() instead.

This function was introduced in Qt 4.3.

pub unsafe fn render_q_paint_device_q_point( &self, target: impl CastInto<Ptr<QPaintDevice>>, target_offset: impl CastInto<Ref<QPoint>>, )

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

Calls C++ function: void QWidget::render(QPaintDevice* target, const QPoint& targetOffset = …).

C++ documentation:

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

  QPixmap pixmap(widget->size());
  widget->render(&pixmap);

If sourceRegion is a null region, this function will use QWidget::rect() as the region, i.e. the entire widget.

Ensure that you call QPainter::end() for the target device's active painter (if any) before rendering. For example:

QPainter painter(this);
...
painter.end();
myWidget->render(this);

Note: To obtain the contents of a QOpenGLWidget, use QOpenGLWidget::grabFramebuffer() instead.

Note: To obtain the contents of a QGLWidget (deprecated), use QGLWidget::grabFrameBuffer() or QGLWidget::renderPixmap() instead.

This function was introduced in Qt 4.3.

pub unsafe fn render_q_paint_device( &self, target: impl CastInto<Ptr<QPaintDevice>>, )

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

Calls C++ function: void QWidget::render(QPaintDevice* target).

C++ documentation:

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

  QPixmap pixmap(widget->size());
  widget->render(&pixmap);

If sourceRegion is a null region, this function will use QWidget::rect() as the region, i.e. the entire widget.

Ensure that you call QPainter::end() for the target device's active painter (if any) before rendering. For example:

QPainter painter(this);
...
painter.end();
myWidget->render(this);

Note: To obtain the contents of a QOpenGLWidget, use QOpenGLWidget::grabFramebuffer() instead.

Note: To obtain the contents of a QGLWidget (deprecated), use QGLWidget::grabFrameBuffer() or QGLWidget::renderPixmap() instead.

This function was introduced in Qt 4.3.

pub unsafe fn render_q_painter_q_point_q_region( &self, painter: impl CastInto<Ptr<QPainter>>, target_offset: impl CastInto<Ref<QPoint>>, source_region: impl CastInto<Ref<QRegion>>, )

This is an overloaded function.

Calls C++ function: void QWidget::render(QPainter* painter, const QPoint& targetOffset = …, const QRegion& sourceRegion = …).

C++ documentation:

This is an overloaded function.

Renders the widget into the painter's QPainter::device().

Transformations and settings applied to the painter will be used when rendering.

Note: The painter must be active. On macOS the widget will be rendered into a QPixmap and then drawn by the painter.

See also QPainter::device().

pub unsafe fn render_q_painter_q_point( &self, painter: impl CastInto<Ptr<QPainter>>, target_offset: impl CastInto<Ref<QPoint>>, )

This is an overloaded function.

Calls C++ function: void QWidget::render(QPainter* painter, const QPoint& targetOffset = …).

C++ documentation:

This is an overloaded function.

Renders the widget into the painter's QPainter::device().

Transformations and settings applied to the painter will be used when rendering.

Note: The painter must be active. On macOS the widget will be rendered into a QPixmap and then drawn by the painter.

See also QPainter::device().

pub unsafe fn render_q_painter(&self, painter: impl CastInto<Ptr<QPainter>>)

This is an overloaded function.

Calls C++ function: void QWidget::render(QPainter* painter).

C++ documentation:

This is an overloaded function.

Renders the widget into the painter's QPainter::device().

Transformations and settings applied to the painter will be used when rendering.

Note: The painter must be active. On macOS the widget will be rendered into a QPixmap and then drawn by the painter.

See also QPainter::device().

pub unsafe fn repaint(&self)

Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

Calls C++ function: [slot] void QWidget::repaint().

C++ documentation:

Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

We suggest only using repaint() if you need an immediate repaint, for example during animation. In almost all circumstances update() is better, as it permits Qt to optimize for speed and minimize flicker.

Warning: If you call repaint() in a function which may itself be called from paintEvent(), you may get infinite recursion. The update() function never causes recursion.

See also update(), paintEvent(), and setUpdatesEnabled().

pub unsafe fn repaint_4_int(&self, x: c_int, y: c_int, w: c_int, h: c_int)

This is an overloaded function.

Calls C++ function: void QWidget::repaint(int x, int y, int w, int h).

C++ documentation:

This is an overloaded function.

This version repaints a rectangle (x, y, w, h) inside the widget.

If w is negative, it is replaced with width() - x, and if h is negative, it is replaced width height() - y.

pub unsafe fn repaint_q_rect(&self, arg1: impl CastInto<Ref<QRect>>)

This is an overloaded function.

Calls C++ function: void QWidget::repaint(const QRect& arg1).

C++ documentation:

This is an overloaded function.

This version repaints a rectangle rect inside the widget.

pub unsafe fn repaint_q_region(&self, arg1: impl CastInto<Ref<QRegion>>)

This is an overloaded function.

Calls C++ function: void QWidget::repaint(const QRegion& arg1).

C++ documentation:

This is an overloaded function.

This version repaints a region rgn inside the widget.

pub unsafe fn resize_2a(&self, w: c_int, h: c_int)

This property holds the size of the widget excluding any window frame

Calls C++ function: void QWidget::resize(int w, int h).

C++ documentation:

This property holds the size of the widget excluding any window frame

If the widget is visible when it is being resized, it receives a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize().

By default, this property contains a value that depends on the user's platform and screen geometry.

Warning: Calling resize() or setGeometry() inside resizeEvent() can lead to infinite recursion.

Note: Setting the size to QSize(0, 0) will cause the widget to not appear on screen. This also applies to windows.

Access functions:

QSize	size() const
void	resize(int w, int h)
void	resize(const QSize &)

See also pos, geometry, minimumSize, maximumSize, resizeEvent(), and adjustSize().

pub unsafe fn resize_1a(&self, arg1: impl CastInto<Ref<QSize>>)

This property holds the size of the widget excluding any window frame

Calls C++ function: void QWidget::resize(const QSize& arg1).

C++ documentation:

This property holds the size of the widget excluding any window frame

If the widget is visible when it is being resized, it receives a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize().

By default, this property contains a value that depends on the user's platform and screen geometry.

Warning: Calling resize() or setGeometry() inside resizeEvent() can lead to infinite recursion.

Note: Setting the size to QSize(0, 0) will cause the widget to not appear on screen. This also applies to windows.

Access functions:

QSize	size() const
void	resize(int w, int h)
void	resize(const QSize &)

See also pos, geometry, minimumSize, maximumSize, resizeEvent(), and adjustSize().

pub unsafe fn restore_geometry( &self, geometry: impl CastInto<Ref<QByteArray>>, ) -> bool

Restores the geometry and state of top-level widgets stored in the byte array geometry. Returns true on success; otherwise returns false.

Calls C++ function: bool QWidget::restoreGeometry(const QByteArray& geometry).

C++ documentation:

Restores the geometry and state of top-level widgets stored in the byte array geometry. Returns true on success; otherwise returns false.

If the restored geometry is off-screen, it will be modified to be inside the available screen geometry.

To restore geometry saved using QSettings, you can use code like this:

QSettings settings(“MyCompany”, “MyApp”);
myWidget->restoreGeometry(settings.value(“myWidget/geometry”).toByteArray());

See the Window Geometry documentation for an overview of geometry issues with windows.

Use QMainWindow::restoreState() to restore the geometry and the state of toolbars and dock widgets.

This function was introduced in Qt 4.2.

See also saveGeometry(), QSettings, QMainWindow::saveState(), and QMainWindow::restoreState().

pub unsafe fn save_geometry(&self) -> CppBox<QByteArray>

Saves the current geometry and state for top-level widgets.

Calls C++ function: QByteArray QWidget::saveGeometry() const.

C++ documentation:

Saves the current geometry and state for top-level widgets.

To save the geometry when the window closes, you can implement a close event like this:

void MyWidget::closeEvent(QCloseEvent *event)
{
      QSettings settings(“MyCompany”, “MyApp”);
      settings.setValue(“geometry”, saveGeometry());
      QWidget::closeEvent(event);
}

See the Window Geometry documentation for an overview of geometry issues with windows.

Use QMainWindow::saveState() to save the geometry and the state of toolbars and dock widgets.

This function was introduced in Qt 4.2.

See also restoreGeometry(), QMainWindow::saveState(), and QMainWindow::restoreState().

pub unsafe fn screen(&self) -> QPtr<QScreen>

Available on cpp_lib_version="5.14.0" only.

Returns the screen the widget is on.

Calls C++ function: QScreen* QWidget::screen() const.

C++ documentation:

Returns the screen the widget is on.

This function was introduced in Qt 5.14.

See also windowHandle().

pub unsafe fn scroll_2a(&self, dx: c_int, dy: c_int)

Scrolls the widget including its children dx pixels to the right and dy downward. Both dx and dy may be negative.

Calls C++ function: void QWidget::scroll(int dx, int dy).

C++ documentation:

Scrolls the widget including its children dx pixels to the right and dy downward. Both dx and dy may be negative.

After scrolling, the widgets will receive paint events for the areas that need to be repainted. For widgets that Qt knows to be opaque, this is only the newly exposed parts. For example, if an opaque widget is scrolled 8 pixels to the left, only an 8-pixel wide stripe at the right edge needs updating.

Since widgets propagate the contents of their parents by default, you need to set the autoFillBackground property, or use setAttribute() to set the Qt::WA_OpaquePaintEvent attribute, to make a widget opaque.

For widgets that use contents propagation, a scroll will cause an update of the entire scroll area.

See also Transparency and Double Buffering.

pub unsafe fn scroll_3a( &self, dx: c_int, dy: c_int, arg3: impl CastInto<Ref<QRect>>, )

This is an overloaded function.

Calls C++ function: void QWidget::scroll(int dx, int dy, const QRect& arg3).

C++ documentation:

This is an overloaded function.

This version only scrolls r and does not move the children of the widget.

If r is empty or invalid, the result is undefined.

See also QScrollArea.

pub unsafe fn set_accept_drops(&self, on: bool)

This property holds whether drop events are enabled for this widget

Calls C++ function: void QWidget::setAcceptDrops(bool on).

C++ documentation:

This property holds whether drop events are enabled for this widget

Setting this property to true announces to the system that this widget may be able to accept drop events.

If the widget is the desktop (windowType() == Qt::Desktop), this may fail if another application is using the desktop; you can call acceptDrops() to test if this occurs.

Warning: Do not modify this property in a drag and drop event handler.

By default, this property is false.

Access functions:

bool	acceptDrops() const
void	setAcceptDrops(bool on)

See also Drag and Drop.

pub unsafe fn set_accessible_description( &self, description: impl CastInto<Ref<QString>>, )

This property holds the widget's description as seen by assistive technologies

Calls C++ function: void QWidget::setAccessibleDescription(const QString& description).

C++ documentation:

This property holds the widget’s description as seen by assistive technologies

The accessible description of a widget should convey what a widget does. While the accessibleName should be a short and consise string (e.g. Save), the description should give more context, such as Saves the current document.

This property has to be localized.

By default, this property contains an empty string and Qt falls back to using the tool tip to provide this information.

Access functions:

QString	accessibleDescription() const
void	setAccessibleDescription(const QString &description)

See also QWidget::accessibleName and QAccessibleInterface::text().

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

This property holds the widget's name as seen by assistive technologies

Calls C++ function: void QWidget::setAccessibleName(const QString& name).

C++ documentation:

This property holds the widget’s name as seen by assistive technologies

This is the primary name by which assistive technology such as screen readers announce this widget. For most widgets setting this property is not required. For example for QPushButton the button's text will be used.

It is important to set this property when the widget does not provide any text. For example a button that only contains an icon needs to set this property to work with screen readers. The name should be short and equivalent to the visual information conveyed by the widget.

This property has to be localized.

By default, this property contains an empty string.

Access functions:

QString	accessibleName() const
void	setAccessibleName(const QString &name)

See also QWidget::accessibleDescription and QAccessibleInterface::text().

pub unsafe fn set_attribute_2a(&self, arg1: WidgetAttribute, on: bool)

Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

Calls C++ function: void QWidget::setAttribute(Qt::WidgetAttribute arg1, bool on = …).

C++ documentation:

Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

See also testAttribute().

pub unsafe fn set_attribute_1a(&self, arg1: WidgetAttribute)

Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

Calls C++ function: void QWidget::setAttribute(Qt::WidgetAttribute arg1).

C++ documentation:

Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

See also testAttribute().

pub unsafe fn set_auto_fill_background(&self, enabled: bool)

This property holds whether the widget background is filled automatically

Calls C++ function: void QWidget::setAutoFillBackground(bool enabled).

C++ documentation:

This property holds whether the widget background is filled automatically

If enabled, this property will cause Qt to fill the background of the widget before invoking the paint event. The color used is defined by the QPalette::Window color role from the widget's palette.

In addition, Windows are always filled with QPalette::Window, unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set.

This property cannot be turned off (i.e., set to false) if a widget's parent has a static gradient for its background.

Warning: Use this property with caution in conjunction with Qt Style Sheets. When a widget has a style sheet with a valid background or a border-image, this property is automatically disabled.

By default, this property is false.

This property was introduced in Qt 4.1.

Access functions:

bool	autoFillBackground() const
void	setAutoFillBackground(bool enabled)

See also Qt::WA_OpaquePaintEvent, Qt::WA_NoSystemBackground, and Transparency and Double Buffering.

pub unsafe fn set_background_role(&self, arg1: ColorRole)

Sets the background role of the widget to role.

Calls C++ function: void QWidget::setBackgroundRole(QPalette::ColorRole arg1).

C++ documentation:

Sets the background role of the widget to role.

The background role defines the brush from the widget's palette that is used to render the background.

If role is QPalette::NoRole, then the widget inherits its parent's background role.

Note that styles are free to choose any color from the palette. You can modify the palette or set a style sheet if you don't achieve the result you want with setBackgroundRole().

See also backgroundRole() and foregroundRole().

pub unsafe fn set_base_size_1a(&self, arg1: impl CastInto<Ref<QSize>>)

This property holds the base size of the widget

Calls C++ function: void QWidget::setBaseSize(const QSize& arg1).

C++ documentation:

This property holds the base size of the widget

The base size is used to calculate a proper widget size if the widget defines sizeIncrement().

By default, for a newly-created widget, this property contains a size with zero width and height.

Access functions:

QSize	baseSize() const
void	setBaseSize(const QSize &)
void	setBaseSize(int basew, int baseh)

See also setSizeIncrement().

pub unsafe fn set_base_size_2a(&self, basew: c_int, baseh: c_int)

This property holds the base size of the widget

Calls C++ function: void QWidget::setBaseSize(int basew, int baseh).

C++ documentation:

This property holds the base size of the widget

The base size is used to calculate a proper widget size if the widget defines sizeIncrement().

By default, for a newly-created widget, this property contains a size with zero width and height.

Access functions:

QSize	baseSize() const
void	setBaseSize(const QSize &)
void	setBaseSize(int basew, int baseh)

See also setSizeIncrement().

pub unsafe fn set_contents_margins_4a( &self, left: c_int, top: c_int, right: c_int, bottom: c_int, )

Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. The margins are used by the layout system, and may be used by subclasses to specify the area to draw in (e.g. excluding the frame).

Calls C++ function: void QWidget::setContentsMargins(int left, int top, int right, int bottom).

C++ documentation:

Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. The margins are used by the layout system, and may be used by subclasses to specify the area to draw in (e.g. excluding the frame).

Changing the margins will trigger a resizeEvent().

See also contentsMargins(), contentsRect(), and getContentsMargins().

pub unsafe fn set_contents_margins_1a( &self, margins: impl CastInto<Ref<QMargins>>, )

This is an overloaded function.

Calls C++ function: void QWidget::setContentsMargins(const QMargins& margins).

C++ documentation:

This is an overloaded function.

The setContentsMargins function sets the margins around the widget's contents.

Sets the margins around the contents of the widget to have the sizes determined by margins. The margins are used by the layout system, and may be used by subclasses to specify the area to draw in (e.g. excluding the frame).

Changing the margins will trigger a resizeEvent().

This function was introduced in Qt 4.6.

See also contentsRect() and getContentsMargins().

pub unsafe fn set_context_menu_policy(&self, policy: ContextMenuPolicy)

how the widget shows a context menu

Calls C++ function: void QWidget::setContextMenuPolicy(Qt::ContextMenuPolicy policy).

C++ documentation:

how the widget shows a context menu

The default value of this property is Qt::DefaultContextMenu, which means the contextMenuEvent() handler is called. Other values are Qt::NoContextMenu, Qt::PreventContextMenu, Qt::ActionsContextMenu, and Qt::CustomContextMenu. With Qt::CustomContextMenu, the signal customContextMenuRequested() is emitted.

Access functions:

Qt::ContextMenuPolicy	contextMenuPolicy() const
void	setContextMenuPolicy(Qt::ContextMenuPolicy policy)

See also contextMenuEvent(), customContextMenuRequested(), and actions().

pub unsafe fn set_cursor(&self, arg1: impl CastInto<Ref<QCursor>>)

This property holds the cursor shape for this widget

Calls C++ function: void QWidget::setCursor(const QCursor& arg1).

C++ documentation:

This property holds the cursor shape for this widget

The mouse cursor will assume this shape when it's over this widget. See the list of predefined cursor objects for a range of useful shapes.

An editor widget might use an I-beam cursor:

setCursor(Qt::IBeamCursor);

If no cursor has been set, or after a call to unsetCursor(), the parent's cursor is used.

By default, this property contains a cursor with the Qt::ArrowCursor shape.

Some underlying window implementations will reset the cursor if it leaves a widget even if the mouse is grabbed. If you want to have a cursor set for all widgets, even when outside the window, consider QApplication::setOverrideCursor().

Access functions:

QCursor	cursor() const
void	setCursor(const QCursor &)
void	unsetCursor()

See also QApplication::setOverrideCursor().

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

Disables widget input events if disable is true; otherwise enables input events.

Calls C++ function: [slot] void QWidget::setDisabled(bool arg1).

C++ documentation:

Disables widget input events if disable is true; otherwise enables input events.

See the enabled documentation for more information.

See also isEnabledTo(), QKeyEvent, QMouseEvent, and changeEvent().

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

This property holds whether the widget is enabled

Calls C++ function: [slot] void QWidget::setEnabled(bool arg1).

C++ documentation:

This property holds whether the widget is enabled

In general an enabled widget handles keyboard and mouse events; a disabled widget does not. An exception is made with QAbstractButton.

Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can use the changeEvent() with type QEvent::EnabledChange.

Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. It it not possible to explicitly enable a child widget which is not a window while its parent widget remains disabled.

By default, this property is true.

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

See also isEnabledTo(), QKeyEvent, QMouseEvent, and changeEvent().

pub unsafe fn set_fixed_height(&self, h: c_int)

Sets both the minimum and maximum heights of the widget to h without changing the widths. Provided for convenience.

Calls C++ function: void QWidget::setFixedHeight(int h).

C++ documentation:

Sets both the minimum and maximum heights of the widget to h without changing the widths. Provided for convenience.

See also sizeHint(), minimumSize(), maximumSize(), and setFixedSize().

pub unsafe fn set_fixed_size_1a(&self, arg1: impl CastInto<Ref<QSize>>)

Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

Calls C++ function: void QWidget::setFixedSize(const QSize& arg1).

C++ documentation:

Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

This will override the default size constraints set by QLayout.

To remove constraints, set the size to QWIDGETSIZE_MAX.

Alternatively, if you want the widget to have a fixed size based on its contents, you can call QLayout::setSizeConstraint(QLayout::SetFixedSize);

See also maximumSize and minimumSize.

pub unsafe fn set_fixed_size_2a(&self, w: c_int, h: c_int)

This is an overloaded function.

Calls C++ function: void QWidget::setFixedSize(int w, int h).

C++ documentation:

This is an overloaded function.

Sets the width of the widget to w and the height to h.

pub unsafe fn set_fixed_width(&self, w: c_int)

Sets both the minimum and maximum width of the widget to w without changing the heights. Provided for convenience.

Calls C++ function: void QWidget::setFixedWidth(int w).

C++ documentation:

Sets both the minimum and maximum width of the widget to w without changing the heights. Provided for convenience.

See also sizeHint(), minimumSize(), maximumSize(), and setFixedSize().

pub unsafe fn set_focus_0a(&self)

This is an overloaded function.

Calls C++ function: [slot] void QWidget::setFocus().

C++ documentation:

This is an overloaded function.

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window.

pub unsafe fn set_focus_1a(&self, reason: FocusReason)

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. The reason argument will be passed into any focus event sent from this function, it is used to give an explanation of what caused the widget to get focus. If the window is not active, the widget will be given the focus when the window becomes active.

Calls C++ function: void QWidget::setFocus(Qt::FocusReason reason).

C++ documentation:

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. The reason argument will be passed into any focus event sent from this function, it is used to give an explanation of what caused the widget to get focus. If the window is not active, the widget will be given the focus when the window becomes active.

First, a focus about to change event is sent to the focus widget (if any) to tell it that it is about to lose the focus. Then focus is changed, a focus out event is sent to the previous focus item and a focus in event is sent to the new item to tell it that it just received the focus. (Nothing happens if the focus in and focus out widgets are the same.)

Note: On embedded platforms, setFocus() will not cause an input panel to be opened by the input method. If you want this to happen, you have to send a QEvent::RequestSoftwareInputPanel event to the widget yourself.

setFocus() gives focus to a widget regardless of its focus policy, but does not clear any keyboard grab (see grabKeyboard()).

Be aware that if the widget is hidden, it will not accept focus until it is shown.

Warning: If you call setFocus() in a function which may itself be called from focusOutEvent() or focusInEvent(), you may get an infinite recursion.

See also hasFocus(), clearFocus(), focusInEvent(), focusOutEvent(), setFocusPolicy(), focusWidget(), QApplication::focusWidget(), grabKeyboard(), grabMouse(), Keyboard Focus in Widgets, and QEvent::RequestSoftwareInputPanel.

pub unsafe fn set_focus_policy(&self, policy: FocusPolicy)

This property holds the way the widget accepts keyboard focus

Calls C++ function: void QWidget::setFocusPolicy(Qt::FocusPolicy policy).

C++ documentation:

This property holds the way the widget accepts keyboard focus

The policy is Qt::TabFocus if the widget accepts keyboard focus by tabbing, Qt::ClickFocus if the widget accepts focus by clicking, Qt::StrongFocus if it accepts both, and Qt::NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(Qt::StrongFocus).

If the widget has a focus proxy, then the focus policy will be propagated to it.

Access functions:

Qt::FocusPolicy	focusPolicy() const
void	setFocusPolicy(Qt::FocusPolicy policy)

See also focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), and enabled.

pub unsafe fn set_focus_proxy(&self, arg1: impl CastInto<Ptr<QWidget>>)

Sets the widget's focus proxy to widget w. If w is 0, the function resets this widget to have no focus proxy.

Calls C++ function: void QWidget::setFocusProxy(QWidget* arg1).

C++ documentation:

Sets the widget’s focus proxy to widget w. If w is 0, the function resets this widget to have no focus proxy.

Some widgets can "have focus", but create a child widget, such as QLineEdit, to actually handle the focus. In this case, the widget can set the line edit to be its focus proxy.

setFocusProxy() sets the widget which will actually get focus when "this widget" gets it. If there is a focus proxy, setFocus() and hasFocus() operate on the focus proxy.

See also focusProxy().

pub unsafe fn set_font(&self, arg1: impl CastInto<Ref<QFont>>)

This property holds the font currently set for the widget

Calls C++ function: void QWidget::setFont(const QFont& arg1).

C++ documentation:

This property holds the font currently set for the widget

This property describes the widget's requested font. The font is used by the widget's style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform's look and feel. It's common that different platforms, or different styles, define different fonts for an application.

When you assign a new font to a widget, the properties from this font are combined with the widget's default font to form the widget's final font. You can call fontInfo() to get a copy of the widget's final font. The final font is also used to initialize QPainter's font.

The default depends on the system environment. QApplication maintains a system/theme font which serves as a default for all widgets. There may also be special font defaults for certain types of widgets. You can also define default fonts for widgets yourself by passing a custom font and the name of a widget to QApplication::setFont(). Finally, the font is matched against Qt's font database to find the best match.

QWidget propagates explicit font properties from parent to child. If you change a specific property on a font and assign that font to a widget, that property will propagate to all the widget's children, overriding any system defaults for that property. Note that fonts by default don't propagate to windows (see isWindow()) unless the Qt::WA_WindowPropagation attribute is enabled.

QWidget's font propagation is similar to its palette propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose to use the widget font, or in some cases, to ignore it (partially, or completely). In particular, certain styles like GTK style, Mac style, Windows XP, and Vista style, apply special modifications to the widget font to match the platform's native look and feel. Because of this, assigning properties to a widget's font is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet.

Note: If Qt Style Sheets are used on the same widget as setFont(), style sheets will take precedence if the settings conflict.

Access functions:

const QFont &	font() const
void	setFont(const QFont &)

See also fontInfo() and fontMetrics().

pub unsafe fn set_foreground_role(&self, arg1: ColorRole)

Sets the foreground role of the widget to role.

Calls C++ function: void QWidget::setForegroundRole(QPalette::ColorRole arg1).

C++ documentation:

Sets the foreground role of the widget to role.

The foreground role defines the color from the widget's palette that is used to draw the foreground.

If role is QPalette::NoRole, the widget uses a foreground role that contrasts with the background role.

Note that styles are free to choose any color from the palette. You can modify the palette or set a style sheet if you don't achieve the result you want with setForegroundRole().

See also foregroundRole() and backgroundRole().

pub unsafe fn set_geometry_4a(&self, x: c_int, y: c_int, w: c_int, h: c_int)

This property holds the geometry of the widget relative to its parent and excluding the window frame

Calls C++ function: void QWidget::setGeometry(int x, int y, int w, int h).

C++ documentation:

This property holds the geometry of the widget relative to its parent and excluding the window frame

When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown.

The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize().

Warning: Calling setGeometry() inside resizeEvent() or moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

const QRect &	geometry() const
void	setGeometry(int x, int y, int w, int h)
void	setGeometry(const QRect &)

See also frameGeometry(), rect(), move(), resize(), moveEvent(), resizeEvent(), minimumSize(), and maximumSize().

pub unsafe fn set_geometry_1a(&self, arg1: impl CastInto<Ref<QRect>>)

This property holds the geometry of the widget relative to its parent and excluding the window frame

Calls C++ function: void QWidget::setGeometry(const QRect& arg1).

C++ documentation:

This property holds the geometry of the widget relative to its parent and excluding the window frame

When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown.

The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize().

Warning: Calling setGeometry() inside resizeEvent() or moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

const QRect &	geometry() const
void	setGeometry(int x, int y, int w, int h)
void	setGeometry(const QRect &)

See also frameGeometry(), rect(), move(), resize(), moveEvent(), resizeEvent(), minimumSize(), and maximumSize().

pub unsafe fn set_graphics_effect( &self, effect: impl CastInto<Ptr<QGraphicsEffect>>, )

The setGraphicsEffect function is for setting the widget's graphics effect.

Calls C++ function: void QWidget::setGraphicsEffect(QGraphicsEffect* effect).

C++ documentation:

The setGraphicsEffect function is for setting the widget’s graphics effect.

Sets effect as the widget's effect. If there already is an effect installed on this widget, QWidget will delete the existing effect before installing the new effect.

If effect is the installed effect on a different widget, setGraphicsEffect() will remove the effect from the widget and install it on this widget.

QWidget takes ownership of effect.

Note: This function will apply the effect on itself and all its children.

Note: Graphics effects are not supported for OpenGL-based widgets, such as QGLWidget, QOpenGLWidget and QQuickWidget.

This function was introduced in Qt 4.6.

See also graphicsEffect().

pub unsafe fn set_hidden(&self, hidden: bool)

Convenience function, equivalent to setVisible(!hidden).

Calls C++ function: [slot] void QWidget::setHidden(bool hidden).

C++ documentation:

Convenience function, equivalent to setVisible(!hidden).

See also isHidden().

pub unsafe fn set_input_method_hints(&self, hints: QFlags<InputMethodHint>)

What input method specific hints the widget has.

Calls C++ function: void QWidget::setInputMethodHints(QFlags<Qt::InputMethodHint> hints).

C++ documentation:

What input method specific hints the widget has.

This is only relevant for input widgets. It is used by the input method to retrieve hints as to how the input method should operate. For example, if the Qt::ImhFormattedNumbersOnly flag is set, the input method may change its visual components to reflect that only numbers can be entered.

Warning: Some widgets require certain flags in order to work as intended. To set a flag, do w->setInputMethodHints(w->inputMethodHints()|f) instead of w->setInputMethodHints(f).

Note: The flags are only hints, so the particular input method implementation is free to ignore them. If you want to be sure that a certain type of characters are entered, you should also set a QValidator on the widget.

The default value is Qt::ImhNone.

This property was introduced in Qt 4.6.

Access functions:

Qt::InputMethodHints	inputMethodHints() const
void	setInputMethodHints(Qt::InputMethodHints hints)

See also inputMethodQuery().

pub unsafe fn set_layout(&self, arg1: impl CastInto<Ptr<QLayout>>)

Sets the layout manager for this widget to layout.

Calls C++ function: void QWidget::setLayout(QLayout* arg1).

C++ documentation:

Sets the layout manager for this widget to layout.

If there already is a layout manager installed on this widget, QWidget won't let you install another. You must first delete the existing layout manager (returned by layout()) before you can call setLayout() with the new layout.

If layout is the layout manager on a different widget, setLayout() will reparent the layout and make it the layout manager for this widget.

Example:

      QVBoxLayout *layout = new QVBoxLayout;
      layout->addWidget(formWidget);
      setLayout(layout);

An alternative to calling this function is to pass this widget to the layout's constructor.

The QWidget will take ownership of layout.

See also layout() and Layout Management.

pub unsafe fn set_layout_direction(&self, direction: LayoutDirection)

This property holds the layout direction for this widget

Calls C++ function: void QWidget::setLayoutDirection(Qt::LayoutDirection direction).

C++ documentation:

This property holds the layout direction for this widget

By default, this property is set to Qt::LeftToRight.

When the layout direction is set on a widget, it will propagate to the widget's children, but not to a child that is a window and not to a child for which setLayoutDirection() has been explicitly called. Also, child widgets added after setLayoutDirection() has been called for the parent do not inherit the parent's layout direction.

This method no longer affects text layout direction since Qt 4.7.

Access functions:

Qt::LayoutDirection	layoutDirection() const
void	setLayoutDirection(Qt::LayoutDirection direction)
void	unsetLayoutDirection()

See also QApplication::layoutDirection.

pub unsafe fn set_locale(&self, locale: impl CastInto<Ref<QLocale>>)

This property holds the widget's locale

Calls C++ function: void QWidget::setLocale(const QLocale& locale).

C++ documentation:

This property holds the widget’s locale

As long as no special locale has been set, this is either the parent's locale or (if this widget is a top level widget), the default locale.

If the widget displays dates or numbers, these should be formatted using the widget's locale.

This property was introduced in Qt 4.3.

Access functions:

QLocale	locale() const
void	setLocale(const QLocale &locale)
void	unsetLocale()

See also QLocale and QLocale::setDefault().

pub unsafe fn set_mask_q_bitmap(&self, arg1: impl CastInto<Ref<QBitmap>>)

Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform.

Calls C++ function: void QWidget::setMask(const QBitmap& arg1).

C++ documentation:

Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform.

Note that this effect can be slow if the region is particularly complex.

The following code shows how an image with an alpha channel can be used to generate a mask for a widget:

      QLabel topLevelLabel;
      QPixmap pixmap(“:/images/tux.png”);
      topLevelLabel.setPixmap(pixmap);
      topLevelLabel.setMask(pixmap.mask());

The label shown by this code is masked using the image it contains, giving the appearance that an irregularly-shaped image is being drawn directly onto the screen.

Masked widgets receive mouse events only on their visible portions.

See also mask(), clearMask(), windowOpacity(), and Shaped Clock Example.

pub unsafe fn set_mask_q_region(&self, arg1: impl CastInto<Ref<QRegion>>)

This is an overloaded function.

Calls C++ function: void QWidget::setMask(const QRegion& arg1).

C++ documentation:

This is an overloaded function.

Causes only the parts of the widget which overlap region to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform.

Note that this effect can be slow if the region is particularly complex.

See also windowOpacity.

pub unsafe fn set_maximum_height(&self, maxh: c_int)

This property holds the widget's maximum height in pixels

Calls C++ function: void QWidget::setMaximumHeight(int maxh).

C++ documentation:

This property holds the widget’s maximum height in pixels

This property corresponds to the height held by the maximumSize property.

By default, this property contains a value of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

int	maximumHeight() const
void	setMaximumHeight(int maxh)

See also maximumSize and maximumWidth.

pub unsafe fn set_maximum_size_1a(&self, arg1: impl CastInto<Ref<QSize>>)

This property holds the widget's maximum size in pixels

Calls C++ function: void QWidget::setMaximumSize(const QSize& arg1).

C++ documentation:

This property holds the widget’s maximum size in pixels

The widget cannot be resized to a larger size than the maximum widget size.

By default, this property contains a size in which both width and height have values of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

QSize	maximumSize() const
void	setMaximumSize(const QSize &)
void	setMaximumSize(int maxw, int maxh)

See also maximumWidth, maximumHeight, minimumSize, and sizeIncrement.

pub unsafe fn set_maximum_size_2a(&self, maxw: c_int, maxh: c_int)

This property holds the widget's maximum size in pixels

Calls C++ function: void QWidget::setMaximumSize(int maxw, int maxh).

C++ documentation:

This property holds the widget’s maximum size in pixels

The widget cannot be resized to a larger size than the maximum widget size.

By default, this property contains a size in which both width and height have values of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

QSize	maximumSize() const
void	setMaximumSize(const QSize &)
void	setMaximumSize(int maxw, int maxh)

See also maximumWidth, maximumHeight, minimumSize, and sizeIncrement.

pub unsafe fn set_maximum_width(&self, maxw: c_int)

This property holds the widget's maximum width in pixels

Calls C++ function: void QWidget::setMaximumWidth(int maxw).

C++ documentation:

This property holds the widget’s maximum width in pixels

This property corresponds to the width held by the maximumSize property.

By default, this property contains a value of 16777215.

Note: The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

Access functions:

int	maximumWidth() const
void	setMaximumWidth(int maxw)

See also maximumSize and maximumHeight.

pub unsafe fn set_minimum_height(&self, minh: c_int)

This property holds the widget's minimum height in pixels

Calls C++ function: void QWidget::setMinimumHeight(int minh).

C++ documentation:

This property holds the widget’s minimum height in pixels

This property corresponds to the height held by the minimumSize property.

By default, this property has a value of 0.

Access functions:

int	minimumHeight() const
void	setMinimumHeight(int minh)

See also minimumSize and minimumWidth.

pub unsafe fn set_minimum_size_1a(&self, arg1: impl CastInto<Ref<QSize>>)

This property holds the widget's minimum size

Calls C++ function: void QWidget::setMinimumSize(const QSize& arg1).

C++ documentation:

This property holds the widget’s minimum size

The widget cannot be resized to a smaller size than the minimum widget size. The widget's size is forced to the minimum size if the current size is smaller.

The minimum size set by this function will override the minimum size defined by QLayout. In order to unset the minimum size, use a value of QSize(0, 0).

By default, this property contains a size with zero width and height.

Access functions:

QSize	minimumSize() const
void	setMinimumSize(const QSize &)
void	setMinimumSize(int minw, int minh)

See also minimumWidth, minimumHeight, maximumSize, and sizeIncrement.

pub unsafe fn set_minimum_size_2a(&self, minw: c_int, minh: c_int)

This property holds the widget's minimum size

Calls C++ function: void QWidget::setMinimumSize(int minw, int minh).

C++ documentation:

This property holds the widget’s minimum size

The widget cannot be resized to a smaller size than the minimum widget size. The widget's size is forced to the minimum size if the current size is smaller.

The minimum size set by this function will override the minimum size defined by QLayout. In order to unset the minimum size, use a value of QSize(0, 0).

By default, this property contains a size with zero width and height.

Access functions:

QSize	minimumSize() const
void	setMinimumSize(const QSize &)
void	setMinimumSize(int minw, int minh)

See also minimumWidth, minimumHeight, maximumSize, and sizeIncrement.

pub unsafe fn set_minimum_width(&self, minw: c_int)

This property holds the widget's minimum width in pixels

Calls C++ function: void QWidget::setMinimumWidth(int minw).

C++ documentation:

This property holds the widget’s minimum width in pixels

This property corresponds to the width held by the minimumSize property.

By default, this property has a value of 0.

Access functions:

int	minimumWidth() const
void	setMinimumWidth(int minw)

See also minimumSize and minimumHeight.

pub unsafe fn set_mouse_tracking(&self, enable: bool)

This property holds whether mouse tracking is enabled for the widget

Calls C++ function: void QWidget::setMouseTracking(bool enable).

C++ documentation:

This property holds whether mouse tracking is enabled for the widget

If mouse tracking is disabled (the default), the widget only receives mouse move events when at least one mouse button is pressed while the mouse is being moved.

If mouse tracking is enabled, the widget receives mouse move events even if no buttons are pressed.

Access functions:

bool	hasMouseTracking() const
void	setMouseTracking(bool enable)

See also mouseMoveEvent().

pub unsafe fn set_palette(&self, arg1: impl CastInto<Ref<QPalette>>)

This property holds the widget's palette

Calls C++ function: void QWidget::setPalette(const QPalette& arg1).

C++ documentation:

This property holds the widget’s palette

This property describes the widget's palette. The palette is used by the widget's style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform's look and feel. It's common that different platforms, or different styles, have different palettes.

When you assign a new palette to a widget, the color roles from this palette are combined with the widget's default palette to form the widget's final palette. The palette entry for the widget's background role is used to fill the widget's background (see QWidget::autoFillBackground), and the foreground role initializes QPainter's pen.

The default depends on the system environment. QApplication maintains a system/theme palette which serves as a default for all widgets. There may also be special palette defaults for certain types of widgets (e.g., on Windows XP and Vista, all classes that derive from QMenuBar have a special default palette). You can also define default palettes for widgets yourself by passing a custom palette and the name of a widget to QApplication::setPalette(). Finally, the style always has the option of polishing the palette as it's assigned (see QStyle::polish()).

QWidget propagates explicit palette roles from parent to child. If you assign a brush or color to a specific role on a palette and assign that palette to a widget, that role will propagate to all the widget's children, overriding any system defaults for that role. Note that palettes by default don't propagate to windows (see isWindow()) unless the Qt::WA_WindowPropagation attribute is enabled.

QWidget's palette propagation is similar to its font propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose colors and brushes from the widget palette, or in some cases, to ignore the palette (partially, or completely). In particular, certain styles like GTK style, Mac style, Windows XP, and Vista style, depend on third party APIs to render the content of widgets, and these styles typically do not follow the palette. Because of this, assigning roles to a widget's palette is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet. You can refer to our Knowledge Base article here for more information.

Warning: Do not use this function in conjunction with Qt Style Sheets. When using style sheets, the palette of a widget can be customized using the "color", "background-color", "selection-color", "selection-background-color" and "alternate-background-color".

Access functions:

const QPalette &	palette() const
void	setPalette(const QPalette &)

See also QApplication::palette() and QWidget::font().

pub unsafe fn set_parent_1a(&self, parent: impl CastInto<Ptr<QWidget>>)

Sets the parent of the widget to parent, and resets the window flags. The widget is moved to position (0, 0) in its new parent.

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

C++ documentation:

Sets the parent of the widget to parent, and resets the window flags. The widget is moved to position (0, 0) in its new parent.

If the new parent widget is in a different window, the reparented widget and its children are appended to the end of the tab chain of the new parent widget, in the same internal order as before. If one of the moved widgets had keyboard focus, setParent() calls clearFocus() for that widget.

If the new parent widget is in the same window as the old parent, setting the parent doesn't change the tab order or keyboard focus.

If the "new" parent widget is the old parent widget, this function does nothing.

Note: The widget becomes invisible as part of changing its parent, even if it was previously visible. You must call show() to make the widget visible again.

Warning: It is very unlikely that you will ever need this function. If you have a widget that changes its content dynamically, it is far easier to use QStackedWidget.

See also setWindowFlags().

pub unsafe fn set_parent_2a( &self, parent: impl CastInto<Ptr<QWidget>>, f: QFlags<WindowType>, )

This is an overloaded function.

Calls C++ function: void QWidget::setParent(QWidget* parent, QFlags<Qt::WindowType> f).

C++ documentation:

This is an overloaded function.

This function also takes widget flags, f as an argument.

pub unsafe fn set_shortcut_auto_repeat_2a(&self, id: c_int, enable: bool)

If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

Calls C++ function: void QWidget::setShortcutAutoRepeat(int id, bool enable = …).

C++ documentation:

If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

This function was introduced in Qt 4.2.

See also grabShortcut() and releaseShortcut().

pub unsafe fn set_shortcut_auto_repeat_1a(&self, id: c_int)

If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

Calls C++ function: void QWidget::setShortcutAutoRepeat(int id).

C++ documentation:

If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

This function was introduced in Qt 4.2.

See also grabShortcut() and releaseShortcut().

pub unsafe fn set_shortcut_enabled_2a(&self, id: c_int, enable: bool)

If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

Calls C++ function: void QWidget::setShortcutEnabled(int id, bool enable = …).

C++ documentation:

If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

Warning: You should not normally need to use this function since Qt's shortcut system enables/disables shortcuts automatically as widgets become hidden/visible and gain or lose focus. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function.

See also grabShortcut() and releaseShortcut().

pub unsafe fn set_shortcut_enabled_1a(&self, id: c_int)

If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

Calls C++ function: void QWidget::setShortcutEnabled(int id).

C++ documentation:

If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

Warning: You should not normally need to use this function since Qt's shortcut system enables/disables shortcuts automatically as widgets become hidden/visible and gain or lose focus. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function.

See also grabShortcut() and releaseShortcut().

pub unsafe fn set_size_increment_1a(&self, arg1: impl CastInto<Ref<QSize>>)

This property holds the size increment of the widget

Calls C++ function: void QWidget::setSizeIncrement(const QSize& arg1).

C++ documentation:

This property holds the size increment of the widget

When the user resizes the window, the size will move in steps of sizeIncrement().width() pixels horizontally and sizeIncrement.height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers i and j:

width = baseSize().width() + i  sizeIncrement().width();
height = baseSize().height() + j  sizeIncrement().height();

Note that while you can set the size increment for all widgets, it only affects windows.

By default, this property contains a size with zero width and height.

Warning: The size increment has no effect under Windows, and may be disregarded by the window manager on X11.

Access functions:

QSize	sizeIncrement() const
void	setSizeIncrement(const QSize &)
void	setSizeIncrement(int w, int h)

See also size, minimumSize, and maximumSize.

pub unsafe fn set_size_increment_2a(&self, w: c_int, h: c_int)

This property holds the size increment of the widget

Calls C++ function: void QWidget::setSizeIncrement(int w, int h).

C++ documentation:

This property holds the size increment of the widget

When the user resizes the window, the size will move in steps of sizeIncrement().width() pixels horizontally and sizeIncrement.height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers i and j:

width = baseSize().width() + i  sizeIncrement().width();
height = baseSize().height() + j  sizeIncrement().height();

Note that while you can set the size increment for all widgets, it only affects windows.

By default, this property contains a size with zero width and height.

Warning: The size increment has no effect under Windows, and may be disregarded by the window manager on X11.

Access functions:

QSize	sizeIncrement() const
void	setSizeIncrement(const QSize &)
void	setSizeIncrement(int w, int h)

See also size, minimumSize, and maximumSize.

pub unsafe fn set_size_policy_1a(&self, arg1: impl CastInto<Ref<QSizePolicy>>)

This property holds the default layout behavior of the widget

Calls C++ function: void QWidget::setSizePolicy(QSizePolicy arg1).

C++ documentation:

This property holds the default layout behavior of the widget

If there is a QLayout that manages this widget's children, the size policy specified by that layout is used. If there is no such QLayout, the result of this function is used.

The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit, QSpinBox or an editable QComboBox) and other horizontally orientated widgets (such as QProgressBar). QToolButton's are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider, QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scroll bars (usually subclasses of QScrollArea) tend to specify that they can use additional space, and that they can make do with less than sizeHint().

Access functions:

QSizePolicy	sizePolicy() const
void	setSizePolicy(QSizePolicy)
void	setSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

See also sizeHint(), QLayout, QSizePolicy, and updateGeometry().

pub unsafe fn set_size_policy_2a(&self, horizontal: Policy, vertical: Policy)

This property holds the default layout behavior of the widget

Calls C++ function: void QWidget::setSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical).

C++ documentation:

This property holds the default layout behavior of the widget

If there is a QLayout that manages this widget's children, the size policy specified by that layout is used. If there is no such QLayout, the result of this function is used.

The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit, QSpinBox or an editable QComboBox) and other horizontally orientated widgets (such as QProgressBar). QToolButton's are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider, QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scroll bars (usually subclasses of QScrollArea) tend to specify that they can use additional space, and that they can make do with less than sizeHint().

Access functions:

QSizePolicy	sizePolicy() const
void	setSizePolicy(QSizePolicy)
void	setSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

See also sizeHint(), QLayout, QSizePolicy, and updateGeometry().

pub unsafe fn set_status_tip(&self, arg1: impl CastInto<Ref<QString>>)

This property holds the widget's status tip

Calls C++ function: void QWidget::setStatusTip(const QString& arg1).

C++ documentation:

This property holds the widget’s status tip

By default, this property contains an empty string.

Access functions:

QString	statusTip() const
void	setStatusTip(const QString &)

See also toolTip and whatsThis.

pub unsafe fn set_style(&self, arg1: impl CastInto<Ptr<QStyle>>)

Sets the widget's GUI style to style. The ownership of the style object is not transferred.

Calls C++ function: void QWidget::setStyle(QStyle* arg1).

C++ documentation:

Sets the widget’s GUI style to style. The ownership of the style object is not transferred.

If no style is set, the widget uses the application's style, QApplication::style() instead.

Setting a widget's style has no effect on existing or future child widgets.

Warning: This function is particularly useful for demonstration purposes, where you want to show Qt's styling capabilities. Real applications should avoid it and use one consistent GUI style instead.

Warning: Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

See also style(), QStyle, QApplication::style(), and QApplication::setStyle().

pub unsafe fn set_style_sheet(&self, style_sheet: impl CastInto<Ref<QString>>)

This property holds the widget's style sheet

Calls C++ function: [slot] void QWidget::setStyleSheet(const QString& styleSheet).

C++ documentation:

This property holds the widget’s style sheet

The style sheet contains a textual description of customizations to the widget's style, as described in the Qt Style Sheets document.

Since Qt 4.5, Qt style sheets fully supports macOS.

Warning: Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

This property was introduced in Qt 4.2.

Access functions:

QString	styleSheet() const
void	setStyleSheet(const QString &styleSheet)

See also setStyle(), QApplication::styleSheet, and Qt Style Sheets.

pub unsafe fn set_tablet_tracking(&self, enable: bool)

This property holds whether tablet tracking is enabled for the widget

Calls C++ function: void QWidget::setTabletTracking(bool enable).

C++ documentation:

This property holds whether tablet tracking is enabled for the widget

If tablet tracking is disabled (the default), the widget only receives tablet move events when the stylus is in contact with the tablet, or at least one stylus button is pressed, while the stylus is being moved.

If tablet tracking is enabled, the widget receives tablet move events even while hovering in proximity. This is useful for monitoring position as well as the auxiliary properties such as rotation and tilt, and providing feedback in the UI.

This property was introduced in Qt 5.9.

Access functions:

bool	hasTabletTracking() const
void	setTabletTracking(bool enable)

See also tabletEvent().

pub unsafe fn set_tool_tip(&self, arg1: impl CastInto<Ref<QString>>)

This property holds the widget's tooltip

Calls C++ function: void QWidget::setToolTip(const QString& arg1).

C++ documentation:

This property holds the widget’s tooltip

Note that by default tooltips are only shown for widgets that are children of the active window. You can change this behavior by setting the attribute Qt::WA_AlwaysShowToolTips on the window, not on the widget with the tooltip.

If you want to control a tooltip's behavior, you can intercept the event() function and catch the QEvent::ToolTip event (e.g., if you want to customize the area for which the tooltip should be shown).

By default, this property contains an empty string.

Access functions:

QString	toolTip() const
void	setToolTip(const QString &)

See also QToolTip, statusTip, and whatsThis.

pub unsafe fn set_tool_tip_duration(&self, msec: c_int)

This property holds the widget's tooltip duration

Calls C++ function: void QWidget::setToolTipDuration(int msec).

C++ documentation:

This property holds the widget’s tooltip duration

Specifies how long time the tooltip will be displayed, in milliseconds. If the value is -1 (default) the duration is calculated depending on the length of the tooltip.

This property was introduced in Qt 5.2.

Access functions:

int	toolTipDuration() const
void	setToolTipDuration(int msec)

See also toolTip.

pub unsafe fn set_updates_enabled(&self, enable: bool)

This property holds whether updates are enabled

Calls C++ function: void QWidget::setUpdatesEnabled(bool enable).

C++ documentation:

This property holds whether updates are enabled

An updates enabled widget receives paint events and has a system background; a disabled widget does not. This also implies that calling update() and repaint() has no effect if updates are disabled.

By default, this property is true.

setUpdatesEnabled() is normally used to disable updates for a short period of time, for instance to avoid screen flicker during large changes. In Qt, widgets normally do not generate screen flicker, but on X11 the server might erase regions on the screen when widgets get hidden before they can be replaced by other widgets. Disabling updates solves this.

Example:

setUpdatesEnabled(false);
bigVisualChanges();
setUpdatesEnabled(true);

Disabling a widget implicitly disables all its children. Enabling a widget enables all child widgets except top-level widgets or those that have been explicitly disabled. Re-enabling updates implicitly calls update() on the widget.

Access functions:

bool	updatesEnabled() const
void	setUpdatesEnabled(bool enable)

See also paintEvent().

pub unsafe fn set_visible(&self, visible: bool)

This property holds whether the widget is visible

Calls C++ function: virtual [slot] void QWidget::setVisible(bool visible).

C++ documentation:

This property holds whether the widget is visible

Calling setVisible(true) or show() sets the widget to visible status if all its parent widgets up to the window are visible. If an ancestor is not visible, the widget won't become visible until all its ancestors are shown. If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. If the widget has not been resized yet, Qt will adjust the widget's size to a useful default using adjustSize().

Calling setVisible(false) or hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it.

A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames.

A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified windows and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again.

You almost never have to reimplement the setVisible() function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use the Polish event delivered to the event() function.

Access functions:

bool	isVisible() const
virtual void	setVisible(bool visible)

See also show(), hide(), isHidden(), isVisibleTo(), isMinimized(), showEvent(), and hideEvent().

pub unsafe fn set_whats_this(&self, arg1: impl CastInto<Ref<QString>>)

This property holds the widget's What's This help text.

Calls C++ function: void QWidget::setWhatsThis(const QString& arg1).

C++ documentation:

This property holds the widget’s What’s This help text.

By default, this property contains an empty string.

Access functions:

QString	whatsThis() const
void	setWhatsThis(const QString &)

See also QWhatsThis, QWidget::toolTip, and QWidget::statusTip.

pub unsafe fn set_window_file_path( &self, file_path: impl CastInto<Ref<QString>>, )

This property holds the file path associated with a widget

Calls C++ function: void QWidget::setWindowFilePath(const QString& filePath).

C++ documentation:

This property holds the file path associated with a widget

This property only makes sense for windows. It associates a file path with a window. If you set the file path, but have not set the window title, Qt sets the window title to the file name of the specified path, obtained using QFileInfo::fileName().

If the window title is set at any point, then the window title takes precedence and will be shown instead of the file path string.

Additionally, on macOS, this has an added benefit that it sets the proxy icon for the window, assuming that the file path exists.

If no file path is set, this property contains an empty string.

By default, this property contains an empty string.

This property was introduced in Qt 4.4.

Access functions:

QString	windowFilePath() const
void	setWindowFilePath(const QString &filePath)

See also windowTitle and windowIcon.

pub unsafe fn set_window_flag_2a(&self, arg1: WindowType, on: bool)

Sets the window flag flag on this widget if on is true; otherwise clears the flag.

Calls C++ function: void QWidget::setWindowFlag(Qt::WindowType arg1, bool on = …).

C++ documentation:

Sets the window flag flag on this widget if on is true; otherwise clears the flag.

This function was introduced in Qt 5.9.

See also setWindowFlags(), windowFlags(), and windowType().

pub unsafe fn set_window_flag_1a(&self, arg1: WindowType)

Sets the window flag flag on this widget if on is true; otherwise clears the flag.

Calls C++ function: void QWidget::setWindowFlag(Qt::WindowType arg1).

C++ documentation:

Sets the window flag flag on this widget if on is true; otherwise clears the flag.

This function was introduced in Qt 5.9.

See also setWindowFlags(), windowFlags(), and windowType().

pub unsafe fn set_window_flags(&self, type_: QFlags<WindowType>)

Window flags are a combination of a type (e.g. Qt::Dialog) and zero or more hints to the window system (e.g. Qt::FramelessWindowHint).

Calls C++ function: void QWidget::setWindowFlags(QFlags<Qt::WindowType> type).

C++ documentation:

Window flags are a combination of a type (e.g. Qt::Dialog) and zero or more hints to the window system (e.g. Qt::FramelessWindowHint).

If the widget had type Qt::Widget or Qt::SubWindow and becomes a window (Qt::Window, Qt::Dialog, etc.), it is put at position (0, 0) on the desktop. If the widget is a window and becomes a Qt::Widget or Qt::SubWindow, it is put at position (0, 0) relative to its parent widget.

Note: This function calls setParent() when changing the flags for a window, causing the widget to be hidden. You must call show() to make the widget visible again..

Access functions:

Qt::WindowFlags	windowFlags() const
void	setWindowFlags(Qt::WindowFlags type)

See also windowType(), setWindowFlag(), and Window Flags Example.

pub unsafe fn set_window_icon(&self, icon: impl CastInto<Ref<QIcon>>)

This property holds the widget's icon

Calls C++ function: void QWidget::setWindowIcon(const QIcon& icon).

C++ documentation:

This property holds the widget’s icon

This property only makes sense for windows. If no icon has been set, windowIcon() returns the application icon (QApplication::windowIcon()).

Access functions:

QIcon	windowIcon() const
void	setWindowIcon(const QIcon &icon)

Notifier signal:

void	windowIconChanged(const QIcon &icon)

See also windowTitle.

pub unsafe fn set_window_icon_text(&self, arg1: impl CastInto<Ref<QString>>)

This property holds the text to be displayed on the icon of a minimized window

Calls C++ function: void QWidget::setWindowIconText(const QString& arg1).

C++ documentation:

This property holds the text to be displayed on the icon of a minimized window

This property only makes sense for windows. If no icon text has been set, this accessor returns an empty string. It is only implemented on the X11 platform, and only certain window managers use this window property.

This property is deprecated.

Access functions:

QString	windowIconText() const
void	setWindowIconText(const QString &)

Notifier signal:

void	windowIconTextChanged(const QString &iconText)

See also windowIcon and windowTitle.

Member Function Documentation

pub unsafe fn set_window_modality(&self, window_modality: WindowModality)

This property holds which windows are blocked by the modal widget

Calls C++ function: void QWidget::setWindowModality(Qt::WindowModality windowModality).

C++ documentation:

This property holds which windows are blocked by the modal widget

This property only makes sense for windows. A modal widget prevents widgets in other windows from getting input. The value of this property controls which windows are blocked when the widget is visible. Changing this property while the window is visible has no effect; you must hide() the widget first, then show() it again.

By default, this property is Qt::NonModal.

This property was introduced in Qt 4.1.

Access functions:

Qt::WindowModality	windowModality() const
void	setWindowModality(Qt::WindowModality windowModality)

See also isWindow(), QWidget::modal, and QDialog.

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

This property holds whether the document shown in the window has unsaved changes

Calls C++ function: [slot] void QWidget::setWindowModified(bool arg1).

C++ documentation:

This property holds whether the document shown in the window has unsaved changes

A modified window is a window whose content has changed but has not been saved to disk. This flag will have different effects varied by the platform. On macOS the close button will have a modified look; on other platforms, the window title will have an '*' (asterisk).

The window title must contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the window isn't modified, the placeholder is simply removed.

Note that if a widget is set as modified, all its ancestors will also be set as modified. However, if you call setWindowModified(false) on a widget, this will not propagate to its parent because other children of the parent might have been modified.

Access functions:

bool	isWindowModified() const
void	setWindowModified(bool)

See also windowTitle, Application Example, SDI Example, and MDI Example.

pub unsafe fn set_window_opacity(&self, level: c_double)

This property holds the level of opacity for the window.

Calls C++ function: void QWidget::setWindowOpacity(double level).

C++ documentation:

This property holds the level of opacity for the window.

The valid range of opacity is from 1.0 (completely opaque) to 0.0 (completely transparent).

By default the value of this property is 1.0.

This feature is available on Embedded Linux, macOS, Windows, and X11 platforms that support the Composite extension.

Note: On X11 you need to have a composite manager running, and the X11 specific _NET_WM_WINDOW_OPACITY atom needs to be supported by the window manager you are using.

Warning: Changing this property from opaque to transparent might issue a paint event that needs to be processed before the window is displayed correctly. This affects mainly the use of QPixmap::grabWindow(). Also note that semi-transparent windows update and resize significantly slower than opaque windows.

Access functions:

qreal	windowOpacity() const
void	setWindowOpacity(qreal level)

See also setMask().

pub unsafe fn set_window_role(&self, arg1: impl CastInto<Ref<QString>>)

Sets the window's role to role. This only makes sense for windows on X11.

Calls C++ function: void QWidget::setWindowRole(const QString& arg1).

C++ documentation:

Sets the window’s role to role. This only makes sense for windows on X11.

See also windowRole().

pub unsafe fn set_window_state(&self, state: QFlags<WindowState>)

Sets the window state to windowState. The window state is a OR'ed combination of Qt::WindowState: Qt::WindowMinimized, Qt::WindowMaximized, Qt::WindowFullScreen, and Qt::WindowActive.

Calls C++ function: void QWidget::setWindowState(QFlags<Qt::WindowState> state).

C++ documentation:

Sets the window state to windowState. The window state is a OR’ed combination of Qt::WindowState: Qt::WindowMinimized, Qt::WindowMaximized, Qt::WindowFullScreen, and Qt::WindowActive.

If the window is not visible (i.e. isVisible() returns false), the window state will take effect when show() is called. For visible windows, the change is immediate. For example, to toggle between full-screen and normal mode, use the following code:

w->setWindowState(w->windowState() ^ Qt::WindowFullScreen);

In order to restore and activate a minimized window (while preserving its maximized and/or full-screen state), use the following:

w->setWindowState((w->windowState() & ~Qt::WindowMinimized) | Qt::WindowActive);

Calling this function will hide the widget. You must call show() to make the widget visible again.

Note: On some window systems Qt::WindowActive is not immediate, and may be ignored in certain cases.

When the window state changes, the widget receives a changeEvent() of type QEvent::WindowStateChange.

See also Qt::WindowState and windowState().

pub unsafe fn set_window_title(&self, arg1: impl CastInto<Ref<QString>>)

This property holds the window title (caption)

Calls C++ function: [slot] void QWidget::setWindowTitle(const QString& arg1).

C++ documentation:

This property holds the window title (caption)

This property only makes sense for top-level widgets, such as windows and dialogs. If no caption has been set, the title is based of the windowFilePath. If neither of these is set, then the title is an empty string.

If you use the windowModified mechanism, the window title must contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the windowModified property is false (the default), the placeholder is simply removed.

On some desktop platforms (including Windows and Unix), the application name (from QGuiApplication::applicationDisplayName) is added at the end of the window title, if set. This is done by the QPA plugin, so it is shown to the user, but isn't part of the windowTitle string.

Access functions:

QString	windowTitle() const
void	setWindowTitle(const QString &)

Notifier signal:

void	windowTitleChanged(const QString &title)

See also windowIcon, windowModified, and windowFilePath.

pub unsafe fn show(&self)

Shows the widget and its child widgets.

Calls C++ function: [slot] void QWidget::show().

C++ documentation:

Shows the widget and its child widgets.

This is equivalent to calling showFullScreen(), showMaximized(), or setVisible(true), depending on the platform's default behavior for the window flags.

See also raise(), showEvent(), hide(), setVisible(), showMinimized(), showMaximized(), showNormal(), isVisible(), and windowFlags().

pub unsafe fn show_full_screen(&self)

Shows the widget in full-screen mode.

Calls C++ function: [slot] void QWidget::showFullScreen().

C++ documentation:

Shows the widget in full-screen mode.

Calling this function only affects windows.

To return from full-screen mode, call showNormal().

Full-screen mode works fine under Windows, but has certain problems under X. These problems are due to limitations of the ICCCM protocol that specifies the communication between X11 clients and the window manager. ICCCM simply does not understand the concept of non-decorated full-screen windows. Therefore, the best we can do is to request a borderless window and place and resize it to fill the entire screen. Depending on the window manager, this may or may not work. The borderless window is requested using MOTIF hints, which are at least partially supported by virtually all modern window managers.

An alternative would be to bypass the window manager entirely and create a window with the Qt::X11BypassWindowManagerHint flag. This has other severe problems though, like totally broken keyboard focus and very strange effects on desktop changes or when the user raises other windows.

X11 window managers that follow modern post-ICCCM specifications support full-screen mode properly.

See also showNormal(), showMaximized(), show(), hide(), and isVisible().

pub unsafe fn show_maximized(&self)

Shows the widget maximized.

Calls C++ function: [slot] void QWidget::showMaximized().

C++ documentation:

Shows the widget maximized.

Calling this function only affects windows.

On X11, this function may not work properly with certain window managers. See the Window Geometry documentation for an explanation.

See also setWindowState(), showNormal(), showMinimized(), show(), hide(), and isVisible().

pub unsafe fn show_minimized(&self)

Shows the widget minimized, as an icon.

Calls C++ function: [slot] void QWidget::showMinimized().

C++ documentation:

Shows the widget minimized, as an icon.

Calling this function only affects windows.

See also showNormal(), showMaximized(), show(), hide(), isVisible(), and isMinimized().

pub unsafe fn show_normal(&self)

Restores the widget after it has been maximized or minimized.

Calls C++ function: [slot] void QWidget::showNormal().

C++ documentation:

Restores the widget after it has been maximized or minimized.

Calling this function only affects windows.

See also setWindowState(), showMinimized(), showMaximized(), show(), hide(), and isVisible().

pub unsafe fn size(&self) -> CppBox<QSize>

This property holds the size of the widget excluding any window frame

Calls C++ function: QSize QWidget::size() const.

C++ documentation:

This property holds the size of the widget excluding any window frame

If the widget is visible when it is being resized, it receives a resize event (resizeEvent()) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize().

By default, this property contains a value that depends on the user's platform and screen geometry.

Warning: Calling resize() or setGeometry() inside resizeEvent() can lead to infinite recursion.

Note: Setting the size to QSize(0, 0) will cause the widget to not appear on screen. This also applies to windows.

Access functions:

QSize	size() const
void	resize(int w, int h)
void	resize(const QSize &)

See also pos, geometry, minimumSize, maximumSize, resizeEvent(), and adjustSize().

pub unsafe fn size_hint(&self) -> CppBox<QSize>

This property holds the recommended size for the widget

Calls C++ function: virtual QSize QWidget::sizeHint() const.

C++ documentation:

This property holds the recommended size for the widget

If the value of this property is an invalid size, no size is recommended.

The default implementation of sizeHint() returns an invalid size if there is no layout for this widget, and returns the layout's preferred size otherwise.

Access functions:

virtual QSize

sizeHint() const

See also QSize::isValid(), minimumSizeHint(), sizePolicy(), setMinimumSize(), and updateGeometry().

pub unsafe fn size_increment(&self) -> CppBox<QSize>

This property holds the size increment of the widget

Calls C++ function: QSize QWidget::sizeIncrement() const.

C++ documentation:

This property holds the size increment of the widget

When the user resizes the window, the size will move in steps of sizeIncrement().width() pixels horizontally and sizeIncrement.height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers i and j:

width = baseSize().width() + i  sizeIncrement().width();
height = baseSize().height() + j  sizeIncrement().height();

Note that while you can set the size increment for all widgets, it only affects windows.

By default, this property contains a size with zero width and height.

Warning: The size increment has no effect under Windows, and may be disregarded by the window manager on X11.

Access functions:

QSize	sizeIncrement() const
void	setSizeIncrement(const QSize &)
void	setSizeIncrement(int w, int h)

See also size, minimumSize, and maximumSize.

pub unsafe fn size_policy(&self) -> CppBox<QSizePolicy>

This property holds the default layout behavior of the widget

Calls C++ function: QSizePolicy QWidget::sizePolicy() const.

C++ documentation:

This property holds the default layout behavior of the widget

If there is a QLayout that manages this widget's children, the size policy specified by that layout is used. If there is no such QLayout, the result of this function is used.

The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit, QSpinBox or an editable QComboBox) and other horizontally orientated widgets (such as QProgressBar). QToolButton's are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider, QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scroll bars (usually subclasses of QScrollArea) tend to specify that they can use additional space, and that they can make do with less than sizeHint().

Access functions:

QSizePolicy	sizePolicy() const
void	setSizePolicy(QSizePolicy)
void	setSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

See also sizeHint(), QLayout, QSizePolicy, and updateGeometry().

pub unsafe fn stack_under(&self, arg1: impl CastInto<Ptr<QWidget>>)

Places the widget under w in the parent widget's stack.

Calls C++ function: void QWidget::stackUnder(QWidget* arg1).

C++ documentation:

Places the widget under w in the parent widget’s stack.

To make this work, the widget itself and w must be siblings.

See also raise() and lower().

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

This property holds the widget's status tip

Calls C++ function: QString QWidget::statusTip() const.

C++ documentation:

This property holds the widget’s status tip

By default, this property contains an empty string.

Access functions:

QString	statusTip() const
void	setStatusTip(const QString &)

See also toolTip and whatsThis.

pub unsafe fn style(&self) -> QPtr<QStyle>

See also QWidget::setStyle(), QApplication::setStyle(), and QApplication::style().

Calls C++ function: QStyle* QWidget::style() const.

C++ documentation:

See also QWidget::setStyle(), QApplication::setStyle(), and QApplication::style().

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

This property holds the widget's style sheet

Calls C++ function: QString QWidget::styleSheet() const.

C++ documentation:

This property holds the widget’s style sheet

The style sheet contains a textual description of customizations to the widget's style, as described in the Qt Style Sheets document.

Since Qt 4.5, Qt style sheets fully supports macOS.

Warning: Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

This property was introduced in Qt 4.2.

Access functions:

QString	styleSheet() const
void	setStyleSheet(const QString &styleSheet)

See also setStyle(), QApplication::styleSheet, and Qt Style Sheets.

pub unsafe fn test_attribute(&self, arg1: WidgetAttribute) -> bool

Returns true if attribute attribute is set on this widget; otherwise returns false.

Calls C++ function: bool QWidget::testAttribute(Qt::WidgetAttribute arg1) const.

C++ documentation:

Returns true if attribute attribute is set on this widget; otherwise returns false.

See also setAttribute().

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

This property holds the widget's tooltip

Calls C++ function: QString QWidget::toolTip() const.

C++ documentation:

This property holds the widget’s tooltip

Note that by default tooltips are only shown for widgets that are children of the active window. You can change this behavior by setting the attribute Qt::WA_AlwaysShowToolTips on the window, not on the widget with the tooltip.

If you want to control a tooltip's behavior, you can intercept the event() function and catch the QEvent::ToolTip event (e.g., if you want to customize the area for which the tooltip should be shown).

By default, this property contains an empty string.

Access functions:

QString	toolTip() const
void	setToolTip(const QString &)

See also QToolTip, statusTip, and whatsThis.

pub unsafe fn tool_tip_duration(&self) -> c_int

This property holds the widget's tooltip duration

Calls C++ function: int QWidget::toolTipDuration() const.

C++ documentation:

This property holds the widget’s tooltip duration

Specifies how long time the tooltip will be displayed, in milliseconds. If the value is -1 (default) the duration is calculated depending on the length of the tooltip.

This property was introduced in Qt 5.2.

Access functions:

int	toolTipDuration() const
void	setToolTipDuration(int msec)

See also toolTip.

pub unsafe fn top_level_widget(&self) -> QPtr<QWidget>

Use window() instead.

Calls C++ function: QWidget* QWidget::topLevelWidget() const.

C++ documentation:

Use window() instead.

pub unsafe fn under_mouse(&self) -> bool

Returns true if the widget is under the mouse cursor; otherwise returns false.

Calls C++ function: bool QWidget::underMouse() const.

C++ documentation:

Returns true if the widget is under the mouse cursor; otherwise returns false.

This value is not updated properly during drag and drop operations.

See also enterEvent() and leaveEvent().

pub unsafe fn ungrab_gesture(&self, type_: GestureType)

Unsubscribes the widget from a given gesture type

Calls C++ function: void QWidget::ungrabGesture(Qt::GestureType type).

C++ documentation:

Unsubscribes the widget from a given gesture type

This function was introduced in Qt 4.6.

See also grabGesture() and QGestureEvent.

pub unsafe fn unset_cursor(&self)

This property holds the cursor shape for this widget

Calls C++ function: void QWidget::unsetCursor().

C++ documentation:

This property holds the cursor shape for this widget

The mouse cursor will assume this shape when it's over this widget. See the list of predefined cursor objects for a range of useful shapes.

An editor widget might use an I-beam cursor:

setCursor(Qt::IBeamCursor);

If no cursor has been set, or after a call to unsetCursor(), the parent's cursor is used.

By default, this property contains a cursor with the Qt::ArrowCursor shape.

Some underlying window implementations will reset the cursor if it leaves a widget even if the mouse is grabbed. If you want to have a cursor set for all widgets, even when outside the window, consider QApplication::setOverrideCursor().

Access functions:

QCursor	cursor() const
void	setCursor(const QCursor &)
void	unsetCursor()

See also QApplication::setOverrideCursor().

pub unsafe fn unset_layout_direction(&self)

This property holds the layout direction for this widget

Calls C++ function: void QWidget::unsetLayoutDirection().

C++ documentation:

This property holds the layout direction for this widget

By default, this property is set to Qt::LeftToRight.

When the layout direction is set on a widget, it will propagate to the widget's children, but not to a child that is a window and not to a child for which setLayoutDirection() has been explicitly called. Also, child widgets added after setLayoutDirection() has been called for the parent do not inherit the parent's layout direction.

This method no longer affects text layout direction since Qt 4.7.

Access functions:

Qt::LayoutDirection	layoutDirection() const
void	setLayoutDirection(Qt::LayoutDirection direction)
void	unsetLayoutDirection()

See also QApplication::layoutDirection.

pub unsafe fn unset_locale(&self)

This property holds the widget's locale

Calls C++ function: void QWidget::unsetLocale().

C++ documentation:

This property holds the widget’s locale

As long as no special locale has been set, this is either the parent's locale or (if this widget is a top level widget), the default locale.

If the widget displays dates or numbers, these should be formatted using the widget's locale.

This property was introduced in Qt 4.3.

Access functions:

QLocale	locale() const
void	setLocale(const QLocale &locale)
void	unsetLocale()

See also QLocale and QLocale::setDefault().

pub unsafe fn update(&self)

Updates the widget unless updates are disabled or the widget is hidden.

Calls C++ function: [slot] void QWidget::update().

C++ documentation:

Updates the widget unless updates are disabled or the widget is hidden.

This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker than a call to repaint() does.

Calling update() several times normally results in just one paintEvent() call.

Qt normally erases the widget's area before the paintEvent() call. If the Qt::WA_OpaquePaintEvent widget attribute is set, the widget is responsible for painting all its pixels with an opaque color.

See also repaint(), paintEvent(), setUpdatesEnabled(), and Analog Clock Example.

pub unsafe fn update_4_int(&self, x: c_int, y: c_int, w: c_int, h: c_int)

This is an overloaded function.

Calls C++ function: void QWidget::update(int x, int y, int w, int h).

C++ documentation:

This is an overloaded function.

This version updates a rectangle (x, y, w, h) inside the widget.

pub unsafe fn update_q_rect(&self, arg1: impl CastInto<Ref<QRect>>)

This is an overloaded function.

Calls C++ function: void QWidget::update(const QRect& arg1).

C++ documentation:

This is an overloaded function.

This version updates a rectangle rect inside the widget.

pub unsafe fn update_q_region(&self, arg1: impl CastInto<Ref<QRegion>>)

This is an overloaded function.

Calls C++ function: void QWidget::update(const QRegion& arg1).

C++ documentation:

This is an overloaded function.

This version repaints a region rgn inside the widget.

pub unsafe fn update_geometry(&self)

Notifies the layout system that this widget has changed and may need to change geometry.

Calls C++ function: void QWidget::updateGeometry().

C++ documentation:

Notifies the layout system that this widget has changed and may need to change geometry.

Call this function if the sizeHint() or sizePolicy() have changed.

For explicitly hidden widgets, updateGeometry() is a no-op. The layout system will be notified as soon as the widget is shown.

pub unsafe fn updates_enabled(&self) -> bool

This property holds whether updates are enabled

Calls C++ function: bool QWidget::updatesEnabled() const.

C++ documentation:

This property holds whether updates are enabled

An updates enabled widget receives paint events and has a system background; a disabled widget does not. This also implies that calling update() and repaint() has no effect if updates are disabled.

By default, this property is true.

setUpdatesEnabled() is normally used to disable updates for a short period of time, for instance to avoid screen flicker during large changes. In Qt, widgets normally do not generate screen flicker, but on X11 the server might erase regions on the screen when widgets get hidden before they can be replaced by other widgets. Disabling updates solves this.

Example:

setUpdatesEnabled(false);
bigVisualChanges();
setUpdatesEnabled(true);

Disabling a widget implicitly disables all its children. Enabling a widget enables all child widgets except top-level widgets or those that have been explicitly disabled. Re-enabling updates implicitly calls update() on the widget.

Access functions:

bool	updatesEnabled() const
void	setUpdatesEnabled(bool enable)

See also paintEvent().

pub unsafe fn visible_region(&self) -> CppBox<QRegion>

Returns the unobscured region where paint events can occur.

Calls C++ function: QRegion QWidget::visibleRegion() const.

C++ documentation:

Returns the unobscured region where paint events can occur.

For visible widgets, this is an approximation of the area not covered by other widgets; otherwise, this is an empty region.

The repaint() function calls this function if necessary, so in general you do not need to call it.

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

This property holds the widget's What's This help text.

Calls C++ function: QString QWidget::whatsThis() const.

C++ documentation:

This property holds the widget’s What’s This help text.

By default, this property contains an empty string.

Access functions:

QString	whatsThis() const
void	setWhatsThis(const QString &)

See also QWhatsThis, QWidget::toolTip, and QWidget::statusTip.

pub unsafe fn width(&self) -> c_int

This property holds the width of the widget excluding any window frame

Calls C++ function: int QWidget::width() const.

C++ documentation:

This property holds the width of the widget excluding any window frame

See the Window Geometry documentation for an overview of geometry issues with windows.

Note: Do not use this function to find the width of a screen on a multiple screen desktop. Read this note for details.

By default, this property contains a value that depends on the user's platform and screen geometry.

Access functions:

int	width() const

See also geometry, height, and size.

pub unsafe fn win_id(&self) -> c_ulonglong

Returns the window system identifier of the widget.

Calls C++ function: unsigned long long QWidget::winId() const.

C++ documentation:

Returns the window system identifier of the widget.

Portable in principle, but if you use it you are probably about to do something non-portable. Be careful.

If a widget is non-native (alien) and winId() is invoked on it, that widget will be provided a native handle.

This value may change at run-time. An event with type QEvent::WinIdChange will be sent to the widget following a change in window system identifier.

See also find().

pub unsafe fn window(&self) -> QPtr<QWidget>

Returns the window for this widget, i.e. the next ancestor widget that has (or could have) a window-system frame.

Calls C++ function: QWidget* QWidget::window() const.

C++ documentation:

Returns the window for this widget, i.e. the next ancestor widget that has (or could have) a window-system frame.

If the widget is a window, the widget itself is returned.

Typical usage is changing the window title:

aWidget->window()->setWindowTitle(“New Window Title”);

See also isWindow().

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

This property holds the file path associated with a widget

Calls C++ function: QString QWidget::windowFilePath() const.

C++ documentation:

This property holds the file path associated with a widget

This property only makes sense for windows. It associates a file path with a window. If you set the file path, but have not set the window title, Qt sets the window title to the file name of the specified path, obtained using QFileInfo::fileName().

If the window title is set at any point, then the window title takes precedence and will be shown instead of the file path string.

Additionally, on macOS, this has an added benefit that it sets the proxy icon for the window, assuming that the file path exists.

If no file path is set, this property contains an empty string.

By default, this property contains an empty string.

This property was introduced in Qt 4.4.

Access functions:

QString	windowFilePath() const
void	setWindowFilePath(const QString &filePath)

See also windowTitle and windowIcon.

pub unsafe fn window_flags(&self) -> QFlags<WindowType>

Window flags are a combination of a type (e.g. Qt::Dialog) and zero or more hints to the window system (e.g. Qt::FramelessWindowHint).

Calls C++ function: QFlags<Qt::WindowType> QWidget::windowFlags() const.

C++ documentation:

Window flags are a combination of a type (e.g. Qt::Dialog) and zero or more hints to the window system (e.g. Qt::FramelessWindowHint).

If the widget had type Qt::Widget or Qt::SubWindow and becomes a window (Qt::Window, Qt::Dialog, etc.), it is put at position (0, 0) on the desktop. If the widget is a window and becomes a Qt::Widget or Qt::SubWindow, it is put at position (0, 0) relative to its parent widget.

Note: This function calls setParent() when changing the flags for a window, causing the widget to be hidden. You must call show() to make the widget visible again..

Access functions:

Qt::WindowFlags	windowFlags() const
void	setWindowFlags(Qt::WindowFlags type)

See also windowType(), setWindowFlag(), and Window Flags Example.

pub unsafe fn window_handle(&self) -> QPtr<QWindow>

If this is a native widget, return the associated QWindow. Otherwise return null.

Calls C++ function: QWindow* QWidget::windowHandle() const.

C++ documentation:

If this is a native widget, return the associated QWindow. Otherwise return null.

Native widgets include toplevel widgets, QGLWidget, and child widgets on which winId() was called.

This function was introduced in Qt 5.0.

See also winId().

pub unsafe fn window_icon(&self) -> CppBox<QIcon>

This property holds the widget's icon

Calls C++ function: QIcon QWidget::windowIcon() const.

C++ documentation:

This property holds the widget’s icon

This property only makes sense for windows. If no icon has been set, windowIcon() returns the application icon (QApplication::windowIcon()).

Access functions:

QIcon	windowIcon() const
void	setWindowIcon(const QIcon &icon)

Notifier signal:

void	windowIconChanged(const QIcon &icon)

See also windowTitle.

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

This property holds the text to be displayed on the icon of a minimized window

Calls C++ function: QString QWidget::windowIconText() const.

C++ documentation:

This property holds the text to be displayed on the icon of a minimized window

This property only makes sense for windows. If no icon text has been set, this accessor returns an empty string. It is only implemented on the X11 platform, and only certain window managers use this window property.

This property is deprecated.

Access functions:

QString	windowIconText() const
void	setWindowIconText(const QString &)

Notifier signal:

void	windowIconTextChanged(const QString &iconText)

See also windowIcon and windowTitle.

Member Function Documentation

pub unsafe fn window_modality(&self) -> WindowModality

This property holds which windows are blocked by the modal widget

Calls C++ function: Qt::WindowModality QWidget::windowModality() const.

C++ documentation:

This property holds which windows are blocked by the modal widget

This property only makes sense for windows. A modal widget prevents widgets in other windows from getting input. The value of this property controls which windows are blocked when the widget is visible. Changing this property while the window is visible has no effect; you must hide() the widget first, then show() it again.

By default, this property is Qt::NonModal.

This property was introduced in Qt 4.1.

Access functions:

Qt::WindowModality	windowModality() const
void	setWindowModality(Qt::WindowModality windowModality)

See also isWindow(), QWidget::modal, and QDialog.

pub unsafe fn window_opacity(&self) -> c_double

This property holds the level of opacity for the window.

Calls C++ function: double QWidget::windowOpacity() const.

C++ documentation:

This property holds the level of opacity for the window.

The valid range of opacity is from 1.0 (completely opaque) to 0.0 (completely transparent).

By default the value of this property is 1.0.

This feature is available on Embedded Linux, macOS, Windows, and X11 platforms that support the Composite extension.

Note: On X11 you need to have a composite manager running, and the X11 specific _NET_WM_WINDOW_OPACITY atom needs to be supported by the window manager you are using.

Warning: Changing this property from opaque to transparent might issue a paint event that needs to be processed before the window is displayed correctly. This affects mainly the use of QPixmap::grabWindow(). Also note that semi-transparent windows update and resize significantly slower than opaque windows.

Access functions:

qreal	windowOpacity() const
void	setWindowOpacity(qreal level)

See also setMask().

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

Returns the window's role, or an empty string.

Calls C++ function: QString QWidget::windowRole() const.

C++ documentation:

Returns the window’s role, or an empty string.

See also setWindowRole(), windowIcon, and windowTitle.

pub unsafe fn window_state(&self) -> QFlags<WindowState>

Returns the current window state. The window state is a OR'ed combination of Qt::WindowState: Qt::WindowMinimized, Qt::WindowMaximized, Qt::WindowFullScreen, and Qt::WindowActive.

Calls C++ function: QFlags<Qt::WindowState> QWidget::windowState() const.

C++ documentation:

Returns the current window state. The window state is a OR’ed combination of Qt::WindowState: Qt::WindowMinimized, Qt::WindowMaximized, Qt::WindowFullScreen, and Qt::WindowActive.

See also Qt::WindowState and setWindowState().

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

This property holds the window title (caption)

Calls C++ function: QString QWidget::windowTitle() const.

C++ documentation:

This property holds the window title (caption)

This property only makes sense for top-level widgets, such as windows and dialogs. If no caption has been set, the title is based of the windowFilePath. If neither of these is set, then the title is an empty string.

If you use the windowModified mechanism, the window title must contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the windowModified property is false (the default), the placeholder is simply removed.

On some desktop platforms (including Windows and Unix), the application name (from QGuiApplication::applicationDisplayName) is added at the end of the window title, if set. This is done by the QPA plugin, so it is shown to the user, but isn't part of the windowTitle string.

Access functions:

QString	windowTitle() const
void	setWindowTitle(const QString &)

Notifier signal:

void	windowTitleChanged(const QString &title)

See also windowIcon, windowModified, and windowFilePath.

pub unsafe fn window_type(&self) -> WindowType

Returns the window type of this widget. This is identical to windowFlags() & Qt::WindowType_Mask.

Calls C++ function: Qt::WindowType QWidget::windowType() const.

C++ documentation:

Returns the window type of this widget. This is identical to windowFlags() & Qt::WindowType_Mask.

See also windowFlags.

pub unsafe fn x(&self) -> c_int

This property holds the x coordinate of the widget relative to its parent including any window frame

Calls C++ function: int QWidget::x() const.

C++ documentation:

This property holds the x coordinate of the widget relative to its parent including any window frame

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property has a value of 0.

Access functions:

int

x() const

See also frameGeometry, y, and pos.

pub unsafe fn y(&self) -> c_int

This property holds the y coordinate of the widget relative to its parent and including any window frame

Calls C++ function: int QWidget::y() const.

C++ documentation:

This property holds the y coordinate of the widget relative to its parent and including any window frame

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property has a value of 0.

Access functions:

int

y() const

See also frameGeometry, x, and pos.

Methods from Deref<Target = QObject>

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

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

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

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

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

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

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

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

C++ documentation:

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

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

See also deleteLater() and QPointer.

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

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

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

C++ documentation:

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

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

Note: Notifier signal for property objectName.

See also QObject::objectName.

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

Schedules this object for deletion.

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

C++ documentation:

Schedules this object for deletion.

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

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

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

See also destroyed() and QPointer.

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

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

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

C++ documentation:

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

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

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

Signals emitted while being blocked are not buffered.

See also signalsBlocked() and QSignalBlocker.

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

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

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

C++ documentation:

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

  typedef QList<QObject*> QObjectList;

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

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

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

pub unsafe fn delete_later(&self)

Schedules this object for deletion.

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

C++ documentation:

Schedules this object for deletion.

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

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

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

See also destroyed() and QPointer.

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

This function overloads disconnect().

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

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

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

Note: This function is thread-safe.

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

This function overloads disconnect().

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

C++ documentation:

This function overloads disconnect().

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

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

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

This function overloads disconnect().

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

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

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

Note: This function is thread-safe.

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

This function overloads disconnect().

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

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

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

Note: This function is thread-safe.

pub unsafe fn disconnect(&self) -> bool

This function overloads disconnect().

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

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

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

Note: This function is thread-safe.

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

This function overloads disconnect().

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

C++ documentation:

This function overloads disconnect().

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

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

pub unsafe fn dump_object_info_mut(&self)

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

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

C++ documentation:

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

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

See also dumpObjectTree().

pub unsafe fn dump_object_info(&self)

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

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

C++ documentation:

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

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

See also dumpObjectTree().

pub unsafe fn dump_object_tree_mut(&self)

Dumps a tree of children to the debug output.

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

C++ documentation:

Dumps a tree of children to the debug output.

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

See also dumpObjectInfo().

pub unsafe fn dump_object_tree(&self)

Dumps a tree of children to the debug output.

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

C++ documentation:

Dumps a tree of children to the debug output.

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

See also dumpObjectInfo().

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

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

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

C++ documentation:

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

This function was introduced in Qt 4.2.

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

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

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

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

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

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

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

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

C++ documentation:

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

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

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

Example:

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

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

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

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

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

C++ documentation:

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

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

Example:

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

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

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

See also installEventFilter().

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

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

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

C++ documentation:

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

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

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

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

This example returns a QListWidget child of parentWidget:

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

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

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

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

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

See also findChildren().

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

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

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

C++ documentation:

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

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

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

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

This example returns a QListWidget child of parentWidget:

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

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

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

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

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

See also findChildren().

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

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

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

C++ documentation:

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

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

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

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

This example returns a QListWidget child of parentWidget:

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

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

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

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

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

See also findChildren().

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

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

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

C++ documentation:

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

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

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

This example returns all QPushButtons that are children of parentWidget:

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

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

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

See also findChild().

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

This function overloads findChildren().

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

C++ documentation:

This function overloads findChildren().

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

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

This function overloads findChildren().

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

C++ documentation:

This function overloads findChildren().

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

This function was introduced in Qt 5.0.

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

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

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

C++ documentation:

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

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

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

This example returns all QPushButtons that are children of parentWidget:

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

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

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

See also findChild().

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

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

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

C++ documentation:

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

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

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

This example returns all QPushButtons that are children of parentWidget:

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

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

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

See also findChild().

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

This function overloads findChildren().

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

C++ documentation:

This function overloads findChildren().

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

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

This function overloads findChildren().

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

C++ documentation:

This function overloads findChildren().

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

This function was introduced in Qt 5.0.

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

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

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

C++ documentation:

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

A class is considered to inherit itself.

Example:

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

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

See also metaObject() and qobject_cast().

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

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

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

C++ documentation:

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

  monitoredObj->installEventFilter(filterObj);

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

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

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

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

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

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

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

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

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

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

pub unsafe fn is_widget_type(&self) -> bool

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

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

C++ documentation:

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

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

pub unsafe fn is_window_type(&self) -> bool

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

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

C++ documentation:

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

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

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

Kills the timer with timer identifier, id.

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

C++ documentation:

Kills the timer with timer identifier, id.

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

See also timerEvent() and startTimer().

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

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

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

C++ documentation:

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

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

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

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

Example:

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

See also staticMetaObject.

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

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

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

C++ documentation:

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

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

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

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

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

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

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

See also thread().

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

This property holds the name of this object

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

C++ documentation:

This property holds the name of this object

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

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

By default, this property contains an empty string.

Access functions:

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

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

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

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

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

Returns a pointer to the parent object.

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

C++ documentation:

Returns a pointer to the parent object.

See also setParent() and children().

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

Returns the value of the object's name property.

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

C++ documentation:

Returns the value of the object’s name property.

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

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

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

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

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

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

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

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

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

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

C++ documentation:

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

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

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

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

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

This property holds the name of this object

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

C++ documentation:

This property holds the name of this object

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

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

By default, this property contains an empty string.

Access functions:

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

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

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

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

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

Makes the object a child of parent.

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

C++ documentation:

Makes the object a child of parent.

See also parent() and children().

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

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

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

C++ documentation:

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

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

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

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

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

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

pub unsafe fn signals_blocked(&self) -> bool

Returns true if signals are blocked; otherwise returns false.

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

C++ documentation:

Returns true if signals are blocked; otherwise returns false.

Signals are not blocked by default.

See also blockSignals() and QSignalBlocker.

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

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

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

C++ documentation:

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

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

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

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

Example:

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

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

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

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

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

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

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

C++ documentation:

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

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

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

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

Example:

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

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

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

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

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

Returns the thread in which the object lives.

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

C++ documentation:

Returns the thread in which the object lives.

See also moveToThread().

Trait Implementations

impl CppDeletable for QListWidget

unsafe fn delete(&self)

Destroys the list widget and all its items.

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

C++ documentation:

Destroys the list widget and all its items.

impl Deref for QListWidget

fn deref(&self) -> &QListView

Calls C++ function: QListView* static_cast<QListView*>(QListWidget* ptr).

type Target = QListView

The resulting type after dereferencing.

impl DynamicCast<QListWidget> for QAbstractItemView

unsafe fn dynamic_cast(ptr: Ptr<QAbstractItemView>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* dynamic_cast<QListWidget*>(QAbstractItemView* ptr).

impl DynamicCast<QListWidget> for QAbstractScrollArea

unsafe fn dynamic_cast(ptr: Ptr<QAbstractScrollArea>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* dynamic_cast<QListWidget*>(QAbstractScrollArea* ptr).

impl DynamicCast<QListWidget> for QFrame

unsafe fn dynamic_cast(ptr: Ptr<QFrame>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* dynamic_cast<QListWidget*>(QFrame* ptr).

impl DynamicCast<QListWidget> for QListView

unsafe fn dynamic_cast(ptr: Ptr<QListView>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* dynamic_cast<QListWidget*>(QListView* ptr).

impl DynamicCast<QListWidget> for QObject

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

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

impl DynamicCast<QListWidget> for QPaintDevice

unsafe fn dynamic_cast(ptr: Ptr<QPaintDevice>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* dynamic_cast<QListWidget*>(QPaintDevice* ptr).

impl DynamicCast<QListWidget> for QWidget

unsafe fn dynamic_cast(ptr: Ptr<QWidget>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* dynamic_cast<QListWidget*>(QWidget* ptr).

impl StaticDowncast<QListWidget> for QAbstractItemView

unsafe fn static_downcast(ptr: Ptr<QAbstractItemView>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* static_cast<QListWidget*>(QAbstractItemView* ptr).

impl StaticDowncast<QListWidget> for QAbstractScrollArea

unsafe fn static_downcast(ptr: Ptr<QAbstractScrollArea>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* static_cast<QListWidget*>(QAbstractScrollArea* ptr).

impl StaticDowncast<QListWidget> for QFrame

unsafe fn static_downcast(ptr: Ptr<QFrame>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* static_cast<QListWidget*>(QFrame* ptr).

impl StaticDowncast<QListWidget> for QListView

unsafe fn static_downcast(ptr: Ptr<QListView>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* static_cast<QListWidget*>(QListView* ptr).

impl StaticDowncast<QListWidget> for QObject

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

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

impl StaticDowncast<QListWidget> for QPaintDevice

unsafe fn static_downcast(ptr: Ptr<QPaintDevice>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* static_cast<QListWidget*>(QPaintDevice* ptr).

impl StaticDowncast<QListWidget> for QWidget

unsafe fn static_downcast(ptr: Ptr<QWidget>) -> Ptr<QListWidget>

Calls C++ function: QListWidget* static_cast<QListWidget*>(QWidget* ptr).

impl StaticUpcast<QAbstractItemView> for QListWidget

unsafe fn static_upcast(ptr: Ptr<QListWidget>) -> Ptr<QAbstractItemView>

Calls C++ function: QAbstractItemView* static_cast<QAbstractItemView*>(QListWidget* ptr).

impl StaticUpcast<QAbstractScrollArea> for QListWidget

unsafe fn static_upcast(ptr: Ptr<QListWidget>) -> Ptr<QAbstractScrollArea>

Calls C++ function: QAbstractScrollArea* static_cast<QAbstractScrollArea*>(QListWidget* ptr).

impl StaticUpcast<QFrame> for QListWidget

unsafe fn static_upcast(ptr: Ptr<QListWidget>) -> Ptr<QFrame>

Calls C++ function: QFrame* static_cast<QFrame*>(QListWidget* ptr).

impl StaticUpcast<QListView> for QListWidget

unsafe fn static_upcast(ptr: Ptr<QListWidget>) -> Ptr<QListView>

Calls C++ function: QListView* static_cast<QListView*>(QListWidget* ptr).

impl StaticUpcast<QObject> for QListWidget

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

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

impl StaticUpcast<QPaintDevice> for QListWidget

unsafe fn static_upcast(ptr: Ptr<QListWidget>) -> Ptr<QPaintDevice>

Calls C++ function: QPaintDevice* static_cast<QPaintDevice*>(QListWidget* ptr).

impl StaticUpcast<QWidget> for QListWidget

unsafe fn static_upcast(ptr: Ptr<QListWidget>) -> Ptr<QWidget>

Calls C++ function: QWidget* static_cast<QWidget*>(QListWidget* ptr).