[−][src]Struct qt_widgets::QToolBox

#[repr(C)]pub struct QToolBox { /* fields omitted */ }

The QToolBox class provides a column of tabbed widget items.

C++ class: QToolBox.

C++ documentation:

The QToolBox class provides a column of tabbed widget items.

A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab's item is a QWidget.

Each item has an itemText(), an optional itemIcon(), an optional itemToolTip(), and a widget(). The item's attributes can be changed with setItemText(), setItemIcon(), and setItemToolTip(). Each item can be enabled or disabled individually with setItemEnabled().

Items are added using addItem(), or inserted at particular positions using insertItem(). The total number of items is given by count(). Items can be deleted with delete, or removed from the toolbox with removeItem(). Combining removeItem() and insertItem() allows you to move items to different positions.

The index of the current item widget is returned by currentIndex(), and set with setCurrentIndex(). The index of a particular item can be found using indexOf(), and the item at a given index is returned by item().

The currentChanged() signal is emitted when the current item is changed.

Methods

`impl QToolBox`[src]

`pub fn slot_set_current_index(&self) -> Receiver<(c_int,)>`[src]

This property holds the index of the current item

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

C++ documentation:

This property holds the index of the current item

By default, for an empty toolbox, this property has a value of -1.

Access functions:

int	currentIndex() const
void	setCurrentIndex(int index)

Notifier signal:

void	currentChanged(int index)

See also indexOf() and widget().

`pub fn slot_set_current_widget(&self) -> Receiver<(*mut QWidget,)>`[src]

Makeswidget the current widget. The widget must be an item in this tool box.

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

C++ documentation:

Makeswidget the current widget. The widget must be an item in this tool box.

See also addItem(), setCurrentIndex(), and currentWidget().

`pub fn current_changed(&self) -> Signal<(c_int,)>`[src]

This signal is emitted when the current item is changed. The new current item's index is passed in index, or -1 if there is no current item.

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

C++ documentation:

This signal is emitted when the current item is changed. The new current item's index is passed in index, or -1 if there is no current item.

Note: Notifier signal for property currentIndex.

`pub unsafe fn add_item_2a( &self, widget: impl CastInto<Ptr<QWidget>>, text: impl CastInto<Ref<QString>> ) -> c_int`[src]

This is an overloaded function.

Calls C++ function: int QToolBox::addItem(QWidget* widget, const QString& text).

C++ documentation:

This is an overloaded function.

Adds the widget w in a new tab at bottom of the toolbox. The new tab's text is set to text. Returns the new tab's index.

`pub unsafe fn add_item_3a( &self, widget: impl CastInto<Ptr<QWidget>>, icon: impl CastInto<Ref<QIcon>>, text: impl CastInto<Ref<QString>> ) -> c_int`[src]

Adds the widget in a new tab at bottom of the toolbox. The new tab's text is set to text, and the iconSet is displayed to the left of the text. Returns the new tab's index.

Calls C++ function: int QToolBox::addItem(QWidget* widget, const QIcon& icon, const QString& text).

C++ documentation:

Adds the widget in a new tab at bottom of the toolbox. The new tab's text is set to text, and the iconSet is displayed to the left of the text. Returns the new tab's index.

`pub unsafe fn count(&self) -> c_int`[src]

This property holds the number of items contained in the toolbox.

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

C++ documentation:

This property holds the number of items contained in the toolbox.

By default, this property has a value of 0.

Access functions:

int	count() const

`pub unsafe fn current_index(&self) -> c_int`[src]

This property holds the index of the current item

Calls C++ function: int QToolBox::currentIndex() const.

C++ documentation:

This property holds the index of the current item

By default, for an empty toolbox, this property has a value of -1.

Access functions:

int	currentIndex() const
void	setCurrentIndex(int index)

Notifier signal:

void	currentChanged(int index)

See also indexOf() and widget().

`pub unsafe fn current_widget(&self) -> QPtr<QWidget>`[src]

Returns a pointer to the current widget, or 0 if there is no such item.

Calls C++ function: QWidget* QToolBox::currentWidget() const.

C++ documentation:

Returns a pointer to the current widget, or 0 if there is no such item.

See also currentIndex() and setCurrentWidget().

`pub unsafe fn index_of(&self, widget: impl CastInto<Ptr<QWidget>>) -> c_int`[src]

