QTabBar

Create and control tabbar.

This class is a JS wrapper around Qt's QTabBar class

The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs.

Example

const { QTabBar } = require("@nodegui/nodegui");
const tabBar = new QTabBar();

Hierarchy

↳ NodeWidget‹QTabBarSignals›

↳ QTabBar

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new QTabBar(): QTabBar

Overrides NodeWidget.constructor

Returns: QTabBar

+ new QTabBar(parent: NodeWidget‹any›): QTabBar

Overrides NodeWidget.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QTabBar

Properties

Optional _layout

• _layout? : NodeLayout‹QTabBarSignals›

Inherited from QMenu._layout


_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


actions

• actions: Set‹QAction›

Inherited from QMenu.actions


native

• native: NativeElement

Overrides Component.native


nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren


Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent


type

• type: string = "widget"

Inherited from QMenu.type

Accessors

layout

• get layout(): NodeLayout‹QTabBarSignals› | undefined

Inherited from QMenu.layout

Returns: NodeLayout‹QTabBarSignals› | undefined

• set layout(l: NodeLayout‹QTabBarSignals› | undefined): void

Inherited from QMenu.layout

Parameters:

NameType
lNodeLayout‹QTabBarSignals› | undefined

Returns: void

Methods

acceptDrops

â–¸ acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean


accessibleTabName

â–¸ accessibleTabName(index: number): string

Parameters:

NameType
indexnumber

Returns: string


activateWindow

â–¸ activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void


addAction

â–¸ addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

NameType
actionQAction | string

Returns: QAction


addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QTabBarSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

â–ª SignalType: keyof QTabBarSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQTabBarSignals[SignalType]Corresponding callback for the signal as mentioned in the widget's signal interface

Returns: void

void

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface

â–¸ addEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.addEventListener

Parameters:

â–ª eventType: WidgetEventTypes

â–ª callback: function

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


addTab

â–¸ addTab(icon: QIcon | undefined, text: string): number

Parameters:

NameType
iconQIcon | undefined
textstring

Returns: number


adjustSize

â–¸ adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void


autoHide

â–¸ autoHide(): boolean

Returns: boolean


changeCurrentOnDrag

â–¸ changeCurrentOnDrag(): boolean

Returns: boolean


close

â–¸ close(): boolean

Inherited from QMenu.close

Returns: boolean


count

â–¸ count(): number

Returns: number


currentIndex

â–¸ currentIndex(): number

Returns: number


documentMode

â–¸ documentMode(): boolean

Returns: boolean


drawBase

â–¸ drawBase(): boolean

Returns: boolean


elideMode

â–¸ elideMode(): TextElideMode

Returns: TextElideMode


expanding

â–¸ expanding(): boolean

Returns: boolean


font

â–¸ font(): QFont

Inherited from QMenu.font

Returns: QFont


geometry

â–¸ geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect


getFlexNode

â–¸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode


hasMouseTracking

â–¸ hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean


hide

â–¸ hide(): void

Inherited from QMenu.hide

Returns: void


iconSize

â–¸ iconSize(): QSize

Returns: QSize


inherits

â–¸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


insertTab

â–¸ insertTab(index: number, icon: QIcon | undefined, text: string): number

Parameters:

NameType
indexnumber
iconQIcon | undefined
textstring

Returns: number


isEnabled

â–¸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean


isMovable

â–¸ isMovable(): boolean

Returns: boolean


isTabEnabled

â–¸ isTabEnabled(index: number): boolean

Parameters:

NameType
indexnumber

Returns: boolean


isVisible

â–¸ isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean


lower

â–¸ lower(): void

Inherited from QMenu.lower

Returns: void


mapFromGlobal

â–¸ mapFromGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapFromGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapFromParent

â–¸ mapFromParent(pos: QPoint): QPoint

Inherited from QMenu.mapFromParent

Parameters:

NameType
posQPoint

Returns: QPoint


mapToGlobal

â–¸ mapToGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapToGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapToParent

â–¸ mapToParent(pos: QPoint): QPoint

Inherited from QMenu.mapToParent

Parameters:

NameType
posQPoint

Returns: QPoint


maximumSize

â–¸ maximumSize(): QSize

Inherited from QMenu.maximumSize

Returns: QSize


minimumSize

â–¸ minimumSize(): QSize

Inherited from QMenu.minimumSize

Returns: QSize


move

â–¸ move(x: number, y: number): void

Inherited from QMenu.move

Parameters:

NameType
xnumber
ynumber

Returns: void


moveTab

â–¸ moveTab(from: number, to: number): void

Parameters:

NameType
fromnumber
tonumber

Returns: void


objectName

â–¸ objectName(): string

Inherited from NodeObject.objectName

Returns: string


pos

â–¸ pos(): object

Inherited from QMenu.pos

Returns: object

  • x: number

  • y: number