Returns the index of widget, or -1 if the item does not exist.

Calls C++ function: int QToolBox::indexOf(QWidget* widget) const.

C++ documentation:

Returns the index of widget, or -1 if the item does not exist.

`pub unsafe fn insert_item_3a( &self, index: c_int, widget: impl CastInto<Ptr<QWidget>>, text: impl CastInto<Ref<QString>> ) -> c_int`[src]

This is an overloaded function.

Calls C++ function: int QToolBox::insertItem(int index, QWidget* widget, const QString& text).

C++ documentation:

This is an overloaded function.

Inserts the widget at position index, or at the bottom of the toolbox if index is out of range. The new item's text is set to text. Returns the new item's index.

`pub unsafe fn insert_item_4a( &self, index: c_int, widget: impl CastInto<Ptr<QWidget>>, icon: impl CastInto<Ref<QIcon>>, text: impl CastInto<Ref<QString>> ) -> c_int`[src]

Inserts the widget at position index, or at the bottom of the toolbox if index is out of range. The new item's text is set to text, and the icon is displayed to the left of the text. Returns the new item's index.

Calls C++ function: int QToolBox::insertItem(int index, QWidget* widget, const QIcon& icon, const QString& text).

C++ documentation:

Inserts the widget at position index, or at the bottom of the toolbox if index is out of range. The new item's text is set to text, and the icon is displayed to the left of the text. Returns the new item's index.

`pub unsafe fn is_item_enabled(&self, index: c_int) -> bool`[src]

Returns true if the item at position index is enabled; otherwise returns false.

Calls C++ function: bool QToolBox::isItemEnabled(int index) const.

C++ documentation:

Returns true if the item at position index is enabled; otherwise returns false.

`pub unsafe fn item_icon(&self, index: c_int) -> CppBox<QIcon>`[src]

Returns the icon of the item at position index, or a null icon if index is out of range.

Calls C++ function: QIcon QToolBox::itemIcon(int index) const.

C++ documentation:

Returns the icon of the item at position index, or a null icon if index is out of range.

See also setItemIcon().

`pub unsafe fn item_text(&self, index: c_int) -> CppBox<QString>`[src]

Returns the text of the item at position index, or an empty string if index is out of range.

Calls C++ function: QString QToolBox::itemText(int index) const.

C++ documentation:

Returns the text of the item at position index, or an empty string if index is out of range.

See also setItemText().

`pub unsafe fn item_tool_tip(&self, index: c_int) -> CppBox<QString>`[src]

Returns the tooltip of the item at position index, or an empty string if index is out of range.

Calls C++ function: QString QToolBox::itemToolTip(int index) const.

C++ documentation:

Returns the tooltip of the item at position index, or an empty string if index is out of range.

See also setItemToolTip().

`pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>`[src]

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

`pub unsafe fn new_2a( parent: impl CastInto<Ptr<QWidget>>, f: QFlags<WindowType> ) -> QBox<QToolBox>`[src]

Constructs a new toolbox with the given parent and the flags, f.

Calls C++ function: [constructor] void QToolBox::QToolBox(QWidget* parent = …, QFlags<Qt::WindowType> f = …).

C++ documentation:

Constructs a new toolbox with the given parent and the flags, f.

`pub unsafe fn new_0a() -> QBox<QToolBox>`[src]

The QToolBox class provides a column of tabbed widget items.

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

C++ documentation:

The QToolBox class provides a column of tabbed widget items.

A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab's item is a QWidget.

Each item has an itemText(), an optional itemIcon(), an optional itemToolTip(), and a widget(). The item's attributes can be changed with setItemText(), setItemIcon(), and setItemToolTip(). Each item can be enabled or disabled individually with setItemEnabled().

Items are added using addItem(), or inserted at particular positions using insertItem(). The total number of items is given by count(). Items can be deleted with delete, or removed from the toolbox with removeItem(). Combining removeItem() and insertItem() allows you to move items to different positions.

The index of the current item widget is returned by currentIndex(), and set with setCurrentIndex(). The index of a particular item can be found using indexOf(), and the item at a given index is returned by item().

The currentChanged() signal is emitted when the current item is changed.

`pub unsafe fn new_1a(parent: impl CastInto<Ptr<QWidget>>) -> QBox<QToolBox>`[src]