property

â–¸ property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


raise

â–¸ raise(): void

Inherited from QMenu.raise

Returns: void


removeAction

â–¸ removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

NameType
actionQAction

Returns: void


removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QTabBarSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

â–ª SignalType: keyof QTabBarSignals

Parameters:

NameType
signalTypeSignalType
callbackQTabBarSignals[SignalType]

Returns: void

â–¸ removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

â–ª eventType: WidgetEventTypes

â–ª callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


removeTab

â–¸ removeTab(index: number): void

Parameters:

NameType
indexnumber

Returns: void


repaint

â–¸ repaint(): void

Inherited from QMenu.repaint

Returns: void


repolish

â–¸ repolish(): void

Inherited from QMenu.repolish

Returns: void


resize

â–¸ resize(width: number, height: number): void

Inherited from QMenu.resize

Parameters:

NameType
widthnumber
heightnumber

Returns: void


selectionBehaviorOnRemove

â–¸ selectionBehaviorOnRemove(): SelectionBehavior

Returns: SelectionBehavior


setAcceptDrops

â–¸ setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

NameType
onboolean

Returns: void


setAccessibleTabName

â–¸ setAccessibleTabName(index: number, name: string): void

Parameters:

NameType
indexnumber
namestring

Returns: void


setAttribute

â–¸ setAttribute(attribute: WidgetAttribute, switchOn: boolean): void

Inherited from QMenu.setAttribute

Parameters:

NameType
attributeWidgetAttribute
switchOnboolean

Returns: void


setAutoHide

â–¸ setAutoHide(hide: boolean): void

Parameters:

NameType
hideboolean

Returns: void


setChangeCurrentOnDrag

â–¸ setChangeCurrentOnDrag(change: boolean): void

Parameters:

NameType
changeboolean

Returns: void


setContextMenuPolicy

â–¸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

NameType
contextMenuPolicyContextMenuPolicy

Returns: void


setCurrentIndex

â–¸ setCurrentIndex(index: number): void

Parameters:

NameType
indexnumber

Returns: void


setCursor

â–¸ setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

NameType
cursorCursorShape | QCursor

Returns: void


setDocumentMode

â–¸ setDocumentMode(set: boolean): void

Parameters:

NameType
setboolean

Returns: void


setDrawBase

â–¸ setDrawBase(drawTheBase: boolean): void

Parameters:

NameType
drawTheBaseboolean

Returns: void


setElideMode

â–¸ setElideMode(mode: TextElideMode): void

Parameters:

NameType
modeTextElideMode

Returns: void


setEnabled

â–¸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

NameType
enabledboolean

Returns: void


setExpanding

â–¸ setExpanding(enabled: boolean): void

Parameters:

NameType
enabledboolean

Returns: void


setFixedSize

â–¸ setFixedSize(width: number, height: number): void

Inherited from QMenu.setFixedSize

Parameters:

NameType
widthnumber
heightnumber

Returns: void


setFlexNodeSizeControlled

â–¸ setFlexNodeSizeControlled(isSizeControlled: boolean): void

Inherited from YogaWidget.setFlexNodeSizeControlled

sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged).

Parameters:

NameTypeDescription
isSizeControlledboolean

Returns: void


setFocus

â–¸ setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

NameType
reasonFocusReason

Returns: void


setFont

â–¸ setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

NameType
fontQFont

Returns: void


setGeometry

â–¸ setGeometry(x: number, y: number, w: number, h: number): void

Inherited from QMenu.setGeometry

Parameters:

NameType
xnumber
ynumber
wnumber
hnumber

Returns: void


setGraphicsEffect

▸ setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Inherited from QMenu.setGraphicsEffect

Parameters:

NameType
effectQGraphicsEffect‹any›

Returns: void


setIconSize

â–¸ setIconSize(size: QSize): void

Parameters:

NameType
sizeQSize

Returns: void


setInlineStyle

â–¸ setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

NameType
stylestring

Returns: void


setLayout

▸ setLayout(parentLayout: NodeLayout‹QTabBarSignals›): void

Inherited from QMenu.setLayout

Parameters:

NameType
parentLayoutNodeLayout‹QTabBarSignals›

Returns: void


setMaximumSize

â–¸ setMaximumSize(maxw: number, maxh: number): void

Inherited from QMenu.setMaximumSize

Parameters:

NameType
maxwnumber
maxhnumber

Returns: void


setMinimumSize

â–¸ setMinimumSize(minw: number, minh: number): void

Inherited from QMenu.setMinimumSize

Parameters:

NameType
minwnumber
minhnumber

Returns: void


setMouseTracking

â–¸ setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

NameType
isMouseTrackedboolean

Returns: void


setMovable

â–¸ setMovable(movable: boolean): void

Parameters:

NameType
movableboolean

Returns: void


setNodeParent