Constructs a new toolbox with the given parent and the flags, f.

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

C++ documentation:

Constructs a new toolbox with the given parent and the flags, f.

`pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: mut mut c_void ) -> c_int`[src]

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

`pub unsafe fn qt_metacast(&self, arg1: const c_char) -> mut c_void`[src]

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

`pub unsafe fn remove_item(&self, index: c_int)`[src]

Removes the item at position index from the toolbox. Note that the widget is not deleted.

Calls C++ function: void QToolBox::removeItem(int index).

C++ documentation:

Removes the item at position index from the toolbox. Note that the widget is not deleted.

`pub unsafe fn set_current_index(&self, index: c_int)`[src]

This property holds the index of the current item

Calls C++ function: [slot] void QToolBox::setCurrentIndex(int index).

C++ documentation:

This property holds the index of the current item

By default, for an empty toolbox, this property has a value of -1.

Access functions:

int	currentIndex() const
void	setCurrentIndex(int index)

Notifier signal:

void	currentChanged(int index)

See also indexOf() and widget().

`pub unsafe fn set_current_widget(&self, widget: impl CastInto<Ptr<QWidget>>)`[src]

Makeswidget the current widget. The widget must be an item in this tool box.

Calls C++ function: [slot] void QToolBox::setCurrentWidget(QWidget* widget).

C++ documentation:

Makeswidget the current widget. The widget must be an item in this tool box.

See also addItem(), setCurrentIndex(), and currentWidget().

`pub unsafe fn set_item_enabled(&self, index: c_int, enabled: bool)`[src]

If enabled is true then the item at position index is enabled; otherwise the item at position index is disabled.

Calls C++ function: void QToolBox::setItemEnabled(int index, bool enabled).

C++ documentation:

If enabled is true then the item at position index is enabled; otherwise the item at position index is disabled.

See also isItemEnabled().

`pub unsafe fn set_item_icon( &self, index: c_int, icon: impl CastInto<Ref<QIcon>> )`[src]

Sets the icon of the item at position index to icon.

Calls C++ function: void QToolBox::setItemIcon(int index, const QIcon& icon).

C++ documentation:

Sets the icon of the item at position index to icon.

See also itemIcon().

`pub unsafe fn set_item_text( &self, index: c_int, text: impl CastInto<Ref<QString>> )`[src]

Sets the text of the item at position index to text.

Calls C++ function: void QToolBox::setItemText(int index, const QString& text).

C++ documentation:

Sets the text of the item at position index to text.

If the provided text contains an ampersand character ('&'), a mnemonic is automatically created for it. The character that follows the '&' will be used as the shortcut key. Any previous mnemonic will be overwritten, or cleared if no mnemonic is defined by the text. See the QShortcut documentation for details (to display an actual ampersand, use '&&').

See also itemText().

`pub unsafe fn set_item_tool_tip( &self, index: c_int, tool_tip: impl CastInto<Ref<QString>> )`[src]

Sets the tooltip of the item at position index to toolTip.

Calls C++ function: void QToolBox::setItemToolTip(int index, const QString& toolTip).

C++ documentation:

Sets the tooltip of the item at position index to toolTip.

See also itemToolTip().

`pub unsafe fn static_meta_object() -> Ref<QMetaObject>`[src]

Returns a reference to the staticMetaObject field.

`pub unsafe fn tr( s: const c_char, c: const c_char, n: c_int ) -> CppBox<QString>`[src]

Calls C++ function: static QString QToolBox::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>`[src]

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

`pub unsafe fn widget(&self, index: c_int) -> QPtr<QWidget>`[src]

Returns the widget at position index, or 0 if there is no such item.

Calls C++ function: QWidget* QToolBox::widget(int index) const.

C++ documentation:

Returns the widget at position index, or 0 if there is no such item.

Methods from Deref<Target = QFrame>

`pub unsafe fn frame_rect(&self) -> CppBox<QRect>`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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>`[src]

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

`pub unsafe fn mid_line_width(&self) -> c_int`[src]

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`[src]

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`[src]

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

`pub unsafe fn set_frame_rect(&self, arg1: impl CastInto<Ref<QRect>>)`[src]

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)`[src]

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)`[src]

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)`[src]

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