â–¸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

â–¸ setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setProperty

â–¸ setProperty(name: string, value: QVariantType): boolean

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setSelectionBehaviorOnRemove

â–¸ setSelectionBehaviorOnRemove(behavior: SelectionBehavior): void

Parameters:

NameType
behaviorSelectionBehavior

Returns: void


setShape

â–¸ setShape(shape: TabBarShape): void

Parameters:

NameType
shapeTabBarShape

Returns: void


setStyleSheet

â–¸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

NameType
styleSheetstring

Returns: void


setTabButton

▸ setTabButton(index: number, position: ButtonPosition, widget: NodeWidget‹any›): void

Parameters:

NameType
indexnumber
positionButtonPosition
widgetNodeWidget‹any›

Returns: void


setTabData

â–¸ setTabData(index: number, data: QVariant): void

Parameters:

NameType
indexnumber
dataQVariant

Returns: void


setTabEnabled

â–¸ setTabEnabled(index: number, enabled: boolean): void

Parameters:

NameType
indexnumber
enabledboolean

Returns: void


setTabIcon

â–¸ setTabIcon(index: number, icon: QIcon): void

Parameters:

NameType
indexnumber
iconQIcon

Returns: void


setTabText

â–¸ setTabText(index: number, text: string): void

Parameters:

NameType
indexnumber
textstring

Returns: void


setTabTextColor

â–¸ setTabTextColor(index: number, color: QColor): void

Parameters:

NameType
indexnumber
colorQColor

Returns: void


setTabToolTip

â–¸ setTabToolTip(index: number, tip: string): void

Parameters:

NameType
indexnumber
tipstring

Returns: void


setTabWhatsThis

â–¸ setTabWhatsThis(index: number, text: string): void

Parameters:

NameType
indexnumber
textstring

Returns: void


setTabsClosable

â–¸ setTabsClosable(closeable: boolean): void

Parameters:

NameType
closeableboolean

Returns: void


setUsesScrollButtons

â–¸ setUsesScrollButtons(useButtons: boolean): void

Parameters:

NameType
useButtonsboolean

Returns: void


setWindowFlag

â–¸ setWindowFlag(windowType: WindowType, switchOn: boolean): void

Inherited from QMenu.setWindowFlag

Parameters:

NameType
windowTypeWindowType
switchOnboolean

Returns: void


setWindowIcon

â–¸ setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

NameType
iconQIcon

Returns: void


setWindowOpacity

â–¸ setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

NameType
opacitynumber

Returns: void


setWindowState

â–¸ setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

NameType
stateWindowState

Returns: void


setWindowTitle

â–¸ setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

NameType
titlestring

Returns: void


shape

â–¸ shape(): TabBarShape

Returns: TabBarShape


show

â–¸ show(): void

Inherited from QMenu.show

Returns: void


showFullScreen

â–¸ showFullScreen(): void

Inherited from QMenu.showFullScreen

Returns: void


showMaximized

â–¸ showMaximized(): void

Inherited from QMenu.showMaximized

Returns: void


showMinimized

â–¸ showMinimized(): void

Inherited from QMenu.showMinimized

Returns: void


showNormal

â–¸ showNormal(): void

Inherited from QMenu.showNormal

Returns: void


size

â–¸ size(): QSize

Inherited from QMenu.size

Returns: QSize


styleSheet

â–¸ styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string


tabAt

â–¸ tabAt(position: QPoint): number

Parameters:

NameType
positionQPoint

Returns: number


tabData

â–¸ tabData(index: number): QVariant

Parameters:

NameType
indexnumber

Returns: QVariant


tabIcon

â–¸ tabIcon(index: number): QIcon

Parameters:

NameType
indexnumber

Returns: QIcon


tabRect

â–¸ tabRect(index: number): QRect

Parameters:

NameType
indexnumber

Returns: QRect


tabText

â–¸ tabText(index: number): string

Parameters:

NameType
indexnumber

Returns: string


tabTextColor

â–¸ tabTextColor(index: number): QColor

Parameters:

NameType
indexnumber

Returns: QColor


tabToolTip

â–¸ tabToolTip(index: number): string

Parameters:

NameType
indexnumber

Returns: string


tabWhatsThis

â–¸ tabWhatsThis(index: number): string

Parameters:

NameType
indexnumber

Returns: string


tabsClosable

â–¸ tabsClosable(): boolean

Returns: boolean


testAttribute

â–¸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

NameType
attributeWidgetAttribute

Returns: boolean


update

â–¸ update(): void

Inherited from QMenu.update

Returns: void


updateGeometry

â–¸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void


usesScrollButtons

â–¸ usesScrollButtons(): boolean

Returns: boolean


windowOpacity

â–¸ windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number


windowState

â–¸ windowState(): number

Inherited from QMenu.windowState

Returns: number


windowTitle

â–¸ windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